Skip to content

Commit 545d0ff

Browse files
bgravenorstalexandratran
bgravenorst
and
alexandratran
authored
Halt api (#1749)
* Make file global. Signed-off-by: bgravenorst <[email protected]> * Halt API requests. Signed-off-by: bgravenorst <[email protected]> * Add what's new. Signed-off-by: bgravenorst <[email protected]> * Add JSON error codes. Signed-off-by: bgravenorst <[email protected]> * Additional clarification. Signed-off-by: bgravenorst <[email protected]> * Typo Signed-off-by: bgravenorst <[email protected]> * Update services/reference/_partials/error-codes.mdx Co-authored-by: Alexandra Carrillo <[email protected]> * Update services/reference/_partials/error-codes.mdx Co-authored-by: Alexandra Carrillo <[email protected]> * Update services/reference/_partials/error-codes.mdx Co-authored-by: Alexandra Carrillo <[email protected]> * Apply suggestions from code review --------- Signed-off-by: bgravenorst <[email protected]> Co-authored-by: Alexandra Carrillo <[email protected]>
1 parent 8a8cb37 commit 545d0ff

File tree

7 files changed

+201
-331
lines changed

7 files changed

+201
-331
lines changed

‎developer-tools/dashboard/how-to/secure-an-api/set-rate-limits.md

+16
Original file line numberDiff line numberDiff line change
@@ -26,3 +26,19 @@ Set rate limiting in the API key's **Settings** tab **Key Credit Limits** sectio
2626
credits per day in integers, for example, 20000. The value `0` means default limits are applied.
2727

2828
When the number of used credits reach this limit, all requests will be rejected until the next day (00:00 UTC).
29+
30+
If you exceed the specified limits, you'll receive a JSON response with an
31+
[HTTP error status code `429`](/services/reference/ethereum/json-rpc-methods#http-errors). For example:
32+
33+
```json
34+
{
35+
"jsonrpc": "2.0",
36+
"id": 1,
37+
"error": {
38+
"code": 429,
39+
"event": -33300,
40+
"message": "Too Many Requests",
41+
"details": "You have surpassed your user-defined key throughput limit setting. To make more requests with this key, review key setting configurations."
42+
}
43+
}
44+
```

‎docs/whats-new.md

+1
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,7 @@ of the [MetaMask developer page](https://metamask.io/developer/).
1616

1717
## November 2024
1818

19+
- Documented [updated error responses](/services/reference/ethereum/json-rpc-methods) when rate-limiting Infura JSON-RPC API calls. ([#1749](https://github.com/MetaMask/metamask-docs/pull/1749))
1920
- Documented [Unichain Sepolia](/services/reference/unichain) support. ([#1725](https://github.com/MetaMask/metamask-docs/pull/1725))
2021
- Updated Snaps [Custom UI documentation](/snaps/features/custom-ui/) for MetaMask Extension version 12.6.
2122
([#1715](https://github.com/MetaMask/metamask-docs/pull/1715))

‎services/get-started/pricing/credit-cost.md

+2-6
Original file line numberDiff line numberDiff line change
@@ -29,13 +29,9 @@ The process used to determine the credit cost for each request is as follows:
2929

3030
When making requests that return status code errors, some errors count towards your credit usage.
3131

32-
- **`429` errors**: These are not charged and can occur for the following reasons:
33-
- **Key settings credit limit caps**: These are limits set per API key.
34-
- **Credit quota limit caps**: These are overall credit usage limits.
35-
- **Credit throughput limit caps**: These are limits on the rate or throughput of requests.
36-
32+
- **`429` errors**: These are not charged and can occur if you've exceeded your allowed throughput limit (requests per second).
33+
- **`402` errors**: These are not charged and can occur if you've exceeded your allowed daily credit usage.
3734
- **`4xx` errors**: These are errors caused by human input, and consume 5 credits.
38-
3935
- **`5xx` errors**: These are server errors, and do not consume any credit charges.
4036

4137
## Ethereum

‎services/how-to/avoid-rate-limiting.md

+20-34
Original file line numberDiff line numberDiff line change
@@ -6,35 +6,38 @@ sidebar_position: 1
66
# Avoid rate limiting
77

88
Infura applies rate limiting account-wide after exceeding the [daily credit limit](../get-started/pricing/index.md)
9-
or the number of credits per second (throughput).
9+
or the number of credits per second (throughput). The rate limiting also applies to
10+
[user-defined limits that you can configure in the dashboard](/developer-tools/dashboard/how-to/secure-an-api/set-rate-limits).
1011

11-
For rate limiting designed to protect our service in the event of an attack, Infura uses a combination of:
12-
- Source IP address.
13-
- JSON-RPC method.
14-
- API key.
12+
When you exceed your daily credit limit, Infura stops accepting further traffic and removes
13+
access for the rest of the day, halting further usage. You'll need to upgrade your plan, or purchase
14+
additional credit packs for more capacity.
1515

16-
The throughput of an account will be throttled once the daily credit limit is reached. Credit
17-
quota limits will be reset everyday at 00:00 UTC for all customers.
16+
If you've exceeded your allowed throughput limit, consider reducing the amount of requests per
17+
second, or upgrade for more capacity.
18+
19+
Credit quota limits are reset everyday at 00:00 UTC for all customers.
1820

1921
## Rate limit implications
2022

2123
Daily credit quota limits apply after reaching your daily credit allowance:
2224

23-
- Once you reach your daily request limit, you can still make further requests, but throughput
24-
will be throttled.
25+
- Once you reach your daily request limit, your service will be halted for the rest of the day.
2526
- The WebSocket service will sever connections.
2627

2728
### Notice rate limiting behavior?
2829

29-
You'll receive a JSON response with an HTTP status code `429` if you reach your credits per second limits:
30+
You'll receive a JSON response with an HTTP status code `402` if you reach your daily credit limit. For example:
3031

3132
```json
3233
{
3334
"jsonrpc": "2.0",
3435
"id": 1,
3536
"error": {
36-
"code": -32005,
37-
"message": "daily request count exceeded, request rate limited"
37+
"code": 402,
38+
"event": -33000,
39+
"message": "Payment Required",
40+
"details": "You have reached your daily credit limit. To continue making requests, upgrade your plan or purchase additional credits"
3841
}
3942
}
4043
```
@@ -47,34 +50,17 @@ allowed limit:
4750
"jsonrpc": "2.0",
4851
"id": 1,
4952
"error": {
50-
"code": -32005,
51-
"message": "project ID request rate exceeded",
52-
"data": {
53-
"see": "https://infura.io/docs/ethereum/jsonrpc/ratelimits",
54-
"current_rps": 13.333,
55-
"allowed_rps": 10.0,
56-
"backoff_seconds": 30.0
57-
}
53+
"code": 429,
54+
"event": -33200,
55+
"message": "Too Many Requests",
56+
"details": "You have surpassed your allowed throughput limit. Reduce the amount of requests per second or upgrade for more capacity."
5857
}
5958
}
6059
```
6160

62-
The `data` array contains three fields related to rate limits:
63-
64-
- `current_rps` - The current rate per second determined by Infura.
65-
- `allowed_rps` - The current _allowed_ rate which you should stay under.
66-
- `backoff_seconds` - The suggested amount of time to wait before sending more requests.
67-
68-
:::info
69-
70-
The value for `allowed_rps` changes depending on overall network conditions; therefore consider the value
71-
for `current_rps` valid and up-to-date.
72-
73-
:::
74-
7561
### Tips to avoid rate limiting
7662

77-
We recommend pausing JSON-RPC activity for the time value in `backoff_seconds`.
63+
We recommend pausing JSON-RPC activity if you surpass your request per second capacity.
7864

7965
If you're consistently rate limited, consider these workarounds:
8066

0 commit comments

Comments
 (0)