SmartScout API

OVERVIEW

The SmartScout API is a REST-style API that accepts and returns JSON.

AUTHENTICATION

The SmartScout API uses API keys to authenticate requests. The API keys must be passed into the X-Api-Key header and must be present in all API requests.

Contact SmartScout support to ask for your API key.

MARKETPLACE QUERY STRING PARAMETER

Aside from the API Keys, all requests must also contain a marketplace query string parameter. Supported values are US, UK, IT, DE, CA, MX, FR, and ES.

PAGINATION

Endpoints are paginated and use a cursor pagination approach. This means that if the response is not able to bring back all the items, you will get a nextPageId which is a pointer to the next set of data. You can then set this value as page[id] query string parameter to your next request to retrieve the next set of data. There is also a hasMoreRecords property in the response that indicates if there are more items. If this is set to true, nextPageId will have a value.

These endpoints have built-in limits to the amount of data returned. But you can also specify the page[size] query string parameter to limit the items to your desired numbers. But take note that if the page[size] parameter is more than the built-in limit, it will be ignored.

SORTING

Endpoints provide sorting capability by passing a sort[by] query string parameter with the name of the field. You can also set the sort order by passing in a sort[order] query string parameter with asc for ascending order and desc for descending order.

For the available field names, check the response schema definitions from this link. https://api.smartscout.com/index.html

FILTERING

Search endpoints give you the ability to provide search filters. Filters can be simple text, number, boolean, or date. But some filters provide you with the flexibility to specify different matching rules. Most text fields support the following rules: startsWith, contains, notContains, endsWith, equals, notEquals, blanks. Number fields, on the other hand, provide you with an option to set the min and/or max values.

For the available filter parameters, check the request schema definitions from this link. https://api.smartscout.com/index.html

Here are some examples:

SCHEMA AND ENDPOINTS

The link below contains a list of endpoints and their corresponding request and response schema.
https://api.smartscout.com/index.html

In general, the returned JSON response will have the following schema.

{
  data: [...],
   paging: {
         nextPageId: string,
         hasMoreRecords: boolean
   }
}