HercleX API Documentation

Skip to main content

API TYPE

REST APISwitch to WebSocket →

Getting Started

Introduction
Authentication
Webhooks
Errors

Addresses

Get Whitelisted Addresses
Whitelist Address
Whitelist Address With Params
Remove Whitelisted Address
Get Deposit Addresses
Create Deposit Address

Pairs

Get Available Pairs
Get Pair Size by Amount
Get Asset Networks
Get Pair Price

Orders

Place OTC Order
Get Orders Paginated
Get Orders by ClientId

RFQ

Create RFQ
Create Custom RFQ
Accept RFQ

User

Get Balances
Get Trades Paginated
Get Historical Trades Paginated
Get Trades by ClientId
Get Transactions Paginated
Get Historical Transactions Paginated

Withdrawals

Create Withdrawal
Create Withdrawal With Address Params
Create Instant Withdrawal
Get Withdrawals
Get Withdrawals Paginated
Get Withdrawals by ClientId

Lightning Network

Create Lightning Invoice
Get Lightning Invoices
Create Lightning Withdrawal

Banking

Get Business End Users PaginatedSandbox
Register Business End UserSandbox
Get Individual End Users PaginatedSandbox
Register Individual End UserSandbox
Get Deposit Accounts PaginatedSandbox
Create Deposit AccountSandbox
Get Payees Paginated
Register Payee
Get Payee Addresses Paginated
Register Payee Address
Approve Payee Address
Get Transfers Paginated
Create Transfer
Get Transaction Ledger
Simulate Pay-InSandbox

Resources

Quick Reference
Changelog