Polkadot Assets API

openapi: 3.1.0
info:
  title: Polkadot REST Account Assets 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: Assets
paths:
  /api/scan/assets/account/balances:
    post:
      consumes:
      - application/json
      description: 'Get asset balances by account address

        This API only supports networks with assets frame'
      parameters:
      - description: param
        in: body
        name: param
        required: true
        schema:
          $ref: '#/definitions/internal_plugin_assets_http.assetBalancesParams'
      produces:
      - application/json
      responses:
        '200':
          description: OK
          schema:
            additionalProperties: true
            type: object
      summary: Asset account balances
      tags:
      - Assets
      x-synonyms:
      - asset
      - account
      - balances
      - assets
      - scan
      - wallet
      - address
      - user
  /api/scan/assets/activities:
    post:
      consumes:
      - application/json
      description: 'Get asset activities(include asset Created/Issued/Burned...) by asset id

        This API only supports networks with assets frame'
      parameters:
      - description: param
        in: body
        name: param
        required: true
        schema:
          $ref: '#/definitions/internal_plugin_assets_http.assetActivitiesParams'
      produces:
      - application/json
      responses:
        '200':
          description: OK
          schema:
            additionalProperties: true
            type: object
      summary: Asset activities
      tags:
      - Assets
      x-synonyms:
      - asset
      - activities
      - assets
      - scan
  /api/scan/assets/asset:
    post:
      consumes:
      - application/json
      description: 'Get asset info by asset id

        This API only supports networks with assets frame'
      parameters:
      - description: param
        in: body
        name: param
        required: true
        schema:
          $ref: '#/definitions/internal_plugin_assets_http.assetParam'
      produces:
      - application/json
      responses:
        '200':
          description: OK
          schema:
            additionalProperties: true
            type: object
      summary: Asset info
      tags:
      - Assets
      x-synonyms:
      - asset
      - assets
      - scan
  /api/scan/assets/asset/holders:
    post:
      consumes:
      - application/json
      description: 'Get asset holders by asset id

        This API only supports networks with assets frame'
      parameters:
      - description: param
        in: body
        name: param
        required: true
        schema:
          $ref: '#/definitions/internal_plugin_assets_http.assetHolderParams'
      produces:
      - application/json
      responses:
        '200':
          description: OK
          schema:
            additionalProperties: true
            type: object
      summary: Asset holders
      tags:
      - Assets
      x-synonyms:
      - asset
      - holders
      - assets
      - scan
      - owners
      - token holders
  /api/scan/assets/assets:
    post:
      consumes:
      - application/json
      description: 'Assets token list

        This API only supports networks with assets frame'
      parameters:
      - description: param
        in: body
        name: param
        required: true
        schema:
          $ref: '#/definitions/internal_plugin_assets_http.assetsParam'
      produces:
      - application/json
      responses:
        '200':
          description: OK
          schema:
            properties:
              code:
                type: integer
              data:
                properties:
                  count:
                    type: integer
                  list:
                    items:
                      $ref: '#/definitions/subscan_internal_plugin_assets_db.StateAssetSampleJson'
                    type: array
                type: object
              message:
                type: string
            type: object
      summary: Assets list
      tags:
      - Assets
      x-synonyms:
      - assets
      - scan
definitions:
  subscan_internal_model.AccountParentJson:
    properties:
      address:
        type: string
      display:
        type: string
      identity:
        type: boolean
      sub_symbol:
        type: string
    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
  subscan_internal_model.SampleIdentity:
    properties:
      display:
        type: string
      identity:
        type: boolean
      judgements:
        items:
          $ref: '#/definitions/subscan_internal_model.RegistrationJudgementJson'
        type: array
      parent:
        $ref: '#/definitions/subscan_internal_model.AccountParentJson'
    type: object
  internal_plugin_assets_http.assetHolderParams:
    properties:
      asset_id:
        type: string
      page:
        minimum: 0
        type: integer
      row:
        maximum: 100
        minimum: 1
        type: integer
    type: object
  internal_plugin_assets_http.assetsParam:
    properties:
      asset_id:
        type: string
      order:
        enum:
        - asc
        - desc
        type: string
      order_field:
        enum:
        - asset_id
        - symbol
        - holders
        type: string
      page:
        minimum: 0
        type: integer
      row:
        maximum: 100
        minimum: 1
        type: integer
      search:
        description: assets symbol or name
        maxLength: 256
        minLength: 1
        type: string
    type: object
  subscan_internal_plugin_assets_db.Metadata:
    properties:
      decimals:
        type: integer
      deposit:
        type: string
      name:
        type: string
      symbol:
        type: string
    type: object
  subscan_internal_plugin_assets_db.StateAssetSampleJson:
    properties:
      asset_id:
        type: string
      holders:
        type: integer
      issuer:
        $ref: '#/definitions/subscan_internal_model.AccountDisplay'
      market_cap:
        type: string
      metadata:
        $ref: '#/definitions/subscan_internal_plugin_assets_db.Metadata'
      owner:
        $ref: '#/definitions/subscan_internal_model.AccountDisplay'
      price:
        type: string
      supply:
        type: string
      transfer_count:
        type: integer
      unique_id:
        type: string
    type: object
  internal_plugin_assets_http.assetParam:
    properties:
      asset_id:
        type: string
    type: object
  subscan_internal_model.EvmAccountDisplay:
    properties:
      contract_name:
        type: string
      verify_source:
        type: string
    type: object
  internal_plugin_assets_http.assetBalancesParams:
    properties:
      address:
        type: string
    required:
    - address
    type: object
  subscan_internal_model.RegistrationJudgementJson:
    properties:
      index:
        type: integer
      judgement:
        type: string
    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: '#/definitions/subscan_internal_model.EvmAccountDisplay'
      identity:
        type: boolean
      judgements:
        items:
          $ref: '#/definitions/subscan_internal_model.RegistrationJudgementJson'
        type: array
      merkle:
        $ref: '#/definitions/subscan_internal_model.MerkleTag'
      parent:
        allOf:
        - $ref: '#/definitions/subscan_internal_model.AccountParentJson'
        description: Parent account
      people:
        $ref: '#/definitions/subscan_internal_model.SampleIdentity'
    type: object
  internal_plugin_assets_http.assetActivitiesParams:
    properties:
      asset_id:
        type: string
      page:
        minimum: 0
        type: integer
      row:
        maximum: 100
        minimum: 1
        type: integer
    type: object