Quickstart
Get started with Nomos and integrate our API into your product.
Base URL
The Nomos API is built on REST principles. We enforce HTTPS in every request to improve data security, integrity, and privacy. The API does not support HTTP.
All requests contain the following base URL:
Authentication
To authenticate you need to add an Authorization header with the contents of the header being
Bearer nom_123456789 where nom_123456789 is your API Key.
Response codes
Nomos uses standard HTTP codes to indicate the success or failure of your requests.
In general, 2xx HTTP codes correspond to success, 4xx codes are for user-related failures,
and 5xx codes are for infrastructure issues.
| Status | Description |
|---|---|
200 | Successful request. |
4xx | Client error, see Error Codes. |
5xx | Indicates an error with Nomos servers. |
Rate limit
The response headers describe your current rate limit following every request in conformance with the IETF standard:
Header name | Description |
|---|---|
ratelimit-limit | Maximum number of requests allowed within a window. |
ratelimit-remaining | How many requests you have left within the current window. |
ratelimit-reset | How many seconds until the limits are reset. |
retry-after | How many seconds you should wait before making a follow-up request. |
The maximum number of requests that users can send is 10 requests per second.
After that, you’ll hit the rate limit and receive a 429 response error code.
To prevent this, we recommend reducing the rate at which you request the API. This can be done by introducing a queue mechanism or reducing the number of concurrent requests per second. If you have specific requirements, contact support to request a rate increase.
Support
If you have any questions or need help, please contact us at support@nomos.energy