Polling
FREE
By 3taps
Updated 3 months ago

Polling API Documentation

The 3taps Polling API makes it possible for external systems to "poll" the Data Commons server to obtain a list of new and updated postings as they come in.

Learn more about this API
GETDeletes
GETPoll
GETAnchor
GETPoll

The poll API call retrieves a set of new postings from the database.

Authorization:

The authentication token used to ensure that you are authorized to make this API call.

Header Parameters
X-RapidAPI-HostSTRING
REQUIRED
X-RapidAPI-KeySTRING
REQUIRED
Required Parameters
statusSTRING
REQUIREDOnly include postings with the given status value. The following status values are currently supported: offered, wanted, lost, stolen, found, deleted
auth_tokenQUERY
REQUIREDThe authentication token used to ensure that you are authorized to make this API call.
Optional Parameters
categorySTRING
OPTIONALThe desired 3taps category code. If this is supplied, only postings with the given category will be included in the polling results.
regionSTRING
OPTIONALThe desired 3taps region code. If this is supplied, only postings in the given region will be included in the polling results.
metroSTRING
OPTIONALThe desired 3taps metro area code. If this is supplied, only postings in the given metro area will be included in the polling results.
zipcodeSTRING
OPTIONALThe desired 3taps ZIP code. If this is supplied, only postings in the given ZIP code will be included in the polling results.
category_groupSTRING
OPTIONALThe desired 3taps category group code. If this is supplied, only postings with the given category group will be included in the polling results.
countrySTRING
OPTIONALThe desired 3taps country code. If this is supplied, only postings in the given country will be included in the polling results.
countySTRING
OPTIONALThe desired 3taps county code. If this is supplied, only postings in the given county will be included in the polling results.
citySTRING
OPTIONALThe desired 3taps city code. If this is supplied, only postings in the given city will be included in the polling results.
localitySTRING
OPTIONALThe desired 3taps locality code. If this is supplied, only postings in the given locality will be included in the polling results.
anchorSTRING
OPTIONALThe anchor value to use for this polling request. Note that this parameter is optional -- if no anchor is supplied, the API call will return an empty list of postings, along with a new anchor value that can be used to retrieve new postings that have come in since the last time this API call was made. This has the effect of polling "from now on".
sourceSTRING
OPTIONALThe desired 3taps data source code. If this is supplied, only postings from the given data source will be included in the polling results.
stateSTRING
OPTIONALThe desired 3taps state code. If this is supplied, only postings in the given state will be included in the polling results.
retvalsSTRING
OPTIONALA string listing the fields which should be returned back to the caller. The various fields should be separated by commas. At present, the following fields can be included in this parameter: id, account_id, source, category, category_group, location, external_id, external_url, heading, body, html, timestamp, expires, language, price, currency, images, annotations, status, immortal. If no retvals parameter is provided, the following default will be used: id source, category, location, external_id, external_url, heading, timestamp
Code Snippet
Install SDK
Response ExampleSchema

Install SDK for (Node.js)Unirest

OAuth2 Authentication
Client ID
Client Secret
OAuth2 Authentication