openapi: 3.0.3
info:
  title: BigchainDB HTTP Assets Blocks API
  version: v1
  description: The BigchainDB HTTP Client-Server API. BigchainDB is an open-source blockchain database that combines high throughput, low latency, immutable data storage and built-in asset support with decentralized control. This document is a faithful transcription of the operations, parameters and status codes published in the official BigchainDB Server HTTP API reference; BigchainDB does not publish its own machine-readable OpenAPI, so this spec was generated by the API Evangelist enrichment pipeline from the documented endpoint reference.
  x-apievangelist-generated: true
  x-source: https://docs.bigchaindb.com/projects/server/en/latest/http-client-server-api.html
  license:
    name: Apache-2.0
    url: https://www.apache.org/licenses/LICENSE-2.0
  contact:
    name: BigchainDB GmbH
    url: https://www.bigchaindb.com/
servers:
- url: https://{host}:9984
  description: A BigchainDB node (self-hosted or hosted network). Default node port is 9984.
  variables:
    host:
      default: test.ipdb.io
      description: Hostname of a BigchainDB node (the IPDB test network historically ran at test.ipdb.io).
tags:
- name: Blocks
  description: Read blocks by height or by contained transaction.
paths:
  /api/v1/blocks/{block_height}:
    get:
      tags:
      - Blocks
      operationId: getBlock
      summary: Get a block by height
      description: Retrieve the block at the given height, including the list of transaction ids it contains.
      parameters:
      - name: block_height
        in: path
        required: true
        description: The height of the block to retrieve.
        schema:
          type: integer
      responses:
        '200':
          description: The requested block.
        '404':
          description: No block exists at that height.
  /api/v1/blocks:
    get:
      tags:
      - Blocks
      operationId: listBlocks
      summary: List blocks containing a transaction
      description: Get the heights of the blocks that contain the transaction with the given transaction_id.
      parameters:
      - name: transaction_id
        in: query
        required: true
        description: The transaction id to look up.
        schema:
          type: string
      responses:
        '200':
          description: A list of block heights containing the transaction.
        '400':
          description: The transaction_id parameter was missing.
externalDocs:
  description: BigchainDB Server HTTP Client-Server API
  url: https://docs.bigchaindb.com/projects/server/en/latest/http-client-server-api.html