Skip to content

Commit 795da95

Browse files
author
John Fitzgerald
committed
Update API doc
1 parent ee68658 commit 795da95

File tree

1 file changed

+8
-1
lines changed

1 file changed

+8
-1
lines changed

docs/free/rest.rst

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,14 @@ An OpenSky user is anybody who uses a valid OpenSky account or corresponding API
5353
* OpenSky users get 4000 API credits per day. This is also true for the default privileges when using the API client. For higher request loads please contact OpenSky.
5454
* Active contributing OpenSky users get a total of 8000 API credits per day. An active user is a user which has an ADS-B receiver that is at least 30% online (measured over the current month).
5555

56-
.. note:: You can retrieve all state vectors received by your receivers without any restrictions. See :ref:`own-states`. Before the request limit is reached the header `X-Rate-Limit-Remaining` indicates the amount of remaining credits. After the rate limit is reached the status code `429 - Too Many Requests` is returned and the header `X-Rate-Limit-Retry-After-Seconds` indicates how many seconds until credits/request become available again.
56+
.. note:: If you are feeding and using the API client it will take 50+ requests before your credit allowance is increased to 8000. This new credit allowance is dynamic and not tied to any role so you will still see the default role with 4000 credits in the API client info. To verirfy you are getting 8000 credits inspect the x-rate-limit-remaining response header. If at times like the start of the day it is greater than 4000 then you will be in the 8000 credit bucket.
57+
58+
.. note::
59+
You can retrieve all state vectors received by your receivers without any restrictions. See :ref:`own-states`. Before the request limit is reached the header `X-Rate-Limit-Remaining` indicates the amount of remaining credits. After the rate limit is reached the status code `429 - Too Many Requests` is returned and the header `X-Rate-Limit-Retry-After-Seconds` indicates how many seconds until credits/request become available again.
60+
61+
This is currently not working for the API client and is in the process of being fixed.
62+
63+
5764

5865
OAuth2 Client Credentials Flow
5966
"""""""""""""""""""""""""""""""

0 commit comments

Comments
 (0)