Push

Follow an entity (live fills)

Pushes the entity's fills to your WebSocket/webhook. Unlock its address first (402 address_not_unlocked). CHARGES 1 cent now for the first hour, then hourly until canceled (free within plan push slots). Spends 1 daily distinct-entity unit. Starts ~96 s (65 blocks) behind the head.

post/v1/account/subscriptions

Request

Base URL: https://api.pmwallets.com
URL: https://api.pmwallets.com/v1/account/subscriptions
Auth: API key in header x-api-key

Request body

entityIdstring required

A 12-character entity handle (Crockford base32, e.g. 7KQ2MF9X4B1C) or a full 0x address (40 hex).

channelsstring[]

Where to deliver. Default ["ws"].

acceptInactiveboolean

Subscribe even if the entity has had no fill for 7 days (otherwise 409).

Response

Subscribed, first hour paid (HTTP 201). Hours with no feed are not charged; pauses when the balance runs out. At most 200 active.

idstring

userIdstring

chaininteger

entityIdstring

The 0x address once paid for and still held; a handle otherwise (never-charged or plan-locked rows).

labelstring

channelsstring[]

status'active' | 'paused' | 'canceled'

pausedReasonstring nullable

e.g. insufficient_balance, webhook_disabled, no_webhook, plan_ended, plan_limit, address_locked.

fromBlockinteger

Fills strictly after this block are delivered.

syncedBlockinteger

tierstring

priceCentsinteger

Hourly price frozen on the subscription.

billedThroughstring date-time nullable

Prepaid up to here.

planCoveredboolean

The last billed hour was covered by a plan push slot (free).

activationsinteger

createdAtstring date-time

canceledAtstring date-time nullable

followedAtstring date-time nullable

lastFillTsstring nullable

List endpoint only.

fills24hinteger nullable

List endpoint only.

Changes

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