ZEzerion
subscriptions to transactions

Find subscriptions

Changed on

Returns your transaction subscriptions, oldest first, one page at a time. A page holds up to page[size] subscriptions, 1000 by default.

links.next points to the next page and is omitted on the last one. meta.total is the number of your non-expired subscriptions that match filter[chain_ids], across all pages. An out-of-range page[size] or a malformed page[after] returns 400.

See also: Resource IDs

get/v1/tx-subscriptions/

Request

  • Base URL
    https://api.zerion.io
  • URL
    https://api.zerion.io/v1/tx-subscriptions/
  • Auth
    HTTP basic

Query parameters

afterstring

Cursor for the next page. Don't build it yourself: follow links.next instead. Omit it to get the first page. A cursor longer than 256 characters or a malformed cursor returns 400.

sizeinteger

Maximum number of subscriptions per page. Defaults to 1000. A value that is not an integer from 1 to 1000 returns 400.

Pagination parameters. Defaults to the first page of up to 1000 subscriptions.

filter[chain_ids]string[]

Return only subscriptions on these chains (comma-separated list). Only chains reporting both supports_transactions and supports_positions in the flags of GET /v1/chains/ are accepted here. Naming a chain that fails that gate returns 400 rather than an empty result, with detail reading chain <id> does not support transactions. That detail names the endpoint's capability rather than the flag that failed, so bob is refused with chain bob does not support transactions even though it reports supports_transactions. What it lacks is supports_positions. When the filter is omitted, the search covers every chain that passes the gate, and chains that fail it are left out silently, with no error and no meta signal.

[
  "polygon"
]

Response

Response for requested wallet's transactions subscription

Example response

{
  "links": {
    "self": "https://api.zerion.io/v1/tx-subscriptions/?filter%5Bchain_ids%5D=ethereum",
    "next": "https://api.zerion.io/v1/tx-subscriptions/?filter%5Bchain_ids%5D=ethereum&page%5Bafter%5D=MjAyNi0xMC0xNVQxOToyMTowNC42NVosM2Y2YzJhOWUtOGIxZC00YzdhLTllMmYtMWEyYjNjNGQ1ZTZm&page%5Bsize%5D=2"
  },
  "data": [
    {
      "type": "transactions_subscription",
      "id": "52d994a173d755e99845e861d534a419",
      "attributes": {
        "callback_url": "https://webhook.site/fcd606d2-f5bd-4832-9874-ff07c980b5a3",
        "created_at": "2022-08-15T11:26:31+00:00",
        "updated_at": "2022-08-15T11:26:31+00:00",
        "filters": {
          "exclude": {
            "types": [
              "send"
            ],
            "is_spam": true,
            "protocol_ids": [
              "uniswap-v3"
            ],
            "addresses": [
              "0x0000000000000000000000000000000000000001"
            ]
          }
        }
      },
      "relationships": {
        "chains": [
          {
            "links": {
              "related": "https://api.zerion.io/v1/chains/polygon"
            },
            "data": {
              "type": "chains",
              "id": "polygon"
            }
          }
        ]
      }
    }
  ],
  "meta": {
    "total": 5956
  }
}

Changes

  • 719a229a555dRevision changes
    • info

      added the new optional query request parameter page

    • info

      added the optional property /// to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status