Polkadot

Polkadot Collator API

The Collator API from Polkadot — 4 operation(s) for collator.

GitHub OpenAPI

Operations 4

POST /api/scan/collator/info Get collator details #
POST /api/scan/collator/list List collators #
GET /api/scan/collator/meta Get collator metadata #
POST /api/scan/collator/timeline List collator timeline records #

Documentation

📖
Documentation
https://support.subscan.io/
📖
RateLimits
https://raw.githubusercontent.com/api-evangelist/polkadot/refs/heads/main/rate-limits/subscan.yml
📖
Documentation
https://docs.polkadot.com/chain-interactions/query-data/query-rest/
📖
Documentation
https://github.com/paritytech/polkadot-rest-api

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/polkadot/refs/heads/main/openapi/polkadot-collator-api-openapi.yml

SDKs

📦
GitHubRepository
https://github.com/paritytech/substrate-api-sidecar
📦
GitHubRepository
https://github.com/paritytech/polkadot-rest-api

Other Resources

🔗
PostmanCollection
https://documenter.getpostman.com/view/1618960/TVCe1oRU
🔗
Plans
https://raw.githubusercontent.com/api-evangelist/polkadot/refs/heads/main/plans/subscan.yml
🔗
FinOps
https://raw.githubusercontent.com/api-evangelist/polkadot/refs/heads/main/finops/subscan.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/polkadot-collator-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

polkadot-collator-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  contact:
    email: bruce.sun@itering.io
    name: API Support
    url: http://www.swagger.io/support
  description: This is a subscan API server.
  license:
    name: Apache 2.0
    url: http://www.apache.org/licenses/LICENSE-2.0.html
  termsOfService: http://swagger.io/terms/
  title: Subscan Collator API
  version: '1.0'
servers:
- url: https://https://www.subscan.io/
tags:
- name: Collator
paths:
  /api/scan/collator/info:
    post:
      description: Returns detailed information for a single collator account.
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                properties:
                  code:
                    type: integer
                  data:
                    $ref: '#/components/schemas/internal_pluginv2_pallets_collator.CollatorJson'
                  message:
                    type: string
                type: object
      summary: Get collator details
      tags:
      - Collator
      x-synonyms:
      - collator
      - scan
      - block producer
      - validator
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/internal_pluginv2_pallets_collator.collatorInfoParams'
        description: params
        required: true
      operationId: postApiScanCollatorInfo
      x-operation-id-source: derived
  /api/scan/collator/list:
    post:
      description: Returns a paginated list of collators with status, account, and ordering filters.
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                properties:
                  code:
                    type: integer
                  data:
                    properties:
                      count:
                        type: integer
                      list:
                        items:
                          $ref: '#/components/schemas/internal_pluginv2_pallets_collator.CollatorJson'
                        type: array
                    type: object
                  message:
                    type: string
                type: object
      summary: List collators
      tags:
      - Collator
      x-synonyms:
      - collators
      - collator
      - scan
      - block producer
      - validator
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/internal_pluginv2_pallets_collator.collatorListParams'
        description: params
        required: true
      operationId: postApiScanCollatorList
      x-operation-id-source: derived
  /api/scan/collator/meta:
    get:
      description: Returns collator metadata used by the collator APIs.
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                properties:
                  code:
                    type: integer
                  data:
                    $ref: '#/components/schemas/internal_pluginv2_pallets_collator.MetadataJson'
                  message:
                    type: string
                type: object
      summary: Get collator metadata
      tags:
      - Collator
      x-synonyms:
      - collator
      - metadata
      - scan
      - meta
      - block producer
      - validator
      - chain info
      operationId: getApiScanCollatorMeta
      x-operation-id-source: derived
  /api/scan/collator/timeline:
    post:
      description: Returns paginated timeline records for a collator.
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                properties:
                  code:
                    type: integer
                  data:
                    properties:
                      count:
                        type: integer
                      list:
                        items:
                          $ref: '#/components/schemas/internal_pluginv2_pallets_collator.CollatorTimelineJson'
                        type: array
                    type: object
                  message:
                    type: string
                type: object
      summary: List collator timeline records
      tags:
      - Collator
      x-synonyms:
      - collator
      - timeline
      - records
      - scan
      - block producer
      - validator
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/internal_pluginv2_pallets_collator.collatorTimelineParams'
        description: params
        required: true
      operationId: postApiScanCollatorTimeline
      x-operation-id-source: derived
