Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.offthehook.dev/llms.txt

Use this file to discover all available pages before exploring further.

The subscription resource embeds up to 200 addresses inline in its filters.addresses array. When a subscription exceeds that limit, filters.hasMore is true and you use this endpoint to page through the full list using an opaque cursor token.

Request

GET /v1/subscriptions/:id/filters/addresses

Path parameters

id
string
required
The subscription ID (e.g. sub_2QkP9aB7xN...).

Query parameters

limit
integer
Number of addresses to return per page. Must be between 1 and 200. Defaults to 50.
nextPageToken
string
Opaque cursor returned by the previous response. Pass this value verbatim to fetch the next page. Omit or leave empty to start from the beginning.
curl "https://api.offthehook.dev/v1/subscriptions/sub_2QkP9aB7xN.../filters/addresses?limit=50" \
  -H "Authorization: Bearer oth_YOUR_API_KEY"

Response

200 OK — a paginated list of address objects.
{
  "items": [
    { "chainId": "tron:mainnet", "address": "TLsV52sRDL79HXGGm9yzwKibb6BeruhUzy" },
    { "chainId": "tron:nile", "address": "TLsV52sRDL79HXGGm9yzwKibb6BeruhUzy" }
  ],
  "nextPageToken": "v1:..."
}
items
array
The address objects on this page. Each item has a chainId (CAIP-2 identifier, e.g. tron:mainnet) and an address (base58check-encoded TRON address).
nextPageToken
string | null
Cursor for the next page. Pass this as the nextPageToken query parameter on your next request. null when you have reached the last page.

Errors

CodeHTTPDescription
not_found404The subscription ID does not exist or belongs to a different API key.
invalid_pagination_token400The nextPageToken value is malformed or was issued by a different API version.
unauthorized401The Authorization header is missing or the key is invalid.