Subscriptions

One subscription with its delivery health.

Returns the subscription details and per-chain delivery progress. delivered_through_block is a lower bound of delivery progress; during quiet periods without matching events, progress flushes periodically (at most once every ~60 seconds) and may lag behind the chain release frontier by up to about 60 seconds. If this status query returns a 5xx error or times out, the status is unknown; clients should retain their previously observed watermark and must not classify the subscription as stalled.

get/push/subscriptions/{subscription_id}

Request

  • Base URL: https://api.blockvectra.com/v1
  • URL: https://api.blockvectra.com/v1/push/subscriptions/{subscription_id}
  • Auth: API key in header x-api-key

Response

The subscription after the call.

idinteger required

The subscription id: the one number that identifies a subscription everywhere (PostgreSQL integer identity, fits u32, never reused). A plain JSON integer in bodies, decimal digits in the path.

urlstring required

https, port 443, a host name (no IP literal), no userinfo or fragment; stored and returned normalized.

status'online' | 'offline' required

online listens and delivers; offline does not listen (addresses unloaded, no matching, delivery or address fee) and keeps its whole configuration, and can go online again at any time. Change it with PATCH; the system also sets offline when the subscription expires (a chain failed for the expiry window, currently 7 days, and no other chain delivered inside it).

key_idstring required
address_countinteger required

Distinct addresses of this subscription; additions cannot exceed 1,000,000. Existing oversized subscriptions can remove addresses and resend existing addresses.

applied_versioninteger required

Address and chain changes of this subscription up to this version are applied on every chain; compare with change_version returned by add, remove and PATCH (a counter of this subscription only).

chainsobject required
created_atstring required

Changes

No recorded changes to this operation across all 1 revision of this API.