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.

Off the Hook gives you real-time, cryptographically signed webhook notifications for every token transfer on TRON — TRX, USDT, USDC, USDD, and any TRC-20 contract. You create a subscription, add the addresses you want to watch, and Off the Hook POSTs a Standard Webhooks-compliant payload to your endpoint within seconds of a transfer hitting the chain.

Quick Start

Create your first subscription and receive a live transfer notification in minutes.

Authentication

Learn how to obtain your API key and authenticate every request.

Subscriptions

Understand the subscription resource — destinations, events, and address filters.

API Reference

Browse the full REST API with request and response schemas.

How it works

Off the Hook polls TRON Mainnet, Nile, and Shasta every three seconds, decodes every TRX and TRC-20 transfer, and matches them against your subscribed addresses. Matched transfers are signed with HMAC-SHA256 using the Standard Webhooks spec and delivered to your HTTPS endpoint with automatic retries.
1

Get an API key

Contact the Off the Hook team to provision your account and receive an oth_… API key.
2

Create a subscription

POST to /v1/subscriptions with your destination URL and the event types you want to receive.
3

Add addresses to watch

PATCH /v1/subscriptions/:id/filters/addresses to add TRON addresses on any supported chain.
4

Receive signed webhooks

Off the Hook fires a signed HTTPS POST to your endpoint whenever a matching transfer is detected.

Supported networks

Off the Hook covers all three TRON networks with CAIP-2 identifiers you use in every API call:
NetworkCAIP-2 IDPurpose
TRON Mainnettron:mainnetProduction
TRON Niletron:nileTestnet
TRON Shastatron:shastaTestnet

Verify Signatures

Validate every incoming webhook with the Svix library or your own HMAC implementation.

Event Types

See the full list of supported event kinds and their payload shapes.

Manage Addresses

Add, remove, and replace the addresses your subscriptions watch.

Error Codes

Understand every error code the API can return and how to handle them.