Getting started
Authentication
Services
- Dataset service
- Batches and BatchRuns
- Combining entities in one request
- Latest data URL
- Stream URL
- Batchrun URL
- Archive URL
- Timeseries URL
Request parameters
- Parameters
- Parameter: after
- Parameter: aggregate
- Parameter: apikey
- Parameter: dateFormat
- Parameter: descending
- Parameter: envelope
- Parameter: format
- Parameter: from
- Parameter: groupBy
- Parameter: groupById
- Parameter: inline
- Parameter: limit
- Parameter: Lookup Fields
- Parameter: modulus
- Parameter: nextUrl
- Parameter: part
- Parameter: rangeField
- Parameter: requestTimeout
- Parameter: showMessage
- Parameter: sortBy
- Parameter: to
- Parameter: verifyLinks
Reference
Samples
Parameter: apikey
An API key is required as part of every API request. The recommended method is to pass this information in an Authorization header, in the form:
Authorization: Bearer <apikey>
For backwards-compatibility purposes, it remains possible to pass the API key to the Consumer API server with an apikey query parameter, but this approach is discouraged on security grounds and is deprecated.
Note: The legacy
apikeyquery parameter is only supported forformat=JSON,format=XMLandformat=CSVrequests.
notificationsFor questions or assistance, please contact: data.delivery@spglobal.com