This API is in private preview. Target October 2026; timing is subject to change.
Returns the native request allowance and usage for an account.
Available now. This read is served at the interim endpoint today.
POST /{apiKey}/info
| Parameter | Type | Required | Description |
|---|---|---|---|
type | string | Yes | Selects userRateLimit. |
user | string | Yes | Master or sub-account address. |
{
"type": "userRateLimit",
"user": "0x0000000000000000000000000000000000000000"
}| Field | Type | Description |
|---|---|---|
cumVlm | string | Cumulative volume used to scale the request cap. |
nRequestsUsed | integer | Requests used after reserved capacity. |
nRequestsCap | integer | Current request cap, which scales with cumVlm. |
nRequestsSurplus | integer | Reserved request capacity remaining. |
{
"cumVlm": "2854574.593578",
"nRequestsUsed": 2890,
"nRequestsCap": 2864574,
"nRequestsSurplus": 0
}This example is one address at one point in time; nRequestsCap scales with that address's cumulative volume.