API Reference

An interactive reference for NETTS API v2, generated from the OpenAPI 3.1 specification. Every operation lists its parameters, request and response schemas, code samples for curl, JavaScript, Python and PHP, and lets you send a test request.

The base URL is https://netts.io/apiv2. The key goes in the X-API-KEY header, and the request IP must be in the key's whitelist.

Hand-written guides

These pages are generated from the specification. The hand-written endpoint guides under API v2 remain the canonical source until the specification has been proof-read against the services — see openapi/README.md in the repository.

Account

Account details and balance.

Operation	Method and path
Rotate the deposit address	POST /address/rotate
Whether a rotation is queued	GET /address/rotate/pending
Address rotation status	GET /address/rotate/status/{rotation_id}
Account information and balance	GET /userinfo
Withdraw TRX from your balance	POST /withdraw
Withdrawal status	GET /withdraw/status/{orderId}
Configure the withdrawal webhook	POST /withdraw/webhook
Current withdrawal webhook configuration	GET /withdraw/webhook
Disable the withdrawal webhook	DELETE /withdraw/webhook

Pricing

Current prices for every service.

Operation	Method and path
Energy prices (deprecated)	GET /prices
Prices for every service	GET /pricing

Energy

Ordering energy and working with orders.

Operation	Method and path
Activate a TRON address	POST /activator
Reclaim energy early	POST /energy/reclaim/{orderId}
Batch order for up to 100 addresses	POST /orchestrator
Cancel the addresses of a batch that have not started	POST /orchestrator/cancel/{idempotencyKey}
Batch progress	GET /orchestrator/status/{idempotencyKey}
Details of a 1-hour order	GET /order_check
Order energy for 1 hour	POST /order1h
Order energy for 5 minutes	POST /order5m

Bandwidth

Bandwidth rental. Access is granted by support on request.

Operation	Method and path
Rent bandwidth	POST /bandwidth
Reclaim bandwidth early	POST /bandwidth/reclaim/{orderId}
Bandwidth order status	GET /bandwidth/status/{orderId}

Host Mode

Renting energy to your own address pool and reselling it.

Operation	Method and path
Add an address to Host Mode	POST /time/add
Remove an address from Host Mode	POST /time/delete
Enable infinity mode	POST /time/infinitystart
Buy cycles and switch the address on	POST /time/order
Status of all Host Mode addresses	POST /time/status
Status of a single Host Mode address	GET /time/status/{address}
Stop Host Mode for an address	POST /time/stop

AML

TRON address screening through external AML providers.

Operation	Method and path
Screen an address for AML	POST /aml
AML check result	GET /aml/{order_id}
Check history for an address	GET /aml/history
AML check price and whether your balance covers it	GET /aml/price
List AML providers with prices	GET /aml/providers

Sub-users

Managing sub-users (reseller scheme).

Operation	Method and path
Delete a sub-user	DELETE /subuserdel/{user_id}
Create a sub-user	POST /subusergen

USDT

Estimating the cost of a USDT transfer between two addresses.

Operation	Method and path
USDT transfer cost (public, no key)	GET /usdt/{sender}&{receiver}
USDT transfer cost (authenticated)	POST /usdt/analyze

Balances

Reading TRON balances: current, at a past point, dynamics and period turnover.

Operation	Method and path
Current balances of an address	GET /balances/{address}
Balances at the end of a date	GET /balances/{address}/at
Balances at a block or a moment	GET /balances/{address}/at-block
Balance dynamics for one token	GET /balances/{address}/history
Statement preview for one token	GET /balances/{address}/statement
Period turnover per token	GET /balances/{address}/summary

Reports

Statement files built in the background, their status and delivery notifications.

Operation	Method and path
Status of a report order	GET /reports/{order_no}
Download a finished report	GET /reports/{order_no}/download
Queue a statement file	POST /reports/statement
Register a report webhook endpoint	POST /reports/webhooks
List your report webhook endpoints	GET /reports/webhooks
Read one endpoint	GET /reports/webhooks/{endpoint_id}
Change the URL or pause an endpoint	PATCH /reports/webhooks/{endpoint_id}
Delete an endpoint	DELETE /reports/webhooks/{endpoint_id}
Issue a new signing secret	POST /reports/webhooks/{endpoint_id}/rotate-secret

Webhooks

Notifications NETTS sends to your callback URL.

Operation	Method and path
Register a webhook endpoint	POST /webhooks
List your delivery endpoints	GET /webhooks
A single delivery endpoint	GET /webhooks/{id}
Edit a delivery endpoint	PATCH /webhooks/{id}
Delete a delivery endpoint	DELETE /webhooks/{id}
Rotate the signing secret	POST /webhooks/{id}/rotate-secret

Outgoing notifications

NETTS calls your server. The formats are described in the specification:

• delegation.confirmed — Bandwidth order fulfilled
• bandwidth.delegated — Bandwidth order fulfilled
• activation.confirmed — Address activated on-chain
• withdraw.completed — Withdrawal reached a terminal state
• host.delegation — Host Mode delegation