Welcome to the Street Open API
Street Open API Beta Phase
This is the documentation for the inital phase of the Street Open API. Whilst we will make every effort not to make breaking changes during this beta period, please be aware that this may occur.
Introduction
The Street.co.uk Open API is a RESTful API designed to allow agents or suppliers to build on top of Street’s functionality. The API is open and free of charge, available to any user or supplier to use.
Our API has predictable resource-oriented URLs, accepts JSON request bodies, returns JSON-encoded responses, and uses standard HTTP response codes, authentication, and verbs.
Our API adheres to the JSON
Authentication
The Street API uses bearer tokens for authentication. You can view and generate tokens in the settings panel in your Street account under Settings > Account Administration > Applications
All API requests should include your API token in an Authorization HTTP header as follows:
Authorization: Bearer YOUR_API_TOKEN_HERE
Live & Testing Environments
It is not recommended to develop an integration using a production API token for a live account. Instead, if you would like a sandbox account on our staging environment, please email apis@street.co.uk to request a token.
Developer Support
To be able to support you effectively we are using a support ticketing system. If you have any questions or requests please feel to submit a ticket.
Updates
Going forward a brief summary of any updates to the API can be found on the dedicated updates page.
Rate Limiting
Requests to the Street Open API are rate limited as follows:
GET requests: up to 600 calls per minute.
POST, PUT, PATCH, and DELETE requests: up to 100 calls per minute.
If you require this limit raising, please contact our API team at apis@street.co.uk.