Home / Docs / API Reference

API Reference

HTTP REST API on port 8080. Rate limited: 100 req/s sustained, 500 burst per IP.

Endpoint Groups

GroupPrefixDescription
Accounts/accountsBalances, chains, frontiers
Blocks/blocks, /powSubmit and query blocks
Leases/leases, /providersLease management
State Chain/statechainDAO governance
Directory/directoryAccount-to-peer registration
Chat/chatP2P messaging
Node/node, /pending, /frontiersNode info

Read Endpoints

MethodPathDescription
GET/accountsList all accounts
GET/accounts/{address}/balanceGet account balances
GET/accounts/{address}/chainGet account block chain
GET/accounts/{address}/keysetGet multisig keyset
GET/blocks/{hash}Get block by hash
GET/blocks/recentGet recent blocks
GET/leasesList all leases
GET/leases/{hash}Get lease by hash
GET/providersList providers
GET/statechain/tipLatest state chain block
GET/statechain/blocksBlock range
GET/statechain/blocks/{index}Block by index
GET/statechain/kv/{key}Get state value
GET/statechain/kvAll KV entries
GET/statechain/keysetDAO keyset
GET/directoryAll registrations
GET/directory/{account}Lookup registration
GET/chat/messagesGet messages
GET/chat/contactsList contacts
GET/chat/eventsSSE message stream
GET/nodeNode info
GET/pendingAll pending sends
GET/pending/{address}Pending for account
GET/frontiersAll frontiers
GET/conflictsAll conflicts
GET/conflicts/{account}Conflicts for account
GET/vmsList VMs
GET/vms/{lease}Get VM info
GET/certificateProvider's certificate
GET/certificate/{provider}Cached certificate

Write Endpoints

MethodPathDescription
POST/blocks/sendSubmit send block
POST/blocks/receiveSubmit receive block
POST/blocks/claimSubmit claim block
POST/blocks/leaseSubmit lease block
POST/blocks/lease_acceptSubmit lease accept
POST/blocks/lease_settleSubmit lease settle
POST/blocks/multisig_openOpen multisig account
POST/blocks/multisig_updateUpdate multisig keyset
POST/powCompute PoW nonce
POST/lease/requestRequest compute resources
POST/attestation/requestRequest timekeeper attestation
POST/statechain/blocksSubmit state chain block
POST/directory/registerRegister in directory
POST/chat/sendSend chat message
POST/vms/{lease}/execExecute command in VM
POST/tunnel/{leaseHash}/tcpTCP tunnel to VM