Skip to content

Commit f5be076

Browse files
Update README.md with new error status code
1 parent 20fdca1 commit f5be076

File tree

1 file changed

+6
-3
lines changed

1 file changed

+6
-3
lines changed

docs/README.md

+6-3
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ For those building their own implementation, here are some key things to keep in
2525
- Querystring parameters must be URL encoded. All languages should have a function to do this.
2626
- Requests to Observations/Records that you expect a large amount (>1M rows) of data from should be partitioned. We recommend by Monitoring locations and/or activity start year. There is a technical database reason for this that you're welcome to ask us about.
2727
- Each request partition should be paginated over using the `Link` header or `@odata.nextLink` within the body of the response.
28-
- Rate limit yourself (2/sec) and don't make requests in parallel. This will ensure you don't get `403 Unauthorized` responses.
28+
- Rate limit yourself (2 reqs/sec) and don't make requests in parallel. This will ensure you don't get `429 Too Many Requests` error response.
2929
- Use HTTP/3
3030

3131
## Endpoints
@@ -179,11 +179,14 @@ curl -G -H 'x-api-key: PRIVATE-API-KEY' \
179179
```
180180

181181
## Errors
182+
### 408 or 504 Timeout
183+
This means your request was too complicated and was unable to complete within 30sec. Lowering `$top` and/or adding in narrower filtering should resolve this issue.
184+
182185
### 413 Payload Too Large
183186
This means your request result was too large. Lowering `$top` or only requesting the values you need should resolve this issue.
184187

185-
### 408 or 504 Timeout
186-
This means your request was too complicated and was unable to complete within 30sec. Lowering `$top` and/or adding in narrower filtering should resolve this issue.
188+
### 429 Too Many Requests
189+
This status code indicates that the client has sent too many requests in a given amount of time. To resolve this issue, rate limit yourself (2 reqs/sec) and don't make requests in parallel.
187190

188191
## Disclaimer
189192
We are currently in a Beta, changes will happen. We will do our best effort to keep you informed of any breaking changes.

0 commit comments

Comments
 (0)