API

JSON-RPC and REST interfaces

Orin Core provides JSON-RPC and REST APIs for blockchain, wallet, and mempool operations.

JSON-RPC

  • orind enables JSON-RPC by default; orin-qt needs -server.
  • Endpoints: / and /wallet/<walletname>/.
  • Ports match REST: mainnet 9998, testnet 19998 (override with rpcport).
curl --user alice --data-binary '{"jsonrpc":"1.0","id":"0","method":"getblockcount","params":[]}' \
  -H 'content-type: text/plain;' http://127.0.0.1:9998/

Positional, named, and args-based parameters are supported.

Use orin-cli help or orin-cli help <command> for full RPC listings.

REST API

Enable REST with -rest. Outputs are available in bin, hex, and json.

Method Endpoint Description
GET /rest/tx/<TX-HASH>.<bin|hex|json> Transaction from mempool (txindex=1 for confirmed).
GET /rest/block/<BLOCK-HASH>.<bin|hex|json> Full block data.
GET /rest/block/notxdetails/<BLOCK-HASH>.<bin|hex|json> Block without transaction details.
GET /rest/headers/<BLOCK-HASH>.<bin|hex|json>?count=<N> Block headers starting from hash.
GET /rest/blockfilterheaders/<FILTERTYPE>/<BLOCK-HASH>.<bin|hex|json>?count=<N> Block filter headers.
GET /rest/blockfilter/<FILTERTYPE>/<BLOCK-HASH>.<bin|hex|json> Block filter for the given type.
GET /rest/blockhashbyheight/<HEIGHT>.<bin|hex|json> Block hash by height.
GET /rest/chaininfo.json Chain state info (getblockchaininfo).
GET /rest/getutxos/<TXID>-<N>/.../<TXID>-<N>.<bin|hex|json> Query UTXO set by outpoints.
GET /rest/getutxos/checkmempool/...<bin|hex|json> UTXO query with mempool checks.
GET /rest/mempool/info.json Mempool statistics.
GET /rest/mempool/contents.json Full mempool contents.

Security notes

  • Do not expose RPC/REST to the public internet without tunneling.
  • Increase OS file-descriptor limits for high request volume.
  • REST may expose privacy data if you browse untrusted pages on the same host.