Salient’s Application Programming Interface (API) exposes certain functionality and data through API endpoint requests and responses. A software development kit (SDK) is also available to support commonly used functions.
API Documentation is available:
API calls can be authenticated either with username/password using HTTP Basic Authentication or with an apikey parameter. With either method, the API can generate a client-side cookie that maintains a login session, so that authentication need not be supplied with subsequent requests.
Multiple authenticated requests can be sent using, for example, a stored cookie file with curl or a Python requests.session instance, while any web browser will maintain a login session automatically.
Requests can also be authenticated on an individual basis by simply supplying the API key as an additional query parameter with each request, e.g. apikey={key}.
The base URL to send all API requests is https://api.salientpredictions.com. HTTPS is required for all API requests.
Your account may have limited access permissions depending on whether you are a trial user or your account’s license agreement. If you receive a permission error that you think is incorrect, please contact our support team at [email protected].
The rate limit for incoming API requests is 250 calls per minute and 5,000 calls per day.
<aside> ❗ Rate limits may change
In the future, we may adjust rate limits to balance for demand and reliability. We may also introduce different rate limits for pricing tiers.
</aside>
Different API calls allow users to extra either temporal records at chosen locations, or spatial slices for a single time period or forecast lead. The underlying forecasts are stored in gridded NetCDF files, which can be downloaded directly for access to the entire dataset.
| Format | Dataset |
|---|---|
| NetCDF | All |
| csv | All |
| PNG | Core and Historical only |