Get webhook plan limits and usage

curl --request GET \
  --url https://api.0xarchive.io/v1/webhooks/limits \
  --header 'X-API-Key: <api-key>'

const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};

fetch('https://api.0xarchive.io/v1/webhooks/limits', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.0xarchive.io/v1/webhooks/limits"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-API-Key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

{
  "success": true,
  "data": {
    "plan": "pro",
    "included": true,
    "preview_included": true,
    "endpoints": {
      "used": 1,
      "limit": 4,
      "remaining": 3
    },
    "subscriptions": {
      "used": 1,
      "limit": 4,
      "remaining": 3
    },
    "watched_addresses": {
      "used": 1,
      "limit": 4,
      "remaining": 3
    },
    "deliveries_per_day": {
      "used": 412,
      "limit": 50000,
      "remaining": 49588,
      "unlimited": false,
      "resets_at": "2023-11-07T05:31:56Z",
      "resets_at_note": "<string>"
    },
    "paused_subscriptions": {
      "count": 0,
      "reasons": [],
      "earliest_paused_at": "2023-11-07T05:31:56Z",
      "message": "<string>"
    },
    "plan_label": "Pro",
    "notice": "<string>"
  },
  "meta": {
    "request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "count": 123,
    "has_more": true,
    "next_cursor": "<string>",
    "symbol": "BTC",
    "venue": "hyperliquid",
    "coverage_from": "2023-11-07T05:31:56Z",
    "notice": "<string>",
    "finalized_through": "2023-11-07T05:31:56Z",
    "requested_end": "2023-11-07T05:31:56Z",
    "clamped_to": "2023-11-07T05:31:56Z",
    "preliminary_row_count": 123
  }
}

GET

https://api.0xarchive.io

webhooks

limits

Get webhook plan limits and usage

curl --request GET \
  --url https://api.0xarchive.io/v1/webhooks/limits \
  --header 'X-API-Key: <api-key>'

const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};

fetch('https://api.0xarchive.io/v1/webhooks/limits', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.0xarchive.io/v1/webhooks/limits"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-API-Key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

{
  "success": true,
  "data": {
    "plan": "pro",
    "included": true,
    "preview_included": true,
    "endpoints": {
      "used": 1,
      "limit": 4,
      "remaining": 3
    },
    "subscriptions": {
      "used": 1,
      "limit": 4,
      "remaining": 3
    },
    "watched_addresses": {
      "used": 1,
      "limit": 4,
      "remaining": 3
    },
    "deliveries_per_day": {
      "used": 412,
      "limit": 50000,
      "remaining": 49588,
      "unlimited": false,
      "resets_at": "2023-11-07T05:31:56Z",
      "resets_at_note": "<string>"
    },
    "paused_subscriptions": {
      "count": 0,
      "reasons": [],
      "earliest_paused_at": "2023-11-07T05:31:56Z",
      "message": "<string>"
    },
    "plan_label": "Pro",
    "notice": "<string>"
  },
  "meta": {
    "request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "count": 123,
    "has_more": true,
    "next_cursor": "<string>",
    "symbol": "BTC",
    "venue": "hyperliquid",
    "coverage_from": "2023-11-07T05:31:56Z",
    "notice": "<string>",
    "finalized_through": "2023-11-07T05:31:56Z",
    "requested_end": "2023-11-07T05:31:56Z",
    "clamped_to": "2023-11-07T05:31:56Z",
    "preliminary_row_count": 123
  }
}

API key required. Send X-API-Key with this request. See REST authentication.

Operation schema

Shared request rules

Machine schema

Open the generated operation schema for machine-readable request and response details.

Authorizations

X-API-Key

string

header

required

API key for authentication. Get yours at https://0xarchive.io/dashboard

Headers

0xArchive-Version

enum<string>

Selects the 2026-10 response contract. Send 2026-10-01; any dated version on or after it selects the same shapes. Without the header every response keeps its existing shape. With it:

The data quality routes, /v1/status/coverage and /v1/symbols answer the standard {success, data, meta} envelope.
Record times that are integer milliseconds by default become RFC 3339 UTC strings with millisecond precision, and the integer moves to a *_ms field: L4 resting-order timestamp (timestamp_ms), CVD buckets, HIP-3 oracle reads, Lighter and Lighter on Robinhood Chain liquidations and liquidation volume. Levels and trigger-levels snapshot_ts become RFC 3339 with snapshot_ts_ms.
Error bodies carry the contract error_code names: invalid_parameter instead of invalid_query_params and invalid_path_params, historical_depth_exceeded instead of history_window_exceeded, and historical_range_exceeded instead of request_range_exceeded; a malformed cursor that fails to parse answers 400 invalid_cursor instead of invalid_query_params. With 0xArchive-Version: 2026-10-01, malformed cursors on trades, liquidations, L2 and L4 diffs, order history, TP/SL and order-flow routes answer 400 invalid_cursor. Without the header, the first six route families treat a malformed cursor as no cursor and return the first page; order flow answers 400 invalid_query_params. Malformed trade time inputs answer 400 invalid_time_range with the header and 400 invalid_query_params without it.

The response echoes the selected version in its own 0xArchive-Version header.

Available options:

2026-10-01

Example:

"2026-10-01"

Response

Webhook plan limits and current usage

API response containing webhook plan limits and current usage.

success

boolean

required

Example:

true

data

object

required

What this plan allows and what is in use, in one call. Every number is read from the same place the caps are enforced from, so a refusal and this report cannot disagree.

Hide child attributes

data.plan

string

required

The plan webhook decisions are priced at.

Example:

"pro"

data.included

boolean

required

Whether the plan has webhook delivery at all. False on Free, where every cap is zero.

Example:

true

data.preview_included

boolean

required

Whether the estimate and the dry-run are available. True on every plan, including Free.

Example:

true

data.endpoints

object

required

One cap: what the plan allows, what is in use, and what is left.

Hide child attributes

data.endpoints.used

integer<int64>

required

In use now.

Example:

1

data.endpoints.limit

integer<int64>

required

What the plan allows. Zero on a plan without webhook delivery.

Example:

4

data.endpoints.remaining

integer<int64>

required

What is left, never below zero. A plan change can leave an account legitimately over a cap.

Example:

3

data.subscriptions

object

required

One cap: what the plan allows, what is in use, and what is left.

Hide child attributes

data.subscriptions.used

integer<int64>

required

In use now.

Example:

1

data.subscriptions.limit

integer<int64>

required

What the plan allows. Zero on a plan without webhook delivery.

Example:

4

data.subscriptions.remaining

integer<int64>

required

What is left, never below zero. A plan change can leave an account legitimately over a cap.

Example:

3

data.watched_addresses

object

required

One cap: what the plan allows, what is in use, and what is left.

Hide child attributes

data.watched_addresses.used

integer<int64>

required

In use now.

Example:

1

data.watched_addresses.limit

integer<int64>

required

What the plan allows. Zero on a plan without webhook delivery.

Example:

4

data.watched_addresses.remaining

integer<int64>

required

What is left, never below zero. A plan change can leave an account legitimately over a cap.

Example:

3

data.deliveries_per_day

object

required

Today's delivery budget. The budget resets on its own; a paused rule does not.

Hide child attributes

data.deliveries_per_day.used

integer<int64>

required

Deliveries today.

Example:

412

data.deliveries_per_day.limit

integer<int64> | null

required

Deliveries a day the plan allows. Null when the plan has no ceiling.

Example:

50000

data.deliveries_per_day.remaining

integer<int64> | null

required

Deliveries left today, never below zero. Null when the plan has no ceiling.

Example:

49588

data.deliveries_per_day.unlimited

boolean

required

True when the plan has no daily ceiling.

Example:

false

data.deliveries_per_day.resets_at

string<date-time>

required

When the budget resets.

data.deliveries_per_day.resets_at_note

string

Present only while something is paused, to say that the reset time is the budget's and not the pause's.

data.paused_subscriptions

object

required

Paused rules on the account. Always present, so zero paused needs no special case.

Hide child attributes

data.paused_subscriptions.count

integer<int64>

required

How many rules are paused and delivering nothing.

Example:

0

data.paused_subscriptions.reasons

string[]

required

Distinct causes across the paused rules: the account reached its daily delivery limit, or the plan does not include webhook delivery.

Example:

[]

data.paused_subscriptions.earliest_paused_at

string<date-time> | null

Start of the oldest pause still in force.

data.paused_subscriptions.message

string

What is paused and what clears it, in plain words. Present only when something is paused.

data.plan_label

string | null

The plan's display name, or null for a plan this build cannot name.

Example:

"Pro"

data.notice

string

Why the caps are zero, and what to do about it. Present only on a plan without webhook delivery.

Guides

API reference

Get webhook plan limits and usage

Authorizations

Headers

Response