Firstly, you need an account with us. Any existing Spark accounts within your organisation can be used or you can also create a new account set up as a developer (which doesn't count towards number of nominated Spark Premium accounts).
For Premium plan users:
Navigate to “Contract” > “Data integrations” > “Spark API” on the sidebar menu and follow the steps in this page to access our API.
For Basic plan users: Click on the download button and select “Download with our API”. Follow the steps in this page to access our API.
All Spark users have basic access which means that you can access the SparkS price for free but with a limited dataset.
To access the SparkF, SparkFo, historical data and wider data sets, users must have premium access which applies on an organisation level. Please get in touch if you'd like more detailed information.
Rate limiting of the API is primarily on per-customer basis — or more accurately described, per user access token. Following limits are currently the default setting:
- Throttling (requests per second): 50 req/sec
- Burst (bucket size): 200
- Quota (requests per day): 1000 req/day
You can request an increase of these limits. Please contact us directly via firstname.lastname@example.org and describe your scenario.