THORChain Supply API
The Supply API from THORChain — 2 operation(s) for supply.
OpenAPI Specification
openapi: 3.0.0
info:
title: Thornode Auth Supply API
version: 3.19.1
contact:
email: devs@thorchain.org
description: Thornode REST API.
tags:
- name: Supply
paths:
/thorchain/supply:
parameters:
- $ref: '#/components/parameters/queryHeight'
get:
description: Returns the RUNE supply breakdown.
operationId: supply
tags:
- Supply
responses:
200:
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/SupplyResponse'
/thorchain/supply/cmc:
parameters:
- name: asset
in: query
required: false
schema:
type: string
enum:
- rune
- tcy
description: The asset to query supply for (default rune).
- name: type
in: query
required: true
schema:
type: string
enum:
- circulating
- total
- locked
- staked
description: The type of supply value to return.
get:
description: Returns a single supply value as plain text for CoinMarketCap integration.
operationId: supply_cmc
tags:
- Supply
responses:
200:
description: OK
content:
text/plain:
schema:
type: integer
example: 30000000000
components:
parameters:
queryHeight:
name: height
in: query
description: optional block height, defaults to current tip
required: false
schema:
type: integer
format: int64
minimum: 0
schemas:
SupplyResponse:
type: object
required:
- circulating
- total
properties:
circulating:
type: integer
format: int64
description: circulating RUNE supply
example: 30000000000
locked:
$ref: '#/components/schemas/LockedSupply'
total:
type: integer
format: int64
description: total RUNE supply
example: 50000000000
LockedSupply:
type: object
properties:
reserve:
type: integer
format: int64
description: RUNE locked in the reserve module
example: 10000000000