Skip to content

Commit d9d07e5

Browse files
committed
global: update rate-limits and search/OAI-PMH page size
1 parent ecfa228 commit d9d07e5

4 files changed

Lines changed: 9 additions & 4 deletions

File tree

source/includes/oai-pmh/_root.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ info.earliestDatestamp
4646

4747
## Resumption tokens
4848

49-
Resumption tokens are only valid for **2 minutes**. In case a token expired, you will receive a ``422 Unprocessable Entity`` HTTP error.
49+
The OAI-PMH API returns **50 records per page**. Resumption tokens are only valid for **2 minutes**. In case a token expired, you will receive a ``422 Unprocessable Entity`` HTTP error.
5050

5151
<aside class="notice">
5252
This means that you must execute the next HTTP request using the

source/includes/rate-limit/_root.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,8 @@ To achieve this, we have rate-limiting measures in place which limit the number
77
|:------------------|:------------------------------------------------------------------------------|
88
| Global limit for guest users | 60 requests per minute, 2000 requests per hour |
99
| Global limit for [authenticated users](#authentication) | 100 requests per minute, 5000 requests per hour |
10-
| OAI-PMH API harvesting | 120 requests per minute |
10+
| Search REST API endpoints | 30 requests per minute |
11+
| OAI-PMH API harvesting | 30 requests per minute |
1112
| Thumbnails for image records | 20 requests per minute |
1213

1314
When you are making requests to any of our endpoints, you can inspect the following HTTP response headers for more information of your current rate-limit status:

source/includes/resources/deposit/_list.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ curl -i -H "Authorization: Bearer ACCESS_TOKEN" /api/deposit/depositions/
2626
| `status`</br>_string_ | optional | Filter result based on deposit status (either ``draft`` or ``published``) |
2727
| `sort`</br>_string_ | optional | Sort order (``bestmatch`` or ``mostrecent``). Prefix with minus to change form ascending to descending (e.g. ``-mostrecent``). |
2828
| `page`</br>_integer_ | optional | Page number for pagination. |
29-
| `size`</br>_integer_ | optional | Number of results to return per page. |
29+
| `size`</br>_integer_ | optional | Number of results to return per page. Maximum 100. |
3030
| `all_versions`</br>_integer/string_ | optional | Show (`true` or `1`) or hide (`false` or `0`) all versions of deposits. |
3131

3232
#### Success Response

source/includes/resources/records/_list.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ curl -i -H "Authorization: Bearer ACCESS_TOKEN" /api/records/
2626
| `status`</br>_string_ | optional | Filter result based on the deposit status (either ``draft`` or ``published``) |
2727
| `sort`</br>_string_ | optional | Sort order (``bestmatch`` or ``mostrecent``). Prefix with minus to change form ascending to descending (e.g. ``-mostrecent``). |
2828
| `page`</br>_integer_ | optional | Page number for pagination. |
29-
| `size`</br>_integer_ | optional | Number of results to return per page. |
29+
| `size`</br>_integer_ | optional | Number of results to return per page. Maximum 25 for anonymous requests, 100 for authenticated requests. |
3030
| `all_versions`</br>_integer/string_ | optional | Show (`true` or `1`) or hide (`false` or `0`) all versions of records. |
3131
| `communities`</br> _string_ | optional | Return records that are part of the specified communities. (Use of `community identifier`) |
3232
| `type`</br> _string_ | optional | Return records of the specified type. (`Publication`, `Poster`, `Presentation`...) |
@@ -61,3 +61,7 @@ See [HTTP status codes](#http-status-codes) (400 and 500 series errors) and
6161
#### Search guide
6262

6363
Advanced search queries can as well be performed on Zenodo website through the search box. This is documented in the [search guide](https://help.zenodo.org/guides/search/)
64+
65+
<aside class="notice">
66+
<strong>For bulk data access:</strong> If you need to download or process large numbers of records, we recommend using <a href="#oai-pmh">OAI-PMH harvesting</a> or <a href="#metadata-dumps">metadata dumps</a> instead of the search API. These methods are specifically designed for bulk access and will be more efficient for your use case.
67+
</aside>

0 commit comments

Comments
 (0)