Polkadot ahm API

Asset Hub Migration information

OpenAPI Specification

polkadot-ahm-api-openapi.yml Raw ↑
openapi: 3.1.0
info:
  title: Polkadot REST Account ahm 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: ahm
  description: Asset Hub Migration information
paths:
  /v1/ahm-info:
    get:
      tags:
      - ahm
      summary: Asset Hub Migration info
      description: Returns information about the Asset Hub migration, including start and end blocks for both relay chain and Asset Hub.
      operationId: ahm_info
      responses:
        '200':
          description: AHM migration boundaries
          content:
            application/json:
              schema:
                type: object
        '404':
          description: No migration data available
  /ahm-info:
    get:
      tags:
      - ahm
      summary: Get Asset Hub Migration information.
      description: Returns information about Asset Hub Migration (AHM) including migration start and end blocks for both relay chain and Asset Hub. The endpoint automatically detects whether you're connected to a relay chain or Asset Hub and provides relevant migration data. Returns static migration boundaries for known networks or queries on-chain migration pallets for dynamic information.
      operationId: getAhmInfo
      responses:
        '200':
          description: Successfully retrieved Asset Hub Migration information
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AhmInfo'
        '400':
          description: Invalid chain specName or missing migration pallets
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
components:
  schemas:
    AhmInfo:
      type: object
      description: Asset Hub Migration information including migration boundaries for both relay chain and Asset Hub.
      properties:
        relay:
          type: object
          description: Relay chain migration information
          properties:
            startBlock:
              type: integer
              nullable: true
              description: Block number when relay chain migration started, or null if not available
              format: unsignedInteger
            endBlock:
              type: integer
              nullable: true
              description: Block number when relay chain migration ended, or null if not available
              format: unsignedInteger
        assetHub:
          type: object
          description: Asset Hub migration information
          properties:
            startBlock:
              type: integer
              nullable: true
              description: Block number when Asset Hub migration started, or null if not available
              format: unsignedInteger
            endBlock:
              type: integer
              nullable: true
              description: Block number when Asset Hub migration ended, or null if not available
              format: unsignedInteger
      example:
        relay:
          startBlock: 26041702
          endBlock: 26071771
        assetHub:
          startBlock: 11716733
          endBlock: 11736597
    Error:
      type: object
      properties:
        code:
          type: number
        message:
          type: string
        stack:
          type: string
        level:
          type: string