Polkadot Vesting API

The Vesting API from Polkadot — 1 operation(s) for vesting.

OpenAPI Specification

polkadot-vesting-api-openapi.yml Raw ↑
openapi: 3.1.0
info:
  title: Polkadot REST Account Vesting 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: Vesting
paths:
  /api/scan/vesting_release:
    post:
      consumes:
      - application/json
      description: Returns vesting release records for the requested date range. This endpoint is available only on networks that support the vesting frame.
      parameters:
      - description: params
        in: body
        name: params
        required: true
        schema:
          $ref: '#/definitions/internal_server_http.vestingReleaseParams'
      produces:
      - application/json
      responses:
        '200':
          description: OK
          schema:
            allOf:
            - $ref: '#/definitions/internal_server_http.J'
            - properties:
                data:
                  properties:
                    list:
                      items:
                        $ref: '#/definitions/subscan_internal_model.VestingRelease'
                      type: array
                  type: object
              type: object
      summary: List vesting release records
      tags:
      - Vesting
      x-synonyms:
      - vesting
      - release
      - scan
      - lockup
      - unlock schedule
definitions:
  subscan_internal_model.VestingRelease:
    properties:
      amount:
        type: string
      block_num:
        type: integer
      day:
        type: string
    type: object
  internal_server_http.J:
    properties:
      code:
        example: 0
        type: integer
      data: {}
      generated_at:
        example: 1699600641
        type: integer
      message:
        example: Success
        type: string
    type: object
  internal_server_http.vestingReleaseParams:
    properties:
      end:
        example: '2023-06-01'
        type: string
      start:
        example: '2023-05-01'
        type: string
    required:
    - end
    - start
    type: object