API token's in Street

It's important to understand that Street has two API feeds; The Property Feed API and The Public API. Both have different use cases and it's worth noting that the public API feed will give third party developers access to client data within your account if you pass an API token onto them. With that in mind, if you are unsure of which feed you need to generate an API token for, please contact the live chat team, outlining your use case so they can advise which one is relevant.

To get started, head to Settings (on the left side panel at the bottom) > Account Administration > Applications:

Here you will see a list of any existing API tokens you have created. To setup a new token, scroll down to the 'create new application' section:

Here you can add an application name. This should be something that is easily identifiable, typically the name of the software the token is being generated for.

In the the 'API token scope' drop-down you should select the relevant token for the integration you are building. If you are building an API token for an external software, you should use the 'open API' token.

Finally, add a contact name and email address of who will be building the application. It is really important you enter the developer's details as opposed to your own details (unless you are the developer) so we can notify them of any changes to the API that might impact your set up.

Once you've entered all of the information, click the 'create application' button and you will see an API access token appear (this will show as a string of code).

Click the 'click to copy' button which will copy this API access token to your clipboard. You can then paste and share this token as needed, possibly via email to the developer or directly into the software you are building the integration for.

Should you need to delete an API token, head to the applications setting and click the bin icon next the token to delete. Deleting an API token will result in any queries using that token failing.

If you need to refresh an API token you can click the circle arrow icon next to the token. Refreshing an API token will generate a completely new token and the existing access token for that application will no longer be valid. Please ensure the application is not currently in use before proceeding.

If you need any support in using our API, please refer to our API documentation here: https://developers.street.co.uk/

You can also contact our API support team directly below!