HTTP Client-Server API

BigchainDB Root URL

http://localhost:9984 or https://example.com:9984

API Root Endpoint

http://localhost:9984/api/v1/ or https://example.com:9984/api/v1/

Transactions:

• Get the transaction with the ID transaction_id
  GET /api/v1/transactions/{transaction_id}

• Get a list of transactions that use an asset with the ID asset_id
  GET /api/v1/transactions?asset_id={asset_id}
GET /api/v1/transactions?asset_id={asset_id}&operation={CREATE|TRANSFER}

• Transaction status
  GET /api/v1/statuses?transaction_id={transaction_id}

Transaction Outputs: 返回由给定的公钥过滤的交易输出

• Get transaction outputs by public key
  GET /api/v1/outputs?public_key={public_key}
GET /api/v1/outputs?public_key={public_key}&spent=true "output": 0
  GET /api/v1/outputs?public_key={public_key}&spent=false "output": 1

Status

• Get the status of an asynchronously written transaction or block by their id
  GET /api/v1/statuses?transaction_id={transaction_id}
GET /api/v1/statuses?block_id={block_id}

Assets: Return all the assets that match a given text search

• Return all assets that match a given text search. The id of the asset is the same id of the transaction
  that created the asset
  GET /api/v1/assets?search={text_search}

• Return at most n assets that match a given text search
  GET /api/v1/assets?search={text_search}&limit={n_documents}

Blocks

• Get the block with the ID block_id. Any blocks, be they VALID, UNDECIDED or INVALID will be returned
  GET /api/v1/blocks/{block_id}

• Retrieve a list of block_id with their corresponding status that contain a transaction with the ID
  transaction_id
  GET /api/v1/blocks?transaction_id={transaction_id}
GET /api/v1/blocks?transaction_id={transaction_id}&status={UNDECIDED|VALID|INVALID}

Votes

• Retrieve a list of votes for a certain block with ID block_id
  GET /api/v1/votes?block_id={block_id}