Quick Reference
All REST API endpoints at a glance. Click any endpoint to see full documentation.
Base URL: https://publicapi.hercle.financial | OpenAPI Spec (JSON) | llms.txt
Pairs
| Method | Path | Description |
|---|---|---|
| GET | /api/v1/pairs | Get all available trading pairs |
| GET | /api/v1/pairs/{pair}/{side}/{amount} | Get pair size by amount |
| GET | /api/v1/pairs/networks/{asset} | Get asset networks |
| GET | /api/v1/price/{pair}/{size} | Get pair price |
Orders
| Method | Path | Description |
|---|---|---|
| POST | /api/v1/orders | Place OTC order |
| GET | /api/v1/orders/{startDate}/{endDate}/{page}/{pageSize} | Get orders paginated |
| GET | /api/v1/orders/{clientId} | Get orders by client ID |
RFQ (Request for Quote)
| Method | Path | Description |
|---|---|---|
| POST | /api/v1/rfq | Create RFQ |
| POST | /api/v1/rfq/accept | Accept RFQ |
| POST | /api/v1/rfq/custom-expiration | Create custom RFQ |
User / Account
| Method | Path | Description |
|---|---|---|
| GET | /api/v1/user/balances | Get account balances |
| GET | /api/v1/user/trades/... | Get trades paginated |
| GET | /api/v1/user/trades/{tradeClientId} | Get trades by client ID |
| GET | /api/v1/user/trades/.../historical | Get historical trades |
| GET | /api/v1/user/transactions/... | Get transactions paginated |
| GET | /api/v1/user/transactions/.../historical | Get historical transactions |
Addresses
| Method | Path | Description |
|---|---|---|
| GET | /api/v1/addresses/whitelisted | Get whitelisted addresses |
| POST | /api/v1/addresses/whitelist | Whitelist address |
| POST | /api/v1/addresses/whitelist/params | Whitelist address with params |
| DELETE | /api/v1/addresses/whitelist | Remove whitelisted address |
| GET | /api/v1/addresses/deposit | Get deposit addresses |
| POST | /api/v1/addresses/deposit | Create deposit address |
Withdrawals
| Method | Path | Description |
|---|---|---|
| POST | /api/v1/withdrawals | Create withdrawal |
| POST | /api/v1/withdrawals/address | Create withdrawal with address params |
| POST | /api/v1/withdrawals/instant | Create instant withdrawal |
| GET | /api/v1/withdrawals | Get withdrawals |
| GET | /api/v1/withdrawals/{start}/{end}/{page}/{size} | Get withdrawals paginated |
| GET | /api/v1/withdrawals/{clientId} | Get withdrawals by client ID |
Lightning Network
| Method | Path | Description |
|---|---|---|
| POST | /api/v1/invoices | Create Lightning invoice |
| GET | /api/v1/invoices | Get Lightning invoices |
| POST | /api/v1/lightning/withdrawals | Create Lightning withdrawal |
Banking
| Method | Path | Description |
|---|---|---|
| GET | /api/v1/payees | Get payees paginated |
| POST | /api/v1/payee | Register payee |
| GET | /api/v1/payee-addresses | Get payee addresses |
| POST | /api/v1/payees/{id}/addresses | Register payee address |
| PATCH | /api/v1/payees/{id}/addresses/{id}/approve | Approve payee address |
| GET | /api/v1/transfers | Get transfers paginated |
| POST | /api/v1/transfer | Create bank transfer |
| GET | /api/v1/transactions/{id} | Get transaction ledger |
Banking (Sandbox Only)
| Method | Path | Description |
|---|---|---|
| GET | /api/v1/end-users/businesses | Get business end usersSandbox |
| POST | /api/v1/end-users/businesses | Register business end userSandbox |
| GET | /api/v1/end-users/individuals | Get individual end usersSandbox |
| POST | /api/v1/end-users/individuals | Register individual end userSandbox |
| GET | /api/v1/deposit-accounts | Get deposit accountsSandbox |
| POST | /api/v1/deposit-accounts | Create deposit accountSandbox |
| POST | /api/v1/simulate-payin | Simulate pay-inSandbox |