Open Data API Reference
This section provides a complete reference guide to all the Open Data API endpoints.
Global Headers
The following headers are supported on all requests or provided in all responses.
Request Headers
Accept-Language | The language that labels will be returned in (setting this is equivalent to changing the dataset and user interface language in SuperWEB2). | Optional. If not set, the server default language will be used. |
|---|---|---|
APIKey | The API Key to use to authenticate this request. You can obtain your API key from the Account page in SuperWEB2. | Required in all requests. |
Response Headers
X-RateLimit X-RateLimit-Schema X-RateLimit-Table | The global, schema, and table rate limits (if configured). The individual headers are only returned if the corresponding rate limit has been set. If none of these headers are returned then that indicates that no rate limiting applies. |
|---|---|
X-RateLimit-Remaining X-RateLimit-Remaining-Schema X-RateLimit-Remaining-Table | The number of requests remaining for the current rate limiting period. If this value drops to 0 then you will not be able to submit any further requests using this API key until the limit resets. The individual headers are only returned if the corresponding rate limit has been set. If none of these headers are returned then that indicates that no rate limiting applies. |
X-RateLimit-Reset X-RateLimit-Reset-Schema X-RateLimit-Reset-Table | The time when the rate limit will next be reset. This is expressed as a UNIX timestamp in milliseconds (milliseconds since January 1st 1970). The individual headers are only returned if the corresponding rate limit has been set. If none of these headers are returned then that indicates that no rate limiting applies. |
REST Endpoints
The Open Data API is a JSON REST API. It has 5 root REST endpoints:
/schema | Provides information about all the SuperSTAR datasets that are available to you, and their fields and measures. | Learn More |
|---|---|---|
/table | Allows you to submit queries and receive the results (equivalent to creating a table in SuperWEB2). | Learn More |
/info | Provides general information about the SuperWEB2 instance you are connecting to. At present, this endpoint provides information about the dataset languages currently configured in SuperWEB2. | Learn More |
/rate_limit | Access to the API is subject to rate limits. This endpoint provides information about the limit that applies to you, how many requests you have remaining, and the length of time before the rate limit will be reset. Limits can be set for both the | Learn More |
/cache | Allows you to manually clear the cache. | Learn More |
Cross Origin Resource Sharing (CORS)
The Open Data API supports the CORS standard so that scripts accessing the API can be hosted on a different server to the one hosting the Open Data API.