components:
  schemas:
    internal_pluginv2_pallets_collator.MetadataJson:
      properties:
        candidacy_bond:
          type: string
        candidates:
          type: integer
        candidates_total_bond:
          type: string
        desired_candidates:
          type: integer
        invulnerables:
          type: integer
      type: object
    subscan_internal_dao.CollatorStatus:
      enum:
      - 1
      - 2
      - 3
      type: integer
      x-enum-varnames:
      - CollatorInvulnerable
      - CollatorCandidate
      - CollatorRetired
    subscan_internal_model.AccountParentJson:
      properties:
        address:
          type: string
        display:
          type: string
        identity:
          type: boolean
        sub_symbol:
          type: string
      type: object
    internal_pluginv2_pallets_collator.collatorTimelineParams:
      properties:
        account:
          type: string
        page:
          minimum: 0
          type: integer
        row:
          maximum: 100
          minimum: 1
          type: integer
      type: object
    internal_pluginv2_pallets_collator.collatorListParams:
      properties:
        account:
          type: string
        order:
          enum:
          - desc
          - asc
          type: string
        order_field:
          enum:
          - account
          - bond
          - last_change_block
          - last_authored_block
          type: string
        page:
          minimum: 0
          type: integer
        row:
          maximum: 100
          minimum: 1
          type: integer
        status:
          allOf:
          - $ref: '#/components/schemas/subscan_internal_dao.CollatorStatus'
          enum:
          - 0
          - 1
          - 2
      type: object
    subscan_internal_model.MerkleTag:
      properties:
        address_type:
          type: string
        tag_name:
          type: string
        tag_subtype:
          type: string
        tag_type:
          type: string
      type: object
    internal_pluginv2_pallets_collator.collatorInfoParams:
      properties:
        account:
          type: string
      required:
      - account
      type: object
    subscan_internal_model.AccountDisplay:
      properties:
        account_index:
          type: string
        address:
          description: Current network account
          type: string
        display:
          type: string
        evm_address:
          type: string
        evm_contract:
          $ref: '#/components/schemas/subscan_internal_model.EvmAccountDisplay'
        identity:
          type: boolean
        judgements:
          items:
            $ref: '#/components/schemas/subscan_internal_model.RegistrationJudgementJson'
          type: array
        merkle:
          $ref: '#/components/schemas/subscan_internal_model.MerkleTag'
        parent:
          allOf:
          - $ref: '#/components/schemas/subscan_internal_model.AccountParentJson'
          description: Parent account
        people:
          $ref: '#/components/schemas/subscan_internal_model.SampleIdentity'
      type: object
    internal_pluginv2_pallets_collator.CollatorJson:
      properties:
        account_display:
          $ref: '#/components/schemas/subscan_internal_model.AccountDisplay'
        balance:
          type: string
        bond:
          type: string
        last_authored_block:
          description: LastChangeBlock   int                   `json:"last_change_block"`
          type: integer
        status:
          $ref: '#/components/schemas/subscan_internal_dao.CollatorStatus'
      type: object
    internal_pluginv2_pallets_collator.CollatorTimelineJson:
      properties:
        account:
          $ref: '#/components/schemas/subscan_internal_model.AccountDisplay'
        action:
          type: string
        block_num:
          type: integer
        event_index:
          type: string
      type: object
    subscan_internal_model.EvmAccountDisplay:
      properties:
        contract_name:
          type: string
        verify_source:
          type: string
      type: object
    subscan_internal_model.RegistrationJudgementJson:
      properties:
        index:
          type: integer
        judgement:
          type: string
      type: object
    subscan_internal_model.SampleIdentity:
      properties:
        display:
          type: string
        identity:
          type: boolean
        judgements:
          items:
            $ref: '#/components/schemas/subscan_internal_model.RegistrationJudgementJson'
          type: array
        parent:
          $ref: '#/components/schemas/subscan_internal_model.AccountParentJson'
      type: object