openapi: 3.0.3
info:
  title: BigchainDB HTTP Assets 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: Assets
  description: Full-text search over asset payloads.
paths:
  /api/v1/assets:
    get:
      tags:
      - Assets
      operationId: searchAssets
      summary: Search assets
      description: Full-text search over the data payloads of CREATE-transaction assets.
      parameters:
      - name: search
        in: query
        required: true
        description: The text to search for in asset payloads.
        schema:
          type: string
      - name: limit
        in: query
        required: false
        description: Maximum number of results to return.
        schema:
          type: integer
      responses:
        '200':
          description: A list of matching assets.
        '400':
          description: The search 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