Partner API
API Specification
URLs and Authentication

URLs and Authentication


The current version of the NearSt Partner API is available from the following base URL:

All API endpoints return JSON responses. POST and PUT requests expect JSON request payloads.


The API uses Bearer Authorization to authenticate you using your Partner API key. This key can be found in the Partner Dashboard (opens in a new tab) under the ‘Developer’ tab, or requested from your NearSt partnerships manager.

Supply it using the Authorization header with every request:

Authorization: Bearer {PartnerApiKey}