Console API

Account

• GET/v1/accountThe plan of the account with its limits and what is used of them (credits, RPS, address watch slots, payment slots, payments of the month).
• GET/v1/usageRequests and credits of the whole account by day over the last 7, 30 or 90 days, with the top methods and a webhook breakdown.

Networks

• GET/v1/networksActive networks, ordered by sort, with the slugs of their environments.
• GET/v1/networks/{slug}/creditsWhat an Address Watch event, a payment, a Tx Watch delivery and a block webhook cost in credits, per environment of the network.
• GET/v1/networks/{slug}/methodsThe RPC methods the network serves and what each costs in credits.
• GET/v1/network-statusLive status of all active networks: status, chain tip height and node latency, as last measured.
• GET/v1/network-tokensTokens of a network that can be used for payments, by contract, with symbol and number of decimals.

Endpoints

• GET/v1/endpointsList the JSON-RPC endpoints of the account (paginated).
• GET/v1/endpoints/available-networksNetworks (and their environment slugs) an endpoint can be created on under your plan.
• POST/v1/endpointsCreate a JSON-RPC endpoint on a network environment. Counts against the endpoints_limit of your plan.
• GET/v1/endpoints/{uuid}/usageRequests and credits of one endpoint for the last N calendar days, with top methods and webhook totals.
• PATCH/v1/endpoints/{uuid}/statusSet the endpoint status to active or paused (paused stops JSON-RPC traffic).
• PATCH/v1/endpoints/{uuid}/allowed-ipsReplace the client IP allowlist of the endpoint. An empty array clears the restriction (allow all).

Payments

• POST/v1/paymentsCreate a payment for an order: an address, an amount and a lifetime.
• GET/v1/paymentsList the payments of the account, newest first.
• GET/v1/payments/{paymentId}One payment by its payment_id.
• GET/v1/payments/orders/{orderId}One payment by your own order_id.
• POST/v1/payments/{paymentId}/cancelCancel a payment that is still pending. Takes no body.

Address Watch

• GET/v1/address-watches/accountAddress slots of the plan: how many there are and how many are taken, plus the webhook state.
• GET/v1/address-watchesList watched addresses (paginated, newest first). Filter by network and/or part of the address.
• POST/v1/address-watchesStart watching an address on a network. Takes one address slot.
• DELETE/v1/address-watches/{watchId}Stop watching an address. The watch id goes in the path; there is no request body.
• GET/v1/address-watches/eventsRecent events of your watched addresses, newest first. The transaction details are flattened onto each event (no nested payload).

Transaction watch

• GET/v1/tx-watchesList your tx watches, newest first: the open ones and the ones that ended. Also returns the slots of the plan.
• POST/v1/tx-watchesStart watching a transaction hash on a network. Takes one tx slot until the watch ends.
• DELETE/v1/tx-watches/{watchId}Stop watching a transaction and remove the watch. The watch id goes in the path; there is no request body.

Webhooks

• GET/v1/webhooksThe webhook of the account: URL, enabled flag, networks per kind of event, egress IPs and the signing secret.
• PUT/v1/webhooksSave the URL, switch the webhook on or off, and choose the networks per kind of event.
• POST/v1/webhooks/secretIssue a new signing secret. The old one stops working at once.
• POST/v1/webhooks/testSend a test delivery to the saved URL. How it went shows in the delivery log.
• GET/v1/webhooks/deliveriesThe delivery log: recent deliveries to your URL with their status, attempts and last answer.

WebSockets (subscription)

• GET/v1/realtime/subscriptionRead whether the WebSocket is on and which networks it receives for each kind of event.
• PUT/v1/realtime/subscriptionSwitch the WebSocket on or off and optionally replace the network lists. Returns the saved state.