get https://api.datafiniti.co/v3/data/properties
The data
endpoint lets you run preview searches and initiate downloads for property data.
Returns
If you set download=false
(or don't set it), the data/properties
API call will return a list of matching properties for your query.
- If you don't set
records
whendownload=false
, it will return up to 10 properties. - You can set
records
to a value between 0 and 10 to return up to that many properties.
If you set download=true
, it will return a request
object that can be used to monitor the status of the download request.
- If you don't set
records
whendownload=true
, it will initiate a download request for all matching businesses. - You can set
records
to a value between 1 and the number of matching businesses.
Response Codes and Messages
Response Code | Error Message | What You Should Do |
---|---|---|
200 | N/A | Everything worked! You should check out the awesome data you just requested. |
400 | field name does not exist in property schema | Make sure you're using the correct name for a field. Consult the business data schema for available fields. |
400 | invalid query | Your query syntax has a mistake somewhere. Check what you're setting for q for any mistakes. |
400 | view does not exist | Make sure you're using the correct value for view . See a list of available views. |
401 | N/A | You're using an invalid API token. Check out your account page on the Datafiniti Portal to make sure you have the right token. |