Polkadot capabilities API

API capabilities and chain pallets

OpenAPI Specification

polkadot-capabilities-api-openapi.yml Raw ↑
openapi: 3.1.0
info:
  title: Polkadot REST Account capabilities API
  description: High-performance Rust REST API for Substrate/Polkadot blockchain data. Drop-in replacement for substrate-api-sidecar.
  contact:
    url: https://github.com/paritytech/polkadot-rest-api
  license:
    name: GPL-3.0-or-later
  version: 0.1.3
servers:
- url: http://localhost:8080/v1
  description: Localhost
tags:
- name: capabilities
  description: API capabilities and chain pallets
paths:
  /v1/capabilities:
    get:
      tags:
      - capabilities
      summary: API capabilities
      description: Returns the chain name and list of available pallets in the runtime metadata.
      operationId: get_capabilities
      parameters:
      - name: at
        in: query
        description: Block hash or number to query at
        required: false
        schema:
          type: string
      responses:
        '200':
          description: Chain capabilities
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CapabilitiesResponse'
        '400':
          description: Invalid block parameter
        '500':
          description: Internal server error
        '503':
          description: Service unavailable
components:
  schemas:
    CapabilitiesResponse:
      type: object
      required:
      - chain
      - pallets
      properties:
        chain:
          type: string
        pallets:
          type: array
          items:
            type: string