Getting started with our APIs
Explore Valocity’s data products, obtaining API access, and integrating into your systems.
Here's your guide to integrating with Valocity's APIs — from getting your key to testing and going live.
Explore, test and request for access.
- Browse our data products and try out their included APIs via the inbuilt Try now feature or via our Postman workspace.
- Contact us to request access. Let us know which products or APIs you're interested in, and we'll review your request and provide you with an API key for testing and integration.
- Use your API key to begin testing and integrating with your product/service. See the sections below for environment details and set up your API key in requests.
Setting up your API key
Production base URL
Environment details and base URLs are provided on each individual product page.
https://api.valocityglobal.io/au/property
Our Redoc documentation site uses the UAT environment, which is served from
https://api-uat.valocityglobal.io
.
Authentication method
We use standard header-based authentication. For each API call, include the following headers:
x-api-key: YOUR_API_KEY
x-api-version: 1.0
Sample CURL request
curl -X GET 'https://api.valocityglobal.io/au/property/property/search?query=71 amy st' -H 'x-api-key: YOUR_API_KEY' -H 'x-api-version: 1'
Going live
When you're ready to launch your integration, our onboarding team is here to support you. Before going live, we'll schedule a quick go-live review to ensure everything is in place and address any final questions or feedback.
Should you encounter any technical issues, please contact us with a description of the issue and include relevant screenshots where possible.