{
"paths": {
"/api/v3/avg-icp-xdr-conversion-rates": {
"get": {
"parameters": [
{
"in": "query",
"name": "end",
"required": false,
"description": "End Timestamp",
"schema": {
"type": "integer",
"default": null,
"nullable": true
}
},
{
"in": "query",
"name": "format",
"required": false,
"schema": {
"type": "string",
"default": "json",
"enum": [
"json",
"csv"
]
}
},
{
"in": "query",
"name": "start",
"required": false,
"description": "Start Timestamp",
"schema": {
"type": "integer",
"default": null,
"nullable": true
}
},
{
"in": "query",
"name": "step",
"required": false,
"description": "Step value",
"schema": {
"type": "number",
"default": 86400.0
}
}
],
"responses": {
"422": {
"$ref": "#/components/responses/UNPROCESSABLE_ENTITY"
},
"default": {
"$ref": "#/components/responses/DEFAULT_ERROR"
}
},
"tags": [
"avg_icp_xdr_conversion_rates"
]
}
},
"/api/v3/bitcoin/main-chain-height": {
"get": {
"parameters": [
{
"in": "query",
"name": "start",
"required": false,
"description": "Start Timestamp",
"schema": {
"type": "number",
"default": null,
"nullable": true
}
},
{
"in": "query",
"name": "end",
"required": false,
"description": "End Timestamp",
"schema": {
"type": "number",
"default": null,
"nullable": true
}
},
{
"in": "query",
"name": "format",
"required": false,
"schema": {
"type": "string",
"default": "json",
"enum": [
"json",
"csv"
]
}
},
{
"in": "query",
"name": "step",
"required": false,
"description": "Float Step value",
"schema": {
"type": "number",
"default": 7200.0,
"minimum": 1,
"maximum": 259200
}
},
{
"in": "query",
"name": "network",
"required": false,
"description": "Network",
"schema": {
"type": "string",
"default": "mainnet",
"enum": [
"mainnet",
"testnet"
]
}
}
],
"responses": {
"422": {
"$ref": "#/components/responses/UNPROCESSABLE_ENTITY"
},
"default": {
"$ref": "#/components/responses/DEFAULT_ERROR"
}
},
"tags": [
"bitcoin"
]
}
},
"/api/v3/bitcoin/number-of-utxos": {
"get": {
"parameters": [
{
"in": "query",
"name": "start",
"required": false,
"description": "Start Timestamp",
"schema": {
"type": "number",
"default": null,
"nullable": true
}
},
{
"in": "query",
"name": "end",
"required": false,
"description": "End Timestamp",
"schema": {
"type": "number",
"default": null,
"nullable": true
}
},
{
"in": "query",
"name": "format",
"required": false,
"schema": {
"type": "string",
"default": "json",
"enum": [
"json",
"csv"
]
}
},
{
"in": "query",
"name": "step",
"required": false,
"description": "Float Step value",
"schema": {
"type": "number",
"default": 7200.0,
"minimum": 1,
"maximum": 259200
}
},
{
"in": "query",
"name": "network",
"required": false,
"description": "Network",
"schema": {
"type": "string",
"default": "mainnet",
"enum": [
"mainnet",
"testnet"
]
}
}
],
"responses": {
"422": {
"$ref": "#/components/responses/UNPROCESSABLE_ENTITY"
},
"default": {
"$ref": "#/components/responses/DEFAULT_ERROR"
}
},
"tags": [
"bitcoin"
]
}
},
"/api/v3/bitcoin/stable-memory-size-in-bytes": {
"get": {
"parameters": [
{
"in": "query",
"name": "start",
"required": false,
"description": "Start Timestamp",
"schema": {
"type": "number",
"default": null,
"nullable": true
}
},
{
"in": "query",
"name": "end",
"required": false,
"description": "End Timestamp",
"schema": {
"type": "number",
"default": null,
"nullable": true
}
},
{
"in": "query",
"name": "format",
"required": false,
"schema": {
"type": "string",
"default": "json",
"enum": [
"json",
"csv"
]
}
},
{
"in": "query",
"name": "step",
"required": false,
"description": "Float Step value",
"schema": {
"type": "number",
"default": 7200.0,
"minimum": 1,
"maximum": 259200
}
},
{
"in": "query",
"name": "network",
"required": false,
"description": "Network",
"schema": {
"type": "string",
"default": "mainnet",
"enum": [
"mainnet",
"testnet"
]
}
}
],
"responses": {
"422": {
"$ref": "#/components/responses/UNPROCESSABLE_ENTITY"
},
"default": {
"$ref": "#/components/responses/DEFAULT_ERROR"
}
},
"tags": [
"bitcoin"
]
}
},
"/api/v3/block-heights": {
"get": {
"parameters": [
{
"in": "query",
"name": "subnet",
"required": false,
"description": "Subnet ID",
"schema": {
"type": "string",
"default": null,
"nullable": true,
"pattern": "^([a-zA-Z0-9]{5}-){10}[a-zA-Z0-9]{3}$"
}
}
],
"responses": {
"422": {
"$ref": "#/components/responses/UNPROCESSABLE_ENTITY"
},
"default": {
"$ref": "#/components/responses/DEFAULT_ERROR"
}
},
"tags": [
"block_heights"
]
}
},
"/api/v3/block-heights-over-time": {
"get": {
"parameters": [
{
"in": "query",
"name": "subnet",
"required": false,
"description": "Subnet ID",
"schema": {
"type": "string",
"default": null,
"nullable": true,
"pattern": "^([a-zA-Z0-9]{5}-){10}[a-zA-Z0-9]{3}$"
}
},
{
"in": "query",
"name": "end",
"required": false,
"description": "End Timestamp",
"schema": {
"type": "number",
"default": null,
"nullable": true
}
},
{
"in": "query",
"name": "start",
"required": true,
"description": "Start Timestamp",
"schema": {
"type": "number"
}
},
{
"in": "query",
"name": "step",
"required": false,
"description": "Step value",
"schema": {
"type": "integer",
"default": 7200,
"minimum": 1,
"maximum": 259200
}
}
],
"responses": {
"422": {
"$ref": "#/components/responses/UNPROCESSABLE_ENTITY"
},
"default": {
"$ref": "#/components/responses/DEFAULT_ERROR"
}
},
"tags": [
"block_heights_over_time"
]
}
},
"/api/v3/boundary-node-locations": {
"get": {
"parameters": [
{
"in": "query",
"name": "format",
"required": false,
"schema": {
"type": "string",
"default": "json",
"enum": [
"json",
"csv"
]
}
}
],
"responses": {
"422": {
"$ref": "#/components/responses/UNPROCESSABLE_ENTITY"
},
"default": {
"$ref": "#/components/responses/DEFAULT_ERROR"
}
},
"tags": [
"boundary-node-locations"
]
}
},
"/api/v3/canisters": {
"get": {
"parameters": [
{
"in": "query",
"name": "max_canister_index",
"required": false,
"schema": {
"type": "integer",
"default": null,
"nullable": true,
"minimum": 0
}
},
{
"in": "query",
"name": "limit",
"required": false,
"schema": {
"type": "integer",
"default": 50,
"minimum": 0,
"maximum": 100
}
},
{
"in": "query",
"name": "controller_id",
"required": false,
"description": "Controller ID",
"schema": {
"type": "string",
"default": null,
"nullable": true,
"pattern": "^([a-zA-Z0-9]{5}-){4}(([a-zA-Z0-9]{5}-){6})?[a-zA-Z0-9]{3}$"
}
},
{
"in": "query",
"name": "offset",
"required": false,
"schema": {
"type": "integer",
"default": 0,
"minimum": 0
}
},
{
"in": "query",
"name": "sort_by",
"required": false,
"description": "Available values : id, canister_id, controllers, subnet_id",
"schema": {
"default": "canister_id"
}
},
{
"in": "query",
"name": "format",
"required": false,
"schema": {
"type": "string",
"default": "json",
"enum": [
"json",
"csv"
]
}
},
{
"in": "query",
"name": "subnet_id",
"required": false,
"description": "Subnet ID",
"schema": {
"type": "string",
"default": null,
"nullable": true,
"pattern": "^([a-zA-Z0-9]{5}-){10}[a-zA-Z0-9]{3}$"
}
}
],
"responses": {
"422": {
"$ref": "#/components/responses/UNPROCESSABLE_ENTITY"
},
"default": {
"$ref": "#/components/responses/DEFAULT_ERROR"
}
},
"tags": [
"canisters"
]
}
},
"/api/v3/canisters/{canister_id}": {
"get": {
"parameters": [
{
"in": "path",
"name": "canister_id",
"required": true,
"description": "Canister ID",
"schema": {
"type": "string",
"pattern": "^([a-zA-Z0-9]{5}-){4}[a-zA-Z0-9]{3}$"
}
}
],
"responses": {
"422": {
"$ref": "#/components/responses/UNPROCESSABLE_ENTITY"
},
"default": {
"$ref": "#/components/responses/DEFAULT_ERROR"
}
},
"tags": [
"canisters"
]
},
"parameters": [
{
"in": "path",
"name": "canister_id",
"required": true,
"schema": {
"type": "string",
"minLength": 1
}
}
]
},
"/api/v3/canisters/{canister_id}/name": {
"get": {
"parameters": [
{
"in": "path",
"name": "canister_id",
"required": true,
"description": "Canister ID",
"schema": {
"type": "string",
"pattern": "^([a-zA-Z0-9]{5}-){4}[a-zA-Z0-9]{3}$"
}
}
],
"responses": {
"422": {
"$ref": "#/components/responses/UNPROCESSABLE_ENTITY"
},
"default": {
"$ref": "#/components/responses/DEFAULT_ERROR"
}
},
"tags": [
"canisters"
]
},
"parameters": [
{
"in": "path",
"name": "canister_id",
"required": true,
"schema": {
"type": "string",
"minLength": 1
}
}
]
},
"/api/v3/canisters-names": {
"get": {
"parameters": [
{
"in": "query",
"name": "canister_ids",
"required": false,
"explode": true,
"style": "form",
"description": "Canister IDs",
"schema": {
"type": "array",
"default": [],
"items": {
"type": "string",
"pattern": "^([a-zA-Z0-9]{5}-){4}[a-zA-Z0-9]{3}$"
}
}
}
],
"responses": {
"422": {
"$ref": "#/components/responses/UNPROCESSABLE_ENTITY"
},
"default": {
"$ref": "#/components/responses/DEFAULT_ERROR"
}
},
"tags": [
"canisters"
]
}
},
"/api/v3/data-centers": {
"get": {
"parameters": [
{
"in": "query",
"name": "subnet",
"required": false,
"description": "Subnet ID",
"schema": {
"type": "string",
"default": null,
"nullable": true,
"pattern": "^([a-zA-Z0-9]{5}-){10}[a-zA-Z0-9]{3}$"
}
},
{
"in": "query",
"name": "format",
"required": false,
"schema": {
"type": "string",
"default": "json",
"enum": [
"json",
"csv"
]
}
},
{
"in": "query",
"name": "include_node_type",
"required": false,
"explode": true,
"style": "form",
"description": "Node Types",
"schema": {
"type": "array",
"default": [],
"items": {
"type": "string",
"enum": [
"API_BOUNDARY",
"REPLICA"
]
}
}
}
],
"responses": {
"422": {
"$ref": "#/components/responses/UNPROCESSABLE_ENTITY"
},
"default": {
"$ref": "#/components/responses/DEFAULT_ERROR"
}
},
"tags": [
"data_centers"
]
}
},
"/api/v3/data-centers/{dc_id}": {
"get": {
"parameters": [
{
"in": "query",
"name": "subnet",
"required": false,
"description": "Subnet ID",
"schema": {
"type": "string",
"default": null,
"nullable": true,
"pattern": "^([a-zA-Z0-9]{5}-){10}[a-zA-Z0-9]{3}$"
}
},
{
"in": "query",
"name": "format",
"required": false,
"schema": {
"type": "string",
"default": "json",
"enum": [
"json",
"csv"
]
}
},
{
"in": "query",
"name": "include_node_type",
"required": false,
"explode": true,
"style": "form",
"description": "Node Types",
"schema": {
"type": "array",
"default": [],
"items": {
"type": "string",
"enum": [
"API_BOUNDARY",
"REPLICA"
]
}
}
}
],
"responses": {
"422": {
"$ref": "#/components/responses/UNPROCESSABLE_ENTITY"
},
"default": {
"$ref": "#/components/responses/DEFAULT_ERROR"
}
},
"tags": [
"data_centers"
]
},
"parameters": [
{
"in": "path",
"name": "dc_id",
"required": true,
"schema": {
"type": "string",
"minLength": 1
}
}
]
},
"/api/v3/daily-stats": {
"get": {
"parameters": [
{
"in": "query",
"name": "end",
"required": false,
"description": "End Timestamp",
"schema": {
"type": "integer",
"default": null,
"nullable": true,
"minimum": 1620406800
}
},
{
"in": "query",
"name": "format",
"required": false,
"schema": {
"type": "string",
"default": "json",
"enum": [
"json",
"csv"
]
}
},
{
"in": "query",
"name": "start",
"required": false,
"description": "Start Timestamp",
"schema": {
"type": "integer",
"default": null,
"nullable": true,
"minimum": 1620406800
}
}
],
"responses": {
"422": {
"$ref": "#/components/responses/UNPROCESSABLE_ENTITY"
},
"default": {
"$ref": "#/components/responses/DEFAULT_ERROR"
}
},
"tags": [
"daily_stats"
]
}
},
"/api/v3/daily-stats/max-total-transactions-per-sec-till-date": {
"get": {
"parameters": [
{
"in": "query",
"name": "end",
"required": false,
"description": "End Timestamp",
"schema": {
"type": "integer",
"default": null,
"nullable": true,
"minimum": 1620406800
}
},
{
"in": "query",
"name": "format",
"required": false,
"schema": {
"type": "string",
"default": "json",
"enum": [
"json",
"csv"
]
}
},
{
"in": "query",
"name": "start",
"required": false,
"description": "Start Timestamp",
"schema": {
"type": "integer",
"default": null,
"nullable": true,
"minimum": 1620406800
}
}
],
"responses": {
"422": {
"$ref": "#/components/responses/UNPROCESSABLE_ENTITY"
},
"default": {
"$ref": "#/components/responses/DEFAULT_ERROR"
}
},
"tags": [
"daily_stats"
]
}
},
"/api/v3/daily-stats/max-update-transactions-per-sec-till-date": {
"get": {
"parameters": [
{
"in": "query",
"name": "end",
"required": false,
"description": "End Timestamp",
"schema": {
"type": "integer",
"default": null,
"nullable": true,
"minimum": 1620406800
}
},
{
"in": "query",
"name": "format",
"required": false,
"schema": {
"type": "string",
"default": "json",
"enum": [
"json",
"csv"
]
}
},
{
"in": "query",
"name": "start",
"required": false,
"description": "Start Timestamp",
"schema": {
"type": "integer",
"default": null,
"nullable": true,
"minimum": 1620406800
}
}
],
"responses": {
"422": {
"$ref": "#/components/responses/UNPROCESSABLE_ENTITY"
},
"default": {
"$ref": "#/components/responses/DEFAULT_ERROR"
}
},
"tags": [
"daily_stats"
]
}
},
"/api/v3/daily-stats/max-query-transactions-per-sec-till-date": {
"get": {
"parameters": [
{
"in": "query",
"name": "end",
"required": false,
"description": "End Timestamp",
"schema": {
"type": "integer",
"default": null,
"nullable": true,
"minimum": 1620406800
}
},
{
"in": "query",
"name": "format",
"required": false,
"schema": {
"type": "string",
"default": "json",
"enum": [
"json",
"csv"
]
}
},
{
"in": "query",
"name": "start",
"required": false,
"description": "Start Timestamp",
"schema": {
"type": "integer",
"default": null,
"nullable": true,
"minimum": 1620406800
}
}
],
"responses": {
"422": {
"$ref": "#/components/responses/UNPROCESSABLE_ENTITY"
},
"default": {
"$ref": "#/components/responses/DEFAULT_ERROR"
}
},
"tags": [
"daily_stats"
]
}
},
"/api/v3/governance-metrics": {
"get": {
"responses": {
"default": {
"$ref": "#/components/responses/DEFAULT_ERROR"
}
},
"tags": [
"governance_metrics"
]
}
},
"/api/v3/staking-metrics": {
"get": {
"responses": {
"default": {
"$ref": "#/components/responses/DEFAULT_ERROR"
}
},
"tags": [
"governance_metrics"
],
"deprecated": true
}
},
"/api/v3/governance-metrics/{name}": {
"get": {
"parameters": [
{
"in": "query",
"name": "end",
"required": false,
"description": "End Timestamp",
"schema": {
"type": "number",
"default": null,
"nullable": true
}
},
{
"in": "query",
"name": "start",
"required": false,
"description": "Start Timestamp",
"schema": {
"type": "number",
"default": null,
"nullable": true
}
},
{
"in": "path",
"name": "name",
"required": true,
"description": "Metric Name",
"schema": {
"type": "string",
"enum": [
"governance_community_fund_total_maturity_e8s_equivalent",
"governance_community_fund_total_staked_e8s",
"governance_dissolved_neurons_count",
"governance_dissolved_neurons_e8s",
"governance_dissolving_neurons_count",
"governance_dissolving_neurons_e8s",
"governance_dissolving_neurons_staked_maturity_e8s_equivalent",
"governance_garbage_collectable_neurons_count",
"governance_last_rewards_event_e8s",
"governance_latest_gc_timestamp_seconds",
"governance_latest_reward_event_rounds_since_last_distribution",
"governance_latest_reward_event_timestamp_seconds",
"governance_latest_reward_event_total_available_e8s",
"governance_latest_reward_round_total_available_e8s",
"governance_locked_neurons_total",
"governance_neurons_total",
"governance_neurons_with_invalid_stake_count",
"governance_neurons_with_less_than_6_months_dissolve_delay_count",
"governance_neurons_with_less_than_6_months_dissolve_delay_e8s",
"governance_not_dissolving_neurons_count",
"governance_not_dissolving_neurons_e8s",
"governance_not_dissolving_neurons_staked_maturity_e8s_equivalent",
"governance_proposals_total",
"governance_ready_to_be_settled_proposals_total",
"governance_seconds_since_latest_reward_event",
"governance_stable_memory_size_bytes",
"governance_total_locked_e8s",
"governance_total_maturity_e8s_equivalent",
"governance_total_memory_size_bytes",
"governance_total_staked_e8s",
"governance_total_staked_maturity_e8s_equivalent",
"governance_total_supply_icp",
"governance_voting_power_total"
]
}
}
],
"responses": {
"422": {
"$ref": "#/components/responses/UNPROCESSABLE_ENTITY"
},
"default": {
"$ref": "#/components/responses/DEFAULT_ERROR"
}
},
"tags": [
"governance_metrics"
]
},
"parameters": [
{
"in": "path",
"name": "name",
"required": true,
"schema": {
"type": "string",
"minLength": 1
}
}
]
},
"/api/v3/staking-metrics/{name}": {
"get": {
"parameters": [
{
"in": "query",
"name": "end",
"required": false,
"description": "End Timestamp",
"schema": {
"type": "number",
"default": null,
"nullable": true
}
},
{
"in": "query",
"name": "start",
"required": false,
"description": "Start Timestamp",
"schema": {
"type": "number",
"default": null,
"nullable": true
}
},
{
"in": "path",
"name": "name",
"required": true,
"description": "Metric Name",
"schema": {
"type": "string",
"enum": [
"governance_community_fund_total_maturity_e8s_equivalent",
"governance_community_fund_total_staked_e8s",
"governance_dissolved_neurons_count",
"governance_dissolved_neurons_e8s",
"governance_dissolving_neurons_count",
"governance_dissolving_neurons_e8s",
"governance_dissolving_neurons_staked_maturity_e8s_equivalent",
"governance_garbage_collectable_neurons_count",
"governance_last_rewards_event_e8s",
"governance_latest_gc_timestamp_seconds",
"governance_latest_reward_event_rounds_since_last_distribution",
"governance_latest_reward_event_timestamp_seconds",
"governance_latest_reward_event_total_available_e8s",
"governance_latest_reward_round_total_available_e8s",
"governance_locked_neurons_total",
"governance_neurons_total",
"governance_neurons_with_invalid_stake_count",
"governance_neurons_with_less_than_6_months_dissolve_delay_count",
"governance_neurons_with_less_than_6_months_dissolve_delay_e8s",
"governance_not_dissolving_neurons_count",
"governance_not_dissolving_neurons_e8s",
"governance_not_dissolving_neurons_staked_maturity_e8s_equivalent",
"governance_proposals_total",
"governance_ready_to_be_settled_proposals_total",
"governance_seconds_since_latest_reward_event",
"governance_stable_memory_size_bytes",
"governance_total_locked_e8s",
"governance_total_maturity_e8s_equivalent",
"governance_total_memory_size_bytes",
"governance_total_staked_e8s",
"governance_total_staked_maturity_e8s_equivalent",
"governance_total_supply_icp",
"governance_voting_power_total"
]
}
}
],
"responses": {
"422": {
"$ref": "#/components/responses/UNPROCESSABLE_ENTITY"
},
"default": {
"$ref": "#/components/responses/DEFAULT_ERROR"
}
},
"tags": [
"governance_metrics"
],
"deprecated": true
},
"parameters": [
{
"in": "path",
"name": "name",
"required": true,
"schema": {
"type": "string",
"minLength": 1
}
}
]
},
"/api/v3/health-check/": {
"get": {
"responses": {
"default": {
"$ref": "#/components/responses/DEFAULT_ERROR"
}
},
"tags": [
"health-check"
]
}
},
"/api/v3/icp-usd-rate": {
"get": {
"responses": {
"default": {
"$ref": "#/components/responses/DEFAULT_ERROR"
}
},
"tags": [
"icp_usd_rate"
]
}
},
"/api/v3/icp-usd-percent-change-24h": {
"get": {
"responses": {
"default": {
"$ref": "#/components/responses/DEFAULT_ERROR"
}
},
"tags": [
"icp_usd_rate"
]
}
},
"/api/v3/icp-xdr-conversion-rates": {
"get": {
"parameters": [
{
"in": "query",
"name": "end",
"required": false,
"description": "End Timestamp",
"schema": {
"type": "integer",
"default": null,
"nullable": true
}
},
{
"in": "query",
"name": "format",
"required": false,
"schema": {
"type": "string",
"default": "json",
"enum": [
"json",
"csv"
]
}
},
{
"in": "query",
"name": "start",
"required": false,
"description": "Start Timestamp",
"schema": {
"type": "integer",
"default": null,
"nullable": true
}
},
{
"in": "query",
"name": "step",
"required": false,
"description": "Step value",
"schema": {
"type": "number",
"default": 600.0
}
}
],
"responses": {
"422": {
"$ref": "#/components/responses/UNPROCESSABLE_ENTITY"
},
"default": {
"$ref": "#/components/responses/DEFAULT_ERROR"
}
},
"tags": [
"icp_xdr_conversion_rates"
]
}
},
"/api/v3/images/proposals/{proposal_id}.png": {
"get": {
"responses": {
"default": {
"$ref": "#/components/responses/DEFAULT_ERROR"
}
},
"tags": [
"images"
]
},
"parameters": [
{
"in": "path",
"name": "proposal_id",
"required": true,
"schema": {
"type": "integer",
"minimum": 0
}
}
]
},
"/api/v3/images/canisters/{canister_id}.png": {
"get": {
"responses": {
"default": {
"$ref": "#/components/responses/DEFAULT_ERROR"
}
},
"tags": [
"images"
]
},
"parameters": [
{
"in": "path",
"name": "canister_id",
"required": true,
"schema": {
"type": "string",
"minLength": 1
}
}
]
},
"/api/v3/images/data-centers/{dc_id}.png": {
"get": {
"responses": {
"default": {
"$ref": "#/components/responses/DEFAULT_ERROR"
}
},
"tags": [
"images"
]
},
"parameters": [
{
"in": "path",
"name": "dc_id",
"required": true,
"schema": {
"type": "string",
"minLength": 1
}
}
]
},
"/api/v3/images/neurons/{neuron_id}.png": {
"get": {
"responses": {
"default": {
"$ref": "#/components/responses/DEFAULT_ERROR"
}
},
"tags": [
"images"
]
},
"parameters": [
{
"in": "path",
"name": "neuron_id",
"required": true,
"schema": {
"type": "integer",
"minimum": 0
}
}
]
},
"/api/v3/images/nodes/{node_id}.png": {
"get": {
"responses": {
"default": {
"$ref": "#/components/responses/DEFAULT_ERROR"
}
},
"tags": [
"images"
]
},
"parameters": [
{
"in": "path",
"name": "node_id",
"required": true,
"schema": {
"type": "string",
"minLength": 1
}
}
]
},
"/api/v3/images/node-providers/{node_provider_id}.png": {
"get": {
"responses": {
"default": {
"$ref": "#/components/responses/DEFAULT_ERROR"
}
},
"tags": [
"images"
]
},
"parameters": [
{
"in": "path",
"name": "node_provider_id",
"required": true,
"schema": {
"type": "string",
"minLength": 1
}
}
]
},
"/api/v3/images/subnet-replica-versions/{replica_version_id}.png": {
"get": {
"responses": {
"default": {
"$ref": "#/components/responses/DEFAULT_ERROR"
}
},
"tags": [
"images"
]
},
"parameters": [
{
"in": "path",
"name": "replica_version_id",
"required": true,
"schema": {
"type": "string",
"minLength": 1
}
}
]
},
"/api/v3/images/subnets/{subnet_id}.png": {
"get": {
"responses": {
"default": {
"$ref": "#/components/responses/DEFAULT_ERROR"
}
},
"tags": [
"images"
]
},
"parameters": [
{
"in": "path",
"name": "subnet_id",
"required": true,
"schema": {
"type": "string",
"minLength": 1
}
}
]
},
"/api/v3/images/accounts/{account_address}.png": {
"get": {
"responses": {
"default": {
"$ref": "#/components/responses/DEFAULT_ERROR"
}
},
"tags": [
"images"
]
},
"parameters": [
{
"in": "path",
"name": "account_address",
"required": true,
"schema": {
"type": "string",
"minLength": 1
}
}
]
},
"/api/v3/images/accounts/{account_address}/transaction_flow.png": {
"get": {
"responses": {
"default": {
"$ref": "#/components/responses/DEFAULT_ERROR"
}
},
"tags": [
"images"
]
},
"parameters": [
{
"in": "path",
"name": "account_address",
"required": true,
"schema": {
"type": "string",
"minLength": 1
}
}
]
},
"/api/v3/images/transactions/{transaction_hash}.png": {
"get": {
"responses": {
"default": {
"$ref": "#/components/responses/DEFAULT_ERROR"
}
},
"tags": [
"images"
]
},
"parameters": [
{
"in": "path",
"name": "transaction_hash",
"required": true,
"schema": {
"type": "string",
"minLength": 1
}
}
]
},
"/api/v3/metrics/message-execution-rate": {
"get": {
"parameters": [
{
"in": "query",
"name": "start",
"required": false,
"description": "Start Timestamp",
"schema": {
"type": "number",
"default": null,
"nullable": true
}
},
{
"in": "query",
"name": "subnet",
"required": false,
"description": "Subnet ID",
"schema": {
"type": "string",
"default": null,
"nullable": true,
"pattern": "^([a-zA-Z0-9]{5}-){10}[a-zA-Z0-9]{3}$"
}
},
{
"in": "query",
"name": "end",
"required": false,
"description": "End Timestamp",
"schema": {
"type": "number",
"default": null,
"nullable": true
}
},
{
"in": "query",
"name": "format",
"required": false,
"schema": {
"type": "string",
"default": "json",
"enum": [
"json",
"csv"
]
}
},
{
"in": "query",
"name": "message_type",
"required": false,
"description": "Message Type",
"schema": {
"type": "string",
"default": "all",
"enum": [
"query",
"update",
"all"
]
}
},
{
"in": "query",
"name": "step",
"required": false,
"description": "Step value",
"schema": {
"type": "integer",
"default": 7200,
"minimum": 1,
"maximum": 259200
}
}
],
"responses": {
"422": {
"$ref": "#/components/responses/UNPROCESSABLE_ENTITY"
},
"default": {
"$ref": "#/components/responses/DEFAULT_ERROR"
}
},
"tags": [
"metrics"
]
}
},
"/api/v3/metrics/ic-nodes-count": {
"get": {
"parameters": [
{
"in": "query",
"name": "start",
"required": false,
"description": "Start Timestamp",
"schema": {
"type": "number",
"default": null,
"nullable": true
}
},
{
"in": "query",
"name": "subnet",
"required": false,
"description": "Subnet ID",
"schema": {
"type": "string",
"default": null,
"nullable": true,
"pattern": "^([a-zA-Z0-9]{5}-){10}[a-zA-Z0-9]{3}$"
}
},
{
"in": "query",
"name": "end",
"required": false,
"description": "End Timestamp",
"schema": {
"type": "number",
"default": null,
"nullable": true
}
},
{
"in": "query",
"name": "format",
"required": false,
"schema": {
"type": "string",
"default": "json",
"enum": [
"json",
"csv"
]
}
},
{
"in": "query",
"name": "step",
"required": false,
"description": "Step value",
"schema": {
"type": "integer",
"default": 7200,
"minimum": 1,
"maximum": 259200
}
}
],
"responses": {
"422": {
"$ref": "#/components/responses/UNPROCESSABLE_ENTITY"
},
"default": {
"$ref": "#/components/responses/DEFAULT_ERROR"
}
},
"tags": [
"metrics"
]
}
},
"/api/v3/metrics/ic-memory-total": {
"get": {
"parameters": [
{
"in": "query",
"name": "start",
"required": false,
"description": "Start Timestamp",
"schema": {
"type": "number",
"default": null,
"nullable": true
}
},
{
"in": "query",
"name": "subnet",
"required": false,
"description": "Subnet ID",
"schema": {
"type": "string",
"default": null,
"nullable": true,
"pattern": "^([a-zA-Z0-9]{5}-){10}[a-zA-Z0-9]{3}$"
}
},
{
"in": "query",
"name": "end",
"required": false,
"description": "End Timestamp",
"schema": {
"type": "number",
"default": null,
"nullable": true
}
},
{
"in": "query",
"name": "format",
"required": false,
"schema": {
"type": "string",
"default": "json",
"enum": [
"json",
"csv"
]
}
},
{
"in": "query",
"name": "step",
"required": false,
"description": "Step value",
"schema": {
"type": "integer",
"default": 7200,
"minimum": 1,
"maximum": 259200
}
}
],
"responses": {
"422": {
"$ref": "#/components/responses/UNPROCESSABLE_ENTITY"
},
"default": {
"$ref": "#/components/responses/DEFAULT_ERROR"
}
},
"tags": [
"metrics"
]
}
},
"/api/v3/metrics/ic-cpu-cores": {
"get": {
"parameters": [
{
"in": "query",
"name": "start",
"required": false,
"description": "Start Timestamp",
"schema": {
"type": "number",
"default": null,
"nullable": true
}
},
{
"in": "query",
"name": "subnet",
"required": false,
"description": "Subnet ID",
"schema": {
"type": "string",
"default": null,
"nullable": true,
"pattern": "^([a-zA-Z0-9]{5}-){10}[a-zA-Z0-9]{3}$"
}
},
{
"in": "query",
"name": "end",
"required": false,
"description": "End Timestamp",
"schema": {
"type": "number",
"default": null,
"nullable": true
}
},
{
"in": "query",
"name": "format",
"required": false,
"schema": {
"type": "string",
"default": "json",
"enum": [
"json",
"csv"
]
}
},
{
"in": "query",
"name": "step",
"required": false,
"description": "Step value",
"schema": {
"type": "integer",
"default": 7200,
"minimum": 1,
"maximum": 259200
}
}
],
"responses": {
"422": {
"$ref": "#/components/responses/UNPROCESSABLE_ENTITY"
},
"default": {
"$ref": "#/components/responses/DEFAULT_ERROR"
}
},
"tags": [
"metrics"
]
}
},
"/api/v3/metrics/ic-memory-usage": {
"get": {
"parameters": [
{
"in": "query",
"name": "start",
"required": false,
"description": "Start Timestamp",
"schema": {
"type": "number",
"default": null,
"nullable": true
}
},
{
"in": "query",
"name": "subnet",
"required": false,
"description": "Subnet ID",
"schema": {
"type": "string",
"default": null,
"nullable": true,
"pattern": "^([a-zA-Z0-9]{5}-){10}[a-zA-Z0-9]{3}$"
}
},
{
"in": "query",
"name": "end",
"required": false,
"description": "End Timestamp",
"schema": {
"type": "number",
"default": null,
"nullable": true
}
},
{
"in": "query",
"name": "format",
"required": false,
"schema": {
"type": "string",
"default": "json",
"enum": [
"json",
"csv"
]
}
},
{
"in": "query",
"name": "step",
"required": false,
"description": "Step value",
"schema": {
"type": "integer",
"default": 7200,
"minimum": 1,
"maximum": 259200
}
}
],
"responses": {
"422": {
"$ref": "#/components/responses/UNPROCESSABLE_ENTITY"
},
"default": {
"$ref": "#/components/responses/DEFAULT_ERROR"
}
},
"tags": [
"metrics"
]
}
},
"/api/v3/metrics/memory": {
"get": {
"parameters": [
{
"in": "query",
"name": "start",
"required": false,
"description": "Start Timestamp",
"schema": {
"type": "number",
"default": null,
"nullable": true
}
},
{
"in": "query",
"name": "subnet",
"required": false,
"description": "Subnet ID",
"schema": {
"type": "string",
"default": null,
"nullable": true,
"pattern": "^([a-zA-Z0-9]{5}-){10}[a-zA-Z0-9]{3}$"
}
},
{
"in": "query",
"name": "end",
"required": false,
"description": "End Timestamp",
"schema": {
"type": "number",
"default": null,
"nullable": true
}
},
{
"in": "query",
"name": "format",
"required": false,
"schema": {
"type": "string",
"default": "json",
"enum": [
"json",
"csv"
]
}
},
{
"in": "query",
"name": "step",
"required": false,
"description": "Step value",
"schema": {
"type": "integer",
"default": 7200,
"minimum": 1,
"maximum": 259200
}
}
],
"responses": {
"422": {
"$ref": "#/components/responses/UNPROCESSABLE_ENTITY"
},
"default": {
"$ref": "#/components/responses/DEFAULT_ERROR"
}
},
"tags": [
"metrics"
],
"deprecated": true
}
},
"/api/v3/metrics/block-rate": {
"get": {
"parameters": [
{
"in": "query",
"name": "start",
"required": false,
"description": "Start Timestamp",
"schema": {
"type": "number",
"default": null,
"nullable": true
}
},
{
"in": "query",
"name": "subnet",
"required": false,
"description": "Subnet ID",
"schema": {
"type": "string",
"default": null,
"nullable": true,
"pattern": "^([a-zA-Z0-9]{5}-){10}[a-zA-Z0-9]{3}$"
}
},
{
"in": "query",
"name": "end",
"required": false,
"description": "End Timestamp",
"schema": {
"type": "number",
"default": null,
"nullable": true
}
},
{
"in": "query",
"name": "format",
"required": false,
"schema": {
"type": "string",
"default": "json",
"enum": [
"json",
"csv"
]
}
},
{
"in": "query",
"name": "step",
"required": false,
"description": "Step value",
"schema": {
"type": "integer",
"default": 7200,
"minimum": 1,
"maximum": 259200
}
}
],
"responses": {
"422": {
"$ref": "#/components/responses/UNPROCESSABLE_ENTITY"
},
"default": {
"$ref": "#/components/responses/DEFAULT_ERROR"
}
},
"tags": [
"metrics"
]
}
},
"/api/v3/metrics/block-count": {
"get": {
"parameters": [
{
"in": "query",
"name": "subnet",
"required": false,
"description": "Subnet ID",
"schema": {
"type": "string",
"default": null,
"nullable": true,
"pattern": "^([a-zA-Z0-9]{5}-){10}[a-zA-Z0-9]{3}$"
}
},
{
"in": "query",
"name": "end",
"required": false,
"description": "End Timestamp",
"schema": {
"type": "number",
"default": null,
"nullable": true
}
},
{
"in": "query",
"name": "start",
"required": false,
"description": "Start Timestamp",
"schema": {
"type": "number",
"default": null,
"nullable": true
}
},
{
"in": "query",
"name": "step",
"required": false,
"description": "Step value",
"schema": {
"type": "integer",
"default": 7200,
"minimum": 1,
"maximum": 259200
}
}
],
"responses": {
"422": {
"$ref": "#/components/responses/UNPROCESSABLE_ENTITY"
},
"default": {
"$ref": "#/components/responses/DEFAULT_ERROR"
}
},
"tags": [
"metrics"
],
"deprecated": true
}
},
"/api/v3/metrics/egress-bandwidth": {
"get": {
"parameters": [
{
"in": "query",
"name": "end",
"required": false,
"description": "End Timestamp",
"schema": {
"type": "number",
"default": null,
"nullable": true
}
},
{
"in": "query",
"name": "start",
"required": false,
"description": "Start Timestamp",
"schema": {
"type": "number",
"default": null,
"nullable": true
}
},
{
"in": "query",
"name": "step",
"required": false,
"description": "Float Step value",
"schema": {
"type": "number",
"default": 7200.0,
"minimum": 1,
"maximum": 259200
}
}
],
"responses": {
"422": {
"$ref": "#/components/responses/UNPROCESSABLE_ENTITY"
},
"default": {
"$ref": "#/components/responses/DEFAULT_ERROR"
}
},
"tags": [
"metrics"
],
"deprecated": true
}
},
"/api/v3/metrics/ingress-bandwidth": {
"get": {
"parameters": [
{
"in": "query",
"name": "end",
"required": false,
"description": "End Timestamp",
"schema": {
"type": "number",
"default": null,
"nullable": true
}
},
{
"in": "query",
"name": "start",
"required": false,
"description": "Start Timestamp",
"schema": {
"type": "number",
"default": null,
"nullable": true
}
},
{
"in": "query",
"name": "step",
"required": false,
"description": "Float Step value",
"schema": {
"type": "number",
"default": 7200.0,
"minimum": 1,
"maximum": 259200
}
}
],
"responses": {
"422": {
"$ref": "#/components/responses/UNPROCESSABLE_ENTITY"
},
"default": {
"$ref": "#/components/responses/DEFAULT_ERROR"
}
},
"tags": [
"metrics"
],
"deprecated": true
}
},
"/api/v3/metrics/boundary-nodes-count": {
"get": {
"parameters": [
{
"in": "query",
"name": "end",
"required": false,
"description": "End Timestamp",
"schema": {
"type": "number",
"default": null,
"nullable": true
}
},
{
"in": "query",
"name": "format",
"required": false,
"schema": {
"type": "string",
"default": "json",
"enum": [
"json",
"csv"
]
}
},
{
"in": "query",
"name": "start",
"required": false,
"description": "Start Timestamp",
"schema": {
"type": "number",
"default": null,
"nullable": true
}
},
{
"in": "query",
"name": "step",
"required": false,
"description": "Float Step value",
"schema": {
"type": "number",
"default": 7200.0,
"minimum": 1,
"maximum": 259200
}
}
],
"responses": {
"422": {
"$ref": "#/components/responses/UNPROCESSABLE_ENTITY"
},
"default": {
"$ref": "#/components/responses/DEFAULT_ERROR"
}
},
"tags": [
"metrics"
]
}
},
"/api/v3/metrics/governance-neurons-total": {
"get": {
"parameters": [
{
"in": "query",
"name": "end",
"required": false,
"description": "End Timestamp",
"schema": {
"type": "number",
"default": null,
"nullable": true
}
},
{
"in": "query",
"name": "format",
"required": false,
"schema": {
"type": "string",
"default": "json",
"enum": [
"json",
"csv"
]
}
},
{
"in": "query",
"name": "start",
"required": false,
"description": "Start Timestamp",
"schema": {
"type": "number",
"default": null,
"nullable": true
}
},
{
"in": "query",
"name": "step",
"required": false,
"description": "Float Step value",
"schema": {
"type": "number",
"default": 7200.0,
"minimum": 1,
"maximum": 259200
}
}
],
"responses": {
"422": {
"$ref": "#/components/responses/UNPROCESSABLE_ENTITY"
},
"default": {
"$ref": "#/components/responses/DEFAULT_ERROR"
}
},
"tags": [
"metrics"
]
}
},
"/api/v3/metrics/internet-identity-user-count": {
"get": {
"parameters": [
{
"in": "query",
"name": "end",
"required": false,
"description": "End Timestamp",
"schema": {
"type": "number",
"default": null,
"nullable": true
}
},
{
"in": "query",
"name": "format",
"required": false,
"schema": {
"type": "string",
"default": "json",
"enum": [
"json",
"csv"
]
}
},
{
"in": "query",
"name": "start",
"required": false,
"description": "Start Timestamp",
"schema": {
"type": "number",
"default": null,
"nullable": true
}
},
{
"in": "query",
"name": "step",
"required": false,
"description": "Float Step value",
"schema": {
"type": "number",
"default": 7200.0,
"minimum": 1,
"maximum": 259200
}
}
],
"responses": {
"422": {
"$ref": "#/components/responses/UNPROCESSABLE_ENTITY"
},
"default": {
"$ref": "#/components/responses/DEFAULT_ERROR"
}
},
"tags": [
"metrics"
]
}
},
"/api/v3/metrics/governance-voting-power-total": {
"get": {
"parameters": [
{
"in": "query",
"name": "end",
"required": false,
"description": "End Timestamp",
"schema": {
"type": "number",
"default": null,
"nullable": true
}
},
{
"in": "query",
"name": "format",
"required": false,
"schema": {
"type": "string",
"default": "json",
"enum": [
"json",
"csv"
]
}
},
{
"in": "query",
"name": "start",
"required": false,
"description": "Start Timestamp",
"schema": {
"type": "number",
"default": null,
"nullable": true
}
},
{
"in": "query",
"name": "step",
"required": false,
"description": "Float Step value",
"schema": {
"type": "number",
"default": 7200.0,
"minimum": 1,
"maximum": 259200
}
}
],
"responses": {
"422": {
"$ref": "#/components/responses/UNPROCESSABLE_ENTITY"
},
"default": {
"$ref": "#/components/responses/DEFAULT_ERROR"
}
},
"tags": [
"metrics"
]
}
},
"/api/v3/metrics/average-governance-voting-power-total": {
"get": {
"parameters": [
{
"in": "query",
"name": "end",
"required": false,
"description": "End Timestamp",
"schema": {
"type": "number",
"default": null,
"nullable": true
}
},
{
"in": "query",
"name": "format",
"required": false,
"schema": {
"type": "string",
"default": "json",
"enum": [
"json",
"csv"
]
}
},
{
"in": "query",
"name": "start",
"required": false,
"description": "Start Timestamp",
"schema": {
"type": "number",
"default": null,
"nullable": true
}
},
{
"in": "query",
"name": "step",
"required": false,
"description": "Float Step value",
"schema": {
"type": "number",
"default": 7200.0,
"minimum": 1,
"maximum": 259200
}
}
],
"responses": {
"422": {
"$ref": "#/components/responses/UNPROCESSABLE_ENTITY"
},
"default": {
"$ref": "#/components/responses/DEFAULT_ERROR"
}
},
"tags": [
"metrics"
]
}
},
"/api/v3/metrics/cycle-burn-rate": {
"get": {
"parameters": [
{
"in": "query",
"name": "start",
"required": false,
"description": "Start Timestamp",
"schema": {
"type": "number",
"default": null,
"nullable": true
}
},
{
"in": "query",
"name": "subnet",
"required": false,
"description": "Subnet ID",
"schema": {
"type": "string",
"default": null,
"nullable": true,
"pattern": "^([a-zA-Z0-9]{5}-){10}[a-zA-Z0-9]{3}$"
}
},
{
"in": "query",
"name": "end",
"required": false,
"description": "End Timestamp",
"schema": {
"type": "number",
"default": null,
"nullable": true
}
},
{
"in": "query",
"name": "format",
"required": false,
"schema": {
"type": "string",
"default": "json",
"enum": [
"json",
"csv"
]
}
},
{
"in": "query",
"name": "step",
"required": false,
"description": "Step value",
"schema": {
"type": "integer",
"default": 7200,
"minimum": 1,
"maximum": 259200
}
}
],
"responses": {
"422": {
"$ref": "#/components/responses/UNPROCESSABLE_ENTITY"
},
"default": {
"$ref": "#/components/responses/DEFAULT_ERROR"
}
},
"tags": [
"metrics"
]
}
},
"/api/v3/metrics/ic-subnet-total": {
"get": {
"parameters": [
{
"in": "query",
"name": "end",
"required": false,
"description": "End Timestamp",
"schema": {
"type": "number",
"default": null,
"nullable": true
}
},
{
"in": "query",
"name": "format",
"required": false,
"schema": {
"type": "string",
"default": "json",
"enum": [
"json",
"csv"
]
}
},
{
"in": "query",
"name": "start",
"required": false,
"description": "Start Timestamp",
"schema": {
"type": "number",
"default": null,
"nullable": true
}
},
{
"in": "query",
"name": "step",
"required": false,
"description": "Float Step value",
"schema": {
"type": "number",
"default": 7200.0,
"minimum": 1,
"maximum": 259200
}
}
],
"responses": {
"422": {
"$ref": "#/components/responses/UNPROCESSABLE_ENTITY"
},
"default": {
"$ref": "#/components/responses/DEFAULT_ERROR"
}
},
"tags": [
"metrics"
]
}
},
"/api/v3/metrics/last-reward-event": {
"get": {
"parameters": [
{
"in": "query",
"name": "end",
"required": false,
"description": "End Timestamp",
"schema": {
"type": "number",
"default": null,
"nullable": true
}
},
{
"in": "query",
"name": "format",
"required": false,
"schema": {
"type": "string",
"default": "json",
"enum": [
"json",
"csv"
]
}
},
{
"in": "query",
"name": "start",
"required": false,
"description": "Start Timestamp",
"schema": {
"type": "number",
"default": null,
"nullable": true
}
},
{
"in": "query",
"name": "step",
"required": false,
"description": "Float Step value",
"schema": {
"type": "number",
"default": 7200.0,
"minimum": 1,
"maximum": 259200
}
}
],
"responses": {
"422": {
"$ref": "#/components/responses/UNPROCESSABLE_ENTITY"
},
"default": {
"$ref": "#/components/responses/DEFAULT_ERROR"
}
},
"tags": [
"metrics"
]
}
},
"/api/v3/metrics/latest-reward-event-total-available": {
"get": {
"parameters": [
{
"in": "query",
"name": "end",
"required": false,
"description": "End Timestamp",
"schema": {
"type": "number",
"default": null,
"nullable": true
}
},
{
"in": "query",
"name": "format",
"required": false,
"schema": {
"type": "string",
"default": "json",
"enum": [
"json",
"csv"
]
}
},
{
"in": "query",
"name": "start",
"required": false,
"description": "Start Timestamp",
"schema": {
"type": "number",
"default": null,
"nullable": true
}
},
{
"in": "query",
"name": "step",
"required": false,
"description": "Float Step value",
"schema": {
"type": "number",
"default": 7200.0,
"minimum": 1,
"maximum": 259200
}
}
],
"responses": {
"422": {
"$ref": "#/components/responses/UNPROCESSABLE_ENTITY"
},
"default": {
"$ref": "#/components/responses/DEFAULT_ERROR"
}
},
"tags": [
"metrics"
]
}
},
"/api/v3/metrics/average-last-reward-event": {
"get": {
"parameters": [
{
"in": "query",
"name": "end",
"required": false,
"description": "End Timestamp",
"schema": {
"type": "number",
"default": null,
"nullable": true
}
},
{
"in": "query",
"name": "format",
"required": false,
"schema": {
"type": "string",
"default": "json",
"enum": [
"json",
"csv"
]
}
},
{
"in": "query",
"name": "start",
"required": false,
"description": "Start Timestamp",
"schema": {
"type": "number",
"default": null,
"nullable": true
}
},
{
"in": "query",
"name": "step",
"required": false,
"description": "Float Step value",
"schema": {
"type": "number",
"default": 7200.0,
"minimum": 1,
"maximum": 259200
}
}
],
"responses": {
"422": {
"$ref": "#/components/responses/UNPROCESSABLE_ENTITY"
},
"default": {
"$ref": "#/components/responses/DEFAULT_ERROR"
}
},
"tags": [
"metrics"
]
}
},
"/api/v3/metrics/community-fund-total-staked": {
"get": {
"parameters": [
{
"in": "query",
"name": "end",
"required": false,
"description": "End Timestamp",
"schema": {
"type": "number",
"default": null,
"nullable": true
}
},
{
"in": "query",
"name": "format",
"required": false,
"schema": {
"type": "string",
"default": "json",
"enum": [
"json",
"csv"
]
}
},
{
"in": "query",
"name": "start",
"required": false,
"description": "Start Timestamp",
"schema": {
"type": "number",
"default": null,
"nullable": true
}
},
{
"in": "query",
"name": "step",
"required": false,
"description": "Float Step value",
"schema": {
"type": "number",
"default": 7200.0,
"minimum": 1,
"maximum": 259200
}
}
],
"responses": {
"422": {
"$ref": "#/components/responses/UNPROCESSABLE_ENTITY"
},
"default": {
"$ref": "#/components/responses/DEFAULT_ERROR"
}
},
"tags": [
"metrics"
]
}
},
"/api/v3/metrics/community-fund-total-maturity": {
"get": {
"parameters": [
{
"in": "query",
"name": "end",
"required": false,
"description": "End Timestamp",
"schema": {
"type": "number",
"default": null,
"nullable": true
}
},
{
"in": "query",
"name": "format",
"required": false,
"schema": {
"type": "string",
"default": "json",
"enum": [
"json",
"csv"
]
}
},
{
"in": "query",
"name": "start",
"required": false,
"description": "Start Timestamp",
"schema": {
"type": "number",
"default": null,
"nullable": true
}
},
{
"in": "query",
"name": "step",
"required": false,
"description": "Float Step value",
"schema": {
"type": "number",
"default": 7200.0,
"minimum": 1,
"maximum": 259200
}
}
],
"responses": {
"422": {
"$ref": "#/components/responses/UNPROCESSABLE_ENTITY"
},
"default": {
"$ref": "#/components/responses/DEFAULT_ERROR"
}
},
"tags": [
"metrics"
]
}
},
"/api/v3/metrics/total-rewardable-nodes-count": {
"get": {
"parameters": [
{
"in": "query",
"name": "exclude_types",
"required": false,
"explode": true,
"style": "form",
"schema": {
"type": "array",
"default": [],
"items": {
"type": "string",
"enum": [
"type0",
"type1",
"type2"
]
}
}
},
{
"in": "query",
"name": "format",
"required": false,
"schema": {
"type": "string",
"default": "json",
"enum": [
"json",
"csv"
]
}
}
],
"responses": {
"422": {
"$ref": "#/components/responses/UNPROCESSABLE_ENTITY"
},
"default": {
"$ref": "#/components/responses/DEFAULT_ERROR"
}
},
"tags": [
"metrics"
]
}
},
"/api/v3/metrics/registered-canisters-count": {
"get": {
"parameters": [
{
"in": "query",
"name": "status",
"required": false,
"explode": true,
"style": "form",
"schema": {
"type": "array",
"default": [
"running",
"stopped"
],
"items": {
"type": "string",
"enum": [
"running",
"stopped",
"all"
]
}
}
},
{
"in": "query",
"name": "start",
"required": false,
"description": "Start Timestamp",
"schema": {
"type": "number",
"default": null,
"nullable": true
}
},
{
"in": "query",
"name": "subnet",
"required": false,
"description": "Subnet ID",
"schema": {
"type": "string",
"default": null,
"nullable": true,
"pattern": "^([a-zA-Z0-9]{5}-){10}[a-zA-Z0-9]{3}$"
}
},
{
"in": "query",
"name": "end",
"required": false,
"description": "End Timestamp",
"schema": {
"type": "number",
"default": null,
"nullable": true
}
},
{
"in": "query",
"name": "format",
"required": false,
"schema": {
"type": "string",
"default": "json",
"enum": [
"json",
"csv"
]
}
},
{
"in": "query",
"name": "step",
"required": false,
"description": "Step value",
"schema": {
"type": "integer",
"default": 7200,
"minimum": 1,
"maximum": 259200
}
}
],
"responses": {
"422": {
"$ref": "#/components/responses/UNPROCESSABLE_ENTITY"
},
"default": {
"$ref": "#/components/responses/DEFAULT_ERROR"
}
},
"tags": [
"metrics"
]
}
},
"/api/v3/metrics/block-height": {
"get": {
"parameters": [
{
"in": "query",
"name": "start",
"required": false,
"description": "Start Timestamp",
"schema": {
"type": "number",
"default": null,
"nullable": true
}
},
{
"in": "query",
"name": "subnet",
"required": false,
"description": "Subnet ID",
"schema": {
"type": "string",
"default": null,
"nullable": true,
"pattern": "^([a-zA-Z0-9]{5}-){10}[a-zA-Z0-9]{3}$"
}
},
{
"in": "query",
"name": "end",
"required": false,
"description": "End Timestamp",
"schema": {
"type": "number",
"default": null,
"nullable": true
}
},
{
"in": "query",
"name": "format",
"required": false,
"schema": {
"type": "string",
"default": "json",
"enum": [
"json",
"csv"
]
}
},
{
"in": "query",
"name": "step",
"required": false,
"description": "Step value",
"schema": {
"type": "integer",
"default": 7200,
"minimum": 1,
"maximum": 259200
}
}
],
"responses": {
"422": {
"$ref": "#/components/responses/UNPROCESSABLE_ENTITY"
},
"default": {
"$ref": "#/components/responses/DEFAULT_ERROR"
}
},
"tags": [
"metrics"
]
}
},
"/api/v3/metrics/total-active-nodes-count": {
"get": {
"parameters": [
{
"in": "query",
"name": "end",
"required": false,
"description": "End Timestamp",
"schema": {
"type": "number",
"default": null,
"nullable": true
}
},
{
"in": "query",
"name": "start",
"required": false,
"description": "Start Timestamp",
"schema": {
"type": "number",
"default": null,
"nullable": true
}
},
{
"in": "query",
"name": "step",
"required": false,
"description": "Float Step value",
"schema": {
"type": "number",
"default": 7200.0,
"minimum": 1,
"maximum": 259200
}
}
],
"responses": {
"422": {
"$ref": "#/components/responses/UNPROCESSABLE_ENTITY"
},
"default": {
"$ref": "#/components/responses/DEFAULT_ERROR"
}
},
"tags": [
"metrics"
],
"deprecated": true
}
},
"/api/v3/metrics/total-awaiting-nodes-count": {
"get": {
"parameters": [
{
"in": "query",
"name": "end",
"required": false,
"description": "End Timestamp",
"schema": {
"type": "number",
"default": null,
"nullable": true
}
},
{
"in": "query",
"name": "start",
"required": false,
"description": "Start Timestamp",
"schema": {
"type": "number",
"default": null,
"nullable": true
}
},
{
"in": "query",
"name": "step",
"required": false,
"description": "Float Step value",
"schema": {
"type": "number",
"default": 7200.0,
"minimum": 1,
"maximum": 259200
}
}
],
"responses": {
"422": {
"$ref": "#/components/responses/UNPROCESSABLE_ENTITY"
},
"default": {
"$ref": "#/components/responses/DEFAULT_ERROR"
}
},
"tags": [
"metrics"
],
"deprecated": true
}
},
"/api/v3/metrics/total-offline-nodes-count": {
"get": {
"parameters": [
{
"in": "query",
"name": "end",
"required": false,
"description": "End Timestamp",
"schema": {
"type": "number",
"default": null,
"nullable": true
}
},
{
"in": "query",
"name": "start",
"required": false,
"description": "Start Timestamp",
"schema": {
"type": "number",
"default": null,
"nullable": true
}
},
{
"in": "query",
"name": "step",
"required": false,
"description": "Float Step value",
"schema": {
"type": "number",
"default": 7200.0,
"minimum": 1,
"maximum": 259200
}
}
],
"responses": {
"422": {
"$ref": "#/components/responses/UNPROCESSABLE_ENTITY"
},
"default": {
"$ref": "#/components/responses/DEFAULT_ERROR"
}
},
"tags": [
"metrics"
],
"deprecated": true
}
},
"/api/v3/metrics/energy-consumption-rate": {
"get": {
"parameters": [
{
"in": "query",
"name": "start",
"required": false,
"description": "Start Timestamp",
"schema": {
"type": "number",
"default": null,
"nullable": true
}
},
{
"in": "query",
"name": "end",
"required": false,
"description": "End Timestamp",
"schema": {
"type": "number",
"default": null,
"nullable": true
}
},
{
"in": "query",
"name": "format",
"required": false,
"schema": {
"type": "string",
"default": "json",
"enum": [
"json",
"csv"
]
}
},
{
"in": "query",
"name": "step",
"required": false,
"description": "Float Step value",
"schema": {
"type": "number",
"default": 7200.0,
"minimum": 1,
"maximum": 259200
}
},
{
"in": "query",
"name": "node_id",
"required": false,
"description": "Node ID",
"schema": {
"type": "string",
"default": null,
"nullable": true,
"pattern": "^([a-zA-Z0-9]{5}-){10}[a-zA-Z0-9]{3}$"
}
}
],
"responses": {
"422": {
"$ref": "#/components/responses/UNPROCESSABLE_ENTITY"
},
"default": {
"$ref": "#/components/responses/DEFAULT_ERROR"
}
},
"summary": "Deprecated: Use `/api/v3/metrics/node-energy-consumption-rate-kwh`\nand `/api/v3/metrics/total-ic-energy-consumption-rate-kwh` instead",
"tags": [
"metrics"
],
"deprecated": true
}
},
"/api/v3/metrics/total-ic-energy-consumption-rate-kwh": {
"get": {
"parameters": [
{
"in": "query",
"name": "end",
"required": false,
"description": "End Timestamp",
"schema": {
"type": "number",
"default": null,
"nullable": true
}
},
{
"in": "query",
"name": "format",
"required": false,
"schema": {
"type": "string",
"default": "json",
"enum": [
"json",
"csv"
]
}
},
{
"in": "query",
"name": "start",
"required": false,
"description": "Start Timestamp",
"schema": {
"type": "number",
"default": null,
"nullable": true
}
},
{
"in": "query",
"name": "step",
"required": false,
"description": "Float Step value",
"schema": {
"type": "number",
"default": 7200.0,
"minimum": 1,
"maximum": 259200
}
}
],
"responses": {
"422": {
"$ref": "#/components/responses/UNPROCESSABLE_ENTITY"
},
"default": {
"$ref": "#/components/responses/DEFAULT_ERROR"
}
},
"tags": [
"metrics"
]
}
},
"/api/v3/metrics/node-energy-consumption-rate-kwh": {
"get": {
"parameters": [
{
"in": "query",
"name": "start",
"required": false,
"description": "Start Timestamp",
"schema": {
"type": "number",
"default": null,
"nullable": true
}
},
{
"in": "query",
"name": "end",
"required": false,
"description": "End Timestamp",
"schema": {
"type": "number",
"default": null,
"nullable": true
}
},
{
"in": "query",
"name": "format",
"required": false,
"schema": {
"type": "string",
"default": "json",
"enum": [
"json",
"csv"
]
}
},
{
"in": "query",
"name": "step",
"required": false,
"description": "Float Step value",
"schema": {
"type": "number",
"default": 7200.0,
"minimum": 1,
"maximum": 259200
}
},
{
"in": "query",
"name": "node_id",
"required": false,
"description": "Node ID",
"schema": {
"type": "string",
"default": null,
"nullable": true,
"pattern": "^([a-zA-Z0-9]{5}-){10}[a-zA-Z0-9]{3}$"
}
}
],
"responses": {
"422": {
"$ref": "#/components/responses/UNPROCESSABLE_ENTITY"
},
"default": {
"$ref": "#/components/responses/DEFAULT_ERROR"
}
},
"tags": [
"metrics"
]
}
},
"/api/v3/metrics/transaction-rate": {
"get": {
"parameters": [
{
"in": "query",
"name": "end",
"required": false,
"description": "End Timestamp",
"schema": {
"type": "number",
"default": null,
"nullable": true
}
},
{
"in": "query",
"name": "start",
"required": false,
"description": "Start Timestamp",
"schema": {
"type": "number",
"default": null,
"nullable": true
}
},
{
"in": "query",
"name": "step",
"required": false,
"description": "Float Step value",
"schema": {
"type": "number",
"default": 7200.0,
"minimum": 1,
"maximum": 259200
}
}
],
"responses": {
"422": {
"$ref": "#/components/responses/UNPROCESSABLE_ENTITY"
},
"default": {
"$ref": "#/components/responses/DEFAULT_ERROR"
}
},
"tags": [
"metrics"
],
"deprecated": true
}
},
"/api/v3/metrics/max-transactions-per-sec-over-90-days": {
"get": {
"parameters": [
{
"in": "query",
"name": "format",
"required": false,
"schema": {
"type": "string",
"default": "json",
"enum": [
"json",
"csv"
]
}
}
],
"responses": {
"422": {
"$ref": "#/components/responses/UNPROCESSABLE_ENTITY"
},
"default": {
"$ref": "#/components/responses/DEFAULT_ERROR"
}
},
"tags": [
"metrics"
]
}
},
"/api/v3/metrics/instruction-rate": {
"get": {
"parameters": [
{
"in": "query",
"name": "start",
"required": false,
"description": "Start Timestamp",
"schema": {
"type": "number",
"default": null,
"nullable": true
}
},
{
"in": "query",
"name": "subnet",
"required": false,
"description": "Subnet ID",
"schema": {
"type": "string",
"default": null,
"nullable": true,
"pattern": "^([a-zA-Z0-9]{5}-){10}[a-zA-Z0-9]{3}$"
}
},
{
"in": "query",
"name": "end",
"required": false,
"description": "End Timestamp",
"schema": {
"type": "number",
"default": null,
"nullable": true
}
},
{
"in": "query",
"name": "format",
"required": false,
"schema": {
"type": "string",
"default": "json",
"enum": [
"json",
"csv"
]
}
},
{
"in": "query",
"name": "step",
"required": false,
"description": "Step value",
"schema": {
"type": "integer",
"default": 7200,
"minimum": 1,
"maximum": 259200
}
}
],
"responses": {
"422": {
"$ref": "#/components/responses/UNPROCESSABLE_ENTITY"
},
"default": {
"$ref": "#/components/responses/DEFAULT_ERROR"
}
},
"tags": [
"metrics"
]
}
},
"/api/v3/metrics/average-cycle-burn-rate": {
"get": {
"parameters": [
{
"in": "query",
"name": "format",
"required": false,
"schema": {
"type": "string",
"default": "json",
"enum": [
"json",
"csv"
]
}
}
],
"responses": {
"422": {
"$ref": "#/components/responses/UNPROCESSABLE_ENTITY"
},
"200": {
"description": "Average cycle burn rate over the last 90 day period",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"average_cycle_burn_rate": {
"type": "array",
"items": {
"oneOf": [
{
"type": "integer"
},
{
"type": "string",
"pattern": "^[0-9]*\\.[0-9]+$"
}
]
}
}
}
},
"examples": {
}
}
}
},
"default": {
"$ref": "#/components/responses/DEFAULT_ERROR"
}
},
"tags": [
"metrics"
]
}
},
"/api/v3/metrics/icp-txn-vs-eth-txn": {
"get": {
"parameters": [
{
"in": "query",
"name": "format",
"required": false,
"schema": {
"type": "string",
"default": "json",
"enum": [
"json",
"csv"
]
}
}
],
"responses": {
"422": {
"$ref": "#/components/responses/UNPROCESSABLE_ENTITY"
},
"default": {
"$ref": "#/components/responses/DEFAULT_ERROR"
}
},
"tags": [
"metrics"
]
}
},
"/api/v3/metrics/eth-equivalent-txns": {
"get": {
"parameters": [
{
"in": "query",
"name": "format",
"required": false,
"schema": {
"type": "string",
"default": "json",
"enum": [
"json",
"csv"
]
}
}
],
"responses": {
"422": {
"$ref": "#/components/responses/UNPROCESSABLE_ENTITY"
},
"default": {
"$ref": "#/components/responses/DEFAULT_ERROR"
}
},
"tags": [
"metrics"
]
}
},
"/api/v3/metrics/governance_not_dissolving_neurons_e8s_1year": {
"get": {
"parameters": [
{
"in": "query",
"name": "end",
"required": false,
"description": "End Timestamp",
"schema": {
"type": "number",
"default": null,
"nullable": true
}
},
{
"in": "query",
"name": "format",
"required": false,
"schema": {
"type": "string",
"default": "json",
"enum": [
"json",
"csv"
]
}
},
{
"in": "query",
"name": "start",
"required": false,
"description": "Start Timestamp",
"schema": {
"type": "number",
"default": null,
"nullable": true
}
}
],
"responses": {
"422": {
"$ref": "#/components/responses/UNPROCESSABLE_ENTITY"
},
"default": {
"$ref": "#/components/responses/DEFAULT_ERROR"
}
},
"tags": [
"metrics"
]
}
},
"/api/v3/metrics/governance_dissolving_neurons_e8s_1year": {
"get": {
"parameters": [
{
"in": "query",
"name": "end",
"required": false,
"description": "End Timestamp",
"schema": {
"type": "number",
"default": null,
"nullable": true
}
},
{
"in": "query",
"name": "format",
"required": false,
"schema": {
"type": "string",
"default": "json",
"enum": [
"json",
"csv"
]
}
},
{
"in": "query",
"name": "start",
"required": false,
"description": "Start Timestamp",
"schema": {
"type": "number",
"default": null,
"nullable": true
}
}
],
"responses": {
"422": {
"$ref": "#/components/responses/UNPROCESSABLE_ENTITY"
},
"default": {
"$ref": "#/components/responses/DEFAULT_ERROR"
}
},
"tags": [
"metrics"
]
}
},
"/api/v3/metrics/governance_not_dissolving_neurons_staked_maturity_e8s_equivalent_1year": {
"get": {
"parameters": [
{
"in": "query",
"name": "end",
"required": false,
"description": "End Timestamp",
"schema": {
"type": "number",
"default": null,
"nullable": true
}
},
{
"in": "query",
"name": "format",
"required": false,
"schema": {
"type": "string",
"default": "json",
"enum": [
"json",
"csv"
]
}
},
{
"in": "query",
"name": "start",
"required": false,
"description": "Start Timestamp",
"schema": {
"type": "number",
"default": null,
"nullable": true
}
}
],
"responses": {
"422": {
"$ref": "#/components/responses/UNPROCESSABLE_ENTITY"
},
"default": {
"$ref": "#/components/responses/DEFAULT_ERROR"
}
},
"tags": [
"metrics"
]
}
},
"/api/v3/metrics/governance_dissolving_neurons_staked_maturity_e8s_equivalent_1year": {
"get": {
"parameters": [
{
"in": "query",
"name": "end",
"required": false,
"description": "End Timestamp",
"schema": {
"type": "number",
"default": null,
"nullable": true
}
},
{
"in": "query",
"name": "format",
"required": false,
"schema": {
"type": "string",
"default": "json",
"enum": [
"json",
"csv"
]
}
},
{
"in": "query",
"name": "start",
"required": false,
"description": "Start Timestamp",
"schema": {
"type": "number",
"default": null,
"nullable": true
}
}
],
"responses": {
"422": {
"$ref": "#/components/responses/UNPROCESSABLE_ENTITY"
},
"default": {
"$ref": "#/components/responses/DEFAULT_ERROR"
}
},
"tags": [
"metrics"
]
}
},
"/api/v3/messages-counts": {
"get": {
"parameters": [
{
"in": "query",
"name": "subnet",
"required": false,
"description": "Subnet ID",
"schema": {
"type": "string",
"default": null,
"nullable": true,
"pattern": "^([a-zA-Z0-9]{5}-){10}[a-zA-Z0-9]{3}$"
}
}
],
"responses": {
"422": {
"$ref": "#/components/responses/UNPROCESSABLE_ENTITY"
},
"default": {
"$ref": "#/components/responses/DEFAULT_ERROR"
}
},
"tags": [
"messages_counts"
]
}
},
"/api/v3/messages-counts-over-time": {
"get": {
"parameters": [
{
"in": "query",
"name": "subnet",
"required": false,
"description": "Subnet ID",
"schema": {
"type": "string",
"default": null,
"nullable": true,
"pattern": "^([a-zA-Z0-9]{5}-){10}[a-zA-Z0-9]{3}$"
}
},
{
"in": "query",
"name": "end",
"required": false,
"description": "End Timestamp",
"schema": {
"type": "number",
"default": null,
"nullable": true
}
},
{
"in": "query",
"name": "start",
"required": true,
"description": "Start Timestamp",
"schema": {
"type": "number"
}
},
{
"in": "query",
"name": "step",
"required": false,
"description": "Step value",
"schema": {
"type": "integer",
"default": 7200,
"minimum": 1,
"maximum": 259200
}
}
],
"responses": {
"422": {
"$ref": "#/components/responses/UNPROCESSABLE_ENTITY"
},
"default": {
"$ref": "#/components/responses/DEFAULT_ERROR"
}
},
"tags": [
"messages_counts_over_time"
]
}
},
"/api/v3/network-economics-parameters/{parameter}": {
"get": {
"parameters": [
{
"in": "path",
"name": "parameter",
"required": true,
"description": "Parameter Name",
"schema": {
"type": "string",
"enum": [
"neurons_fund_economics",
"voting_power_economics"
]
}
}
],
"responses": {
"422": {
"$ref": "#/components/responses/UNPROCESSABLE_ENTITY"
},
"default": {
"$ref": "#/components/responses/DEFAULT_ERROR"
}
},
"summary": "Get network economics parameter by name.",
"tags": [
"network_economics_parameters"
]
},
"parameters": [
{
"in": "path",
"name": "parameter",
"required": true,
"schema": {
"type": "string",
"minLength": 1
}
}
]
},
"/api/v3/neurons": {
"get": {
"parameters": [
{
"in": "query",
"name": "include_state",
"required": false,
"explode": true,
"style": "form",
"schema": {
"type": "array",
"default": [],
"items": {
"type": "string",
"enum": [
"Dissolved",
"Dissolving",
"NotDissolving",
"Spawning",
"Unknown",
"Unspecified"
]
}
}
},
{
"in": "query",
"name": "include_type",
"required": false,
"explode": true,
"style": "form",
"schema": {
"type": "array",
"default": [],
"items": {
"type": "string",
"enum": [
"gtc",
"known"
]
}
}
},
{
"in": "query",
"name": "limit",
"required": false,
"schema": {
"type": "integer",
"default": 50,
"minimum": 0,
"maximum": 100
}
},
{
"in": "query",
"name": "max_neuron_index",
"required": false,
"schema": {
"type": "integer",
"default": null,
"nullable": true,
"minimum": 0
}
},
{
"in": "query",
"name": "offset",
"required": false,
"schema": {
"type": "integer",
"default": 0,
"minimum": 0
}
},
{
"in": "query",
"name": "sort_by",
"required": false,
"description": "Available values : id, name, state, age_seconds, dissolve_delay_seconds, voting_power, created_timestamp_seconds, stake_e8s, joined_community_fund_timestamp_seconds",
"schema": {
"default": "-created_timestamp_seconds"
}
},
{
"in": "query",
"name": "format",
"required": false,
"schema": {
"type": "string",
"default": "json",
"enum": [
"json",
"csv"
]
}
}
],
"responses": {
"422": {
"$ref": "#/components/responses/UNPROCESSABLE_ENTITY"
},
"default": {
"$ref": "#/components/responses/DEFAULT_ERROR"
}
},
"tags": [
"neurons"
]
}
},
"/api/v3/neurons/{neuron_id}": {
"get": {
"responses": {
"default": {
"$ref": "#/components/responses/DEFAULT_ERROR"
}
},
"tags": [
"neurons"
]
},
"parameters": [
{
"in": "path",
"name": "neuron_id",
"required": true,
"schema": {
"type": "integer",
"minimum": 0
}
}
]
},
"/api/v3/neurons/{neuron_id}/recent-ballots": {
"get": {
"parameters": [
{
"in": "query",
"name": "proposal_id",
"required": false,
"description": "Proposal ID",
"schema": {
"type": "integer",
"default": null,
"nullable": true
}
},
{
"in": "query",
"name": "include_status",
"required": false,
"explode": true,
"style": "form",
"schema": {
"type": "array",
"default": [],
"items": {
"type": "string",
"enum": [
"UNKNOWN",
"UNSPECIFIED",
"OPEN",
"REJECTED",
"ADOPTED",
"EXECUTED",
"FAILED"
]
}
}
},
{
"in": "query",
"name": "sort_by",
"required": false,
"description": "Available values : proposal_id, topic, status, vote",
"schema": {
"default": "-proposal_id"
}
},
{
"in": "query",
"name": "format",
"required": false,
"schema": {
"type": "string",
"default": "json",
"enum": [
"json",
"csv"
]
}
},
{
"in": "query",
"name": "include_vote",
"required": false,
"explode": true,
"style": "form",
"schema": {
"type": "array",
"default": [
0,
1,
2
],
"items": {
"type": "integer",
"enum": [
0,
1,
2
]
}
}
},
{
"in": "query",
"name": "include_topic",
"required": false,
"explode": true,
"style": "form",
"schema": {
"type": "array",
"default": [],
"items": {
"type": "string",
"enum": [
"TOPIC_UNSPECIFIED",
"TOPIC_NEURON_MANAGEMENT",
"TOPIC_EXCHANGE_RATE",
"TOPIC_NETWORK_ECONOMICS",
"TOPIC_GOVERNANCE",
"TOPIC_NODE_ADMIN",
"TOPIC_PARTICIPANT_MANAGEMENT",
"TOPIC_SUBNET_MANAGEMENT",
"TOPIC_NETWORK_CANISTER_MANAGEMENT",
"TOPIC_KYC",
"TOPIC_NODE_PROVIDER_REWARDS",
"TOPIC_SNS_DECENTRALIZATION_SALE",
"TOPIC_IC_OS_VERSION_DEPLOYMENT",
"TOPIC_IC_OS_VERSION_ELECTION",
"TOPIC_SNS_AND_COMMUNITY_FUND",
"TOPIC_API_BOUNDARY_NODE_MANAGEMENT",
"TOPIC_SUBNET_RENTAL",
"TOPIC_PROTOCOL_CANISTER_MANAGEMENT",
"TOPIC_SERVICE_NERVOUS_SYSTEM_MANAGEMENT",
"TOPIC_SYSTEM_CANISTER_MANAGEMENT",
"TOPIC_APPLICATION_CANISTER_MANAGEMENT"
]
}
}
}
],
"responses": {
"422": {
"$ref": "#/components/responses/UNPROCESSABLE_ENTITY"
},
"default": {
"$ref": "#/components/responses/DEFAULT_ERROR"
}
},
"tags": [
"neurons"
]
},
"parameters": [
{
"in": "path",
"name": "neuron_id",
"required": true,
"schema": {
"type": "integer",
"minimum": 0
}
}
]
},
"/api/v3/known-neurons/{neuron_id}/ballots": {
"get": {
"parameters": [
{
"in": "query",
"name": "proposal_id",
"required": false,
"description": "Proposal ID",
"schema": {
"type": "integer",
"default": null,
"nullable": true
}
},
{
"in": "query",
"name": "limit",
"required": false,
"schema": {
"type": "integer",
"default": 100,
"minimum": 0,
"maximum": 200
}
},
{
"in": "query",
"name": "include_status",
"required": false,
"explode": true,
"style": "form",
"schema": {
"type": "array",
"default": [],
"items": {
"type": "string",
"enum": [
"UNKNOWN",
"UNSPECIFIED",
"OPEN",
"REJECTED",
"ADOPTED",
"EXECUTED",
"FAILED"
]
}
}
},
{
"in": "query",
"name": "offset",
"required": false,
"schema": {
"type": "integer",
"default": 0,
"minimum": 0
}
},
{
"in": "query",
"name": "sort_by",
"required": false,
"description": "Available values : proposal_id, topic, status, vote",
"schema": {
"default": "-proposal_id"
}
},
{
"in": "query",
"name": "format",
"required": false,
"schema": {
"type": "string",
"default": "json",
"enum": [
"json",
"csv"
]
}
},
{
"in": "query",
"name": "include_vote",
"required": false,
"explode": true,
"style": "form",
"schema": {
"type": "array",
"default": [
0,
1,
2
],
"items": {
"type": "integer",
"enum": [
0,
1,
2
]
}
}
},
{
"in": "query",
"name": "max_ballot_index",
"required": false,
"schema": {
"type": "integer",
"default": null,
"nullable": true,
"minimum": 0
}
},
{
"in": "query",
"name": "include_topic",
"required": false,
"explode": true,
"style": "form",
"schema": {
"type": "array",
"default": [],
"items": {
"type": "string",
"enum": [
"TOPIC_UNSPECIFIED",
"TOPIC_NEURON_MANAGEMENT",
"TOPIC_EXCHANGE_RATE",
"TOPIC_NETWORK_ECONOMICS",
"TOPIC_GOVERNANCE",
"TOPIC_NODE_ADMIN",
"TOPIC_PARTICIPANT_MANAGEMENT",
"TOPIC_SUBNET_MANAGEMENT",
"TOPIC_NETWORK_CANISTER_MANAGEMENT",
"TOPIC_KYC",
"TOPIC_NODE_PROVIDER_REWARDS",
"TOPIC_SNS_DECENTRALIZATION_SALE",
"TOPIC_IC_OS_VERSION_DEPLOYMENT",
"TOPIC_IC_OS_VERSION_ELECTION",
"TOPIC_SNS_AND_COMMUNITY_FUND",
"TOPIC_API_BOUNDARY_NODE_MANAGEMENT",
"TOPIC_SUBNET_RENTAL",
"TOPIC_PROTOCOL_CANISTER_MANAGEMENT",
"TOPIC_SERVICE_NERVOUS_SYSTEM_MANAGEMENT",
"TOPIC_SYSTEM_CANISTER_MANAGEMENT",
"TOPIC_APPLICATION_CANISTER_MANAGEMENT",
""
]
}
}
}
],
"responses": {
"422": {
"$ref": "#/components/responses/UNPROCESSABLE_ENTITY"
},
"default": {
"$ref": "#/components/responses/DEFAULT_ERROR"
}
},
"tags": [
"neurons"
]
},
"parameters": [
{
"in": "path",
"name": "neuron_id",
"required": true,
"schema": {
"type": "integer",
"minimum": 0
}
}
]
},
"/api/v3/neurons/{neuron_id}/ballots": {
"get": {
"parameters": [
{
"in": "query",
"name": "proposal_id",
"required": false,
"description": "Proposal ID",
"schema": {
"type": "integer",
"default": null,
"nullable": true
}
},
{
"in": "query",
"name": "limit",
"required": false,
"schema": {
"type": "integer",
"default": 100,
"minimum": 0,
"maximum": 200
}
},
{
"in": "query",
"name": "include_status",
"required": false,
"explode": true,
"style": "form",
"schema": {
"type": "array",
"default": [],
"items": {
"type": "string",
"enum": [
"UNKNOWN",
"UNSPECIFIED",
"OPEN",
"REJECTED",
"ADOPTED",
"EXECUTED",
"FAILED"
]
}
}
},
{
"in": "query",
"name": "offset",
"required": false,
"schema": {
"type": "integer",
"default": 0,
"minimum": 0
}
},
{
"in": "query",
"name": "sort_by",
"required": false,
"description": "Available values : proposal_id, topic, status, vote",
"schema": {
"default": "-proposal_id"
}
},
{
"in": "query",
"name": "format",
"required": false,
"schema": {
"type": "string",
"default": "json",
"enum": [
"json",
"csv"
]
}
},
{
"in": "query",
"name": "include_vote",
"required": false,
"explode": true,
"style": "form",
"schema": {
"type": "array",
"default": [
0,
1,
2
],
"items": {
"type": "integer",
"enum": [
0,
1,
2
]
}
}
},
{
"in": "query",
"name": "max_ballot_index",
"required": false,
"schema": {
"type": "integer",
"default": null,
"nullable": true,
"minimum": 0
}
},
{
"in": "query",
"name": "include_topic",
"required": false,
"explode": true,
"style": "form",
"schema": {
"type": "array",
"default": [],
"items": {
"type": "string",
"enum": [
"TOPIC_UNSPECIFIED",
"TOPIC_NEURON_MANAGEMENT",
"TOPIC_EXCHANGE_RATE",
"TOPIC_NETWORK_ECONOMICS",
"TOPIC_GOVERNANCE",
"TOPIC_NODE_ADMIN",
"TOPIC_PARTICIPANT_MANAGEMENT",
"TOPIC_SUBNET_MANAGEMENT",
"TOPIC_NETWORK_CANISTER_MANAGEMENT",
"TOPIC_KYC",
"TOPIC_NODE_PROVIDER_REWARDS",
"TOPIC_SNS_DECENTRALIZATION_SALE",
"TOPIC_IC_OS_VERSION_DEPLOYMENT",
"TOPIC_IC_OS_VERSION_ELECTION",
"TOPIC_SNS_AND_COMMUNITY_FUND",
"TOPIC_API_BOUNDARY_NODE_MANAGEMENT",
"TOPIC_SUBNET_RENTAL",
"TOPIC_PROTOCOL_CANISTER_MANAGEMENT",
"TOPIC_SERVICE_NERVOUS_SYSTEM_MANAGEMENT",
"TOPIC_SYSTEM_CANISTER_MANAGEMENT",
"TOPIC_APPLICATION_CANISTER_MANAGEMENT",
""
]
}
}
}
],
"responses": {
"422": {
"$ref": "#/components/responses/UNPROCESSABLE_ENTITY"
},
"default": {
"$ref": "#/components/responses/DEFAULT_ERROR"
}
},
"tags": [
"neurons"
]
},
"parameters": [
{
"in": "path",
"name": "neuron_id",
"required": true,
"schema": {
"type": "integer",
"minimum": 0
}
}
]
},
"/api/v3/neuron-maturity-modulations": {
"get": {
"parameters": [
{
"in": "query",
"name": "end",
"required": false,
"description": "End Timestamp",
"schema": {
"type": "integer",
"default": null,
"nullable": true
}
},
{
"in": "query",
"name": "format",
"required": false,
"schema": {
"type": "string",
"default": "json",
"enum": [
"json",
"csv"
]
}
},
{
"in": "query",
"name": "start",
"required": false,
"description": "Start Timestamp",
"schema": {
"type": "integer",
"default": null,
"nullable": true
}
}
],
"responses": {
"422": {
"$ref": "#/components/responses/UNPROCESSABLE_ENTITY"
},
"default": {
"$ref": "#/components/responses/DEFAULT_ERROR"
}
},
"tags": [
"neuron_maturity_modulations"
]
}
},
"/api/v3/neuron-voting-powers": {
"get": {
"parameters": [
{
"in": "query",
"name": "start",
"required": false,
"description": "Start Timestamp",
"schema": {
"type": "integer",
"default": null,
"nullable": true
}
},
{
"in": "query",
"name": "owner",
"required": false,
"explode": true,
"style": "form",
"schema": {
"type": "array",
"default": [
"DFINITY",
"ALL"
],
"items": {
"type": "string",
"enum": [
"DFINITY",
"ALL"
]
}
}
},
{
"in": "query",
"name": "kind",
"required": false,
"description": "Kind of voting power",
"schema": {
"type": "string",
"default": "deciding_voting_power",
"enum": [
"deciding_voting_power",
"potential_voting_power"
]
}
},
{
"in": "query",
"name": "end",
"required": false,
"description": "End Timestamp",
"schema": {
"type": "integer",
"default": null,
"nullable": true
}
},
{
"in": "query",
"name": "step",
"required": false,
"description": "Integer step value multiple of 600(10min)",
"schema": {
"type": "integer",
"default": 86400,
"minimum": 600,
"maximum": 604800
}
}
],
"responses": {
"422": {
"$ref": "#/components/responses/UNPROCESSABLE_ENTITY"
},
"default": {
"$ref": "#/components/responses/DEFAULT_ERROR"
}
},
"tags": [
"neuron_voting_powers"
],
"deprecated": true
}
},
"/api/v3/nodes": {
"get": {
"parameters": [
{
"in": "query",
"name": "include_status",
"required": false,
"explode": true,
"style": "form",
"description": "Node Statuses",
"schema": {
"type": "array",
"default": [
"DOWN",
"UP",
"UNASSIGNED",
"DEGRADED"
],
"items": {
"type": "string",
"enum": [
"DOWN",
"UP",
"UNASSIGNED",
"DISABLED",
"DEGRADED"
]
}
}
},
{
"in": "query",
"name": "subnet",
"required": false,
"description": "Subnet ID",
"schema": {
"type": "string",
"default": null,
"nullable": true,
"pattern": "^([a-zA-Z0-9]{5}-){10}[a-zA-Z0-9]{3}$"
}
},
{
"in": "query",
"name": "include_node_type",
"required": false,
"explode": true,
"style": "form",
"description": "Node Types",
"schema": {
"type": "array",
"default": [],
"items": {
"type": "string",
"enum": [
"API_BOUNDARY",
"REPLICA"
]
}
}
},
{
"in": "query",
"name": "format",
"required": false,
"schema": {
"type": "string",
"default": "json",
"enum": [
"json",
"csv"
]
}
},
{
"in": "query",
"name": "dc_id",
"required": false,
"description": "Data Center ID",
"schema": {
"type": "string",
"default": null,
"nullable": true,
"minLength": 3,
"maxLength": 4
}
},
{
"in": "query",
"name": "node_provider_id",
"required": false,
"description": "Node Provider ID",
"schema": {
"type": "string",
"default": null,
"nullable": true,
"pattern": "^([a-zA-Z0-9]{5}-){10}[a-zA-Z0-9]{3}$"
}
}
],
"responses": {
"422": {
"$ref": "#/components/responses/UNPROCESSABLE_ENTITY"
},
"default": {
"$ref": "#/components/responses/DEFAULT_ERROR"
}
},
"tags": [
"nodes"
]
}
},
"/api/v3/nodes/{node_id}": {
"get": {
"parameters": [
{
"in": "path",
"name": "node_id",
"required": true,
"description": "Node ID",
"schema": {
"type": "string",
"pattern": "^([a-zA-Z0-9]{5}-){10}[a-zA-Z0-9]{3}$"
}
}
],
"responses": {
"422": {
"$ref": "#/components/responses/UNPROCESSABLE_ENTITY"
},
"default": {
"$ref": "#/components/responses/DEFAULT_ERROR"
}
},
"tags": [
"nodes"
]
},
"parameters": [
{
"in": "path",
"name": "node_id",
"required": true,
"schema": {
"type": "string",
"minLength": 1
}
}
]
},
"/api/v3/node-providers": {
"get": {
"parameters": [
{
"in": "query",
"name": "format",
"required": false,
"schema": {
"type": "string",
"default": "json",
"enum": [
"json",
"csv"
]
}
}
],
"responses": {
"422": {
"$ref": "#/components/responses/UNPROCESSABLE_ENTITY"
},
"default": {
"$ref": "#/components/responses/DEFAULT_ERROR"
}
},
"tags": [
"node_providers"
]
}
},
"/api/v3/node-providers/{node_provider_id}": {
"get": {
"parameters": [
{
"in": "path",
"name": "node_provider_id",
"required": true,
"description": "Node Provider ID",
"schema": {
"type": "string",
"pattern": "^([a-zA-Z0-9]{5}-){10}[a-zA-Z0-9]{3}$"
}
}
],
"responses": {
"422": {
"$ref": "#/components/responses/UNPROCESSABLE_ENTITY"
},
"default": {
"$ref": "#/components/responses/DEFAULT_ERROR"
}
},
"tags": [
"node_providers"
]
},
"parameters": [
{
"in": "path",
"name": "node_provider_id",
"required": true,
"schema": {
"type": "string",
"minLength": 1
}
}
]
},
"/api/v3/node-providers/{node_provider_id}/nodes": {
"get": {
"parameters": [
{
"in": "query",
"name": "include_status",
"required": false,
"explode": true,
"style": "form",
"description": "Node Statuses",
"schema": {
"type": "array",
"default": [
"DOWN",
"UP",
"UNASSIGNED",
"DEGRADED"
],
"items": {
"type": "string",
"enum": [
"DOWN",
"UP",
"UNASSIGNED",
"DISABLED",
"DEGRADED"
]
}
}
},
{
"in": "path",
"name": "node_provider_id",
"required": true,
"description": "Node Provider ID",
"schema": {
"type": "string",
"pattern": "^([a-zA-Z0-9]{5}-){10}[a-zA-Z0-9]{3}$"
}
}
],
"responses": {
"422": {
"$ref": "#/components/responses/UNPROCESSABLE_ENTITY"
},
"default": {
"$ref": "#/components/responses/DEFAULT_ERROR"
}
},
"tags": [
"node_providers"
]
},
"parameters": [
{
"in": "path",
"name": "node_provider_id",
"required": true,
"schema": {
"type": "string",
"minLength": 1
}
}
]
},
"/api/v3/node-providers-count": {
"get": {
"parameters": [
{
"in": "query",
"name": "only_assigned_nodes",
"required": false,
"description": "Only Assigned Nodes",
"schema": {
"type": "boolean",
"default": false
}
},
{
"in": "query",
"name": "include_node_type",
"required": false,
"explode": true,
"style": "form",
"description": "Node Types",
"schema": {
"type": "array",
"default": [],
"items": {
"type": "string",
"enum": [
"API_BOUNDARY",
"REPLICA"
]
}
}
}
],
"responses": {
"422": {
"$ref": "#/components/responses/UNPROCESSABLE_ENTITY"
},
"default": {
"$ref": "#/components/responses/DEFAULT_ERROR"
}
},
"tags": [
"node_providers"
]
}
},
"/api/v3/participation-rates": {
"get": {
"parameters": [
{
"in": "query",
"name": "start",
"required": false,
"description": "Start Timestamp",
"schema": {
"type": "number",
"default": null,
"nullable": true
}
},
{
"in": "query",
"name": "end",
"required": false,
"description": "End Timestamp",
"schema": {
"type": "number",
"default": null,
"nullable": true
}
},
{
"in": "query",
"name": "format",
"required": false,
"schema": {
"type": "string",
"default": "json",
"enum": [
"json",
"csv"
]
}
},
{
"in": "query",
"name": "step",
"required": false,
"description": "Step value in seconds(multiple of 86400 seconds(1 day))",
"schema": {
"type": "integer",
"default": null,
"nullable": true,
"minimum": 86400,
"maximum": 604800
}
},
{
"in": "query",
"name": "include_topic",
"required": false,
"schema": {
"type": "string",
"default": null,
"enum": [
"TOPIC_GOVERNANCE"
],
"nullable": true
}
}
],
"responses": {
"422": {
"$ref": "#/components/responses/UNPROCESSABLE_ENTITY"
},
"default": {
"$ref": "#/components/responses/DEFAULT_ERROR"
}
},
"tags": [
"participation_rates"
]
}
},
"/api/v3/proposals": {
"get": {
"parameters": [
{
"in": "query",
"name": "limit",
"required": false,
"schema": {
"type": "integer",
"default": 50,
"minimum": 0,
"maximum": 100
}
},
{
"in": "query",
"name": "max_proposal_index",
"required": false,
"schema": {
"type": "integer",
"default": null,
"nullable": true,
"minimum": 0
}
},
{
"in": "query",
"name": "include_action",
"required": false,
"explode": true,
"style": "form",
"schema": {
"type": "array",
"default": [],
"items": {
"type": "string",
"enum": [
"ApproveGenesisKyc",
"AddOrRemoveNodeProvider",
"CreateServiceNervousSystem",
"ExecuteNnsFunction",
"InstallCode",
"ManageNeuron",
"ManageNetworkEconomics",
"Motion",
"OpenSnsTokenSwap",
"RegisterKnownNeuron",
"RewardNodeProvider",
"RewardNodeProviders",
"SetDefaultFollowees",
"SetSnsTokenSwapOpenTimeWindow",
"StopOrStartCanister",
"UpdateCanisterSettings"
]
}
}
},
{
"in": "query",
"name": "include_status",
"required": false,
"explode": true,
"style": "form",
"schema": {
"type": "array",
"default": [],
"items": {
"type": "string",
"enum": [
"UNKNOWN",
"UNSPECIFIED",
"OPEN",
"REJECTED",
"ADOPTED",
"EXECUTED",
"FAILED"
]
}
}
},
{
"in": "query",
"name": "proposer",
"required": false,
"schema": {
"type": "integer",
"default": null,
"nullable": true
}
},
{
"in": "query",
"name": "manage_neuron_id",
"required": false,
"schema": {
"type": "integer",
"default": null,
"nullable": true,
"minimum": 0
}
},
{
"in": "query",
"name": "offset",
"required": false,
"schema": {
"type": "integer",
"default": 0,
"minimum": 0
}
},
{
"in": "query",
"name": "include_reward_status",
"required": false,
"explode": true,
"style": "form",
"schema": {
"type": "array",
"default": [],
"items": {
"type": "string",
"enum": [
"UNSPECIFIED",
"ACCEPT_VOTES",
"READY_TO_SETTLE",
"SETTLED",
"INELIGIBLE"
]
}
}
},
{
"in": "query",
"name": "include_action_nns_function",
"required": false,
"explode": true,
"style": "form",
"schema": {
"type": "array",
"default": [],
"items": {
"type": "string",
"enum": [
"AddApiBoundaryNodes",
"AddFirewallRules",
"AddNodeToSubnet",
"AddOrRemoveDataCenters",
"AddSnsWasm",
"AssignNoid",
"BitcoinSetConfig",
"BlessReplicaVersion",
"ChangeSubnetMembership",
"ChangeSubnetTypeAssignment",
"ClearProvisionalWhitelist",
"CompleteCanisterMigration",
"CreateSubnet",
"DeployGuestosToAllSubnetNodes",
"DeployGuestosToAllUnassignedNodes",
"DeployGuestosToSomeApiBoundaryNodes",
"DeployHostosToSomeNodes",
"HardResetNnsRootToVersion",
"IcpXdrConversionRate",
"InsertSnsWasmUpgradePathEntries",
"NnsCanisterInstall",
"NnsCanisterUpgrade",
"NnsRootUpgrade",
"PrepareCanisterMigration",
"RecoverSubnet",
"RemoveApiBoundaryNodes",
"RemoveFirewallRules",
"RemoveNodeOperators",
"RemoveNodes",
"RemoveNodesFromSubnet",
"RerouteCanisterRanges",
"RetireReplicaVersion",
"ReviseElectedGuestosVersions",
"ReviseElectedHostosVersions",
"SetAuthorizedSubnetworks",
"SetFirewallConfig",
"StopOrStartNnsCanister",
"SubnetRentalRequest",
"UninstallCode",
"Unspecified",
"UpdateAllowedPrincipals",
"UpdateApiBoundaryNodesVersion",
"UpdateConfigOfSubnet",
"UpdateElectedHostosVersions",
"UpdateFirewallRules",
"UpdateNodeOperatorConfig",
"UpdateNodeRewardsTable",
"UpdateNodesHostosVersion",
"UpdateSnsWasmSnsSubnetIds",
"UpdateSshReadonlyAccessForAllUnassignedNodes",
"UpdateSubnetType",
"UpdateUnassignedNodesConfig"
]
}
}
},
{
"in": "query",
"name": "format",
"required": false,
"schema": {
"type": "string",
"default": "json",
"enum": [
"json",
"csv"
]
}
},
{
"in": "query",
"name": "include_topic",
"required": false,
"explode": true,
"style": "form",
"schema": {
"type": "array",
"default": [],
"items": {
"type": "string",
"enum": [
"TOPIC_UNSPECIFIED",
"TOPIC_NEURON_MANAGEMENT",
"TOPIC_EXCHANGE_RATE",
"TOPIC_NETWORK_ECONOMICS",
"TOPIC_GOVERNANCE",
"TOPIC_NODE_ADMIN",
"TOPIC_PARTICIPANT_MANAGEMENT",
"TOPIC_SUBNET_MANAGEMENT",
"TOPIC_NETWORK_CANISTER_MANAGEMENT",
"TOPIC_KYC",
"TOPIC_NODE_PROVIDER_REWARDS",
"TOPIC_SNS_DECENTRALIZATION_SALE",
"TOPIC_IC_OS_VERSION_DEPLOYMENT",
"TOPIC_IC_OS_VERSION_ELECTION",
"TOPIC_SNS_AND_COMMUNITY_FUND",
"TOPIC_API_BOUNDARY_NODE_MANAGEMENT",
"TOPIC_SUBNET_RENTAL",
"TOPIC_PROTOCOL_CANISTER_MANAGEMENT",
"TOPIC_SERVICE_NERVOUS_SYSTEM_MANAGEMENT",
"TOPIC_SYSTEM_CANISTER_MANAGEMENT",
"TOPIC_APPLICATION_CANISTER_MANAGEMENT"
]
}
}
}
],
"responses": {
"422": {
"$ref": "#/components/responses/UNPROCESSABLE_ENTITY"
},
"default": {
"$ref": "#/components/responses/DEFAULT_ERROR"
}
},
"tags": [
"proposals"
]
}
},
"/api/v3/nns/participation-rate": {
"get": {
"parameters": [
{
"in": "query",
"name": "end",
"required": false,
"description": "End Timestamp",
"schema": {
"type": "number",
"default": null,
"nullable": true
}
},
{
"in": "query",
"name": "start",
"required": false,
"description": "Start Timestamp",
"schema": {
"type": "number",
"default": null,
"nullable": true
}
},
{
"in": "query",
"name": "step",
"required": false,
"description": "Float Step value",
"schema": {
"type": "number",
"default": null,
"nullable": true,
"minimum": 1,
"maximum": 259200
}
},
{
"in": "query",
"name": "include_topic",
"required": false,
"schema": {
"type": "string",
"default": null,
"enum": [
"TOPIC_UNSPECIFIED",
"TOPIC_NEURON_MANAGEMENT",
"TOPIC_EXCHANGE_RATE",
"TOPIC_NETWORK_ECONOMICS",
"TOPIC_GOVERNANCE",
"TOPIC_NODE_ADMIN",
"TOPIC_PARTICIPANT_MANAGEMENT",
"TOPIC_SUBNET_MANAGEMENT",
"TOPIC_NETWORK_CANISTER_MANAGEMENT",
"TOPIC_KYC",
"TOPIC_NODE_PROVIDER_REWARDS",
"TOPIC_SNS_DECENTRALIZATION_SALE",
"TOPIC_IC_OS_VERSION_DEPLOYMENT",
"TOPIC_IC_OS_VERSION_ELECTION",
"TOPIC_SNS_AND_COMMUNITY_FUND",
"TOPIC_API_BOUNDARY_NODE_MANAGEMENT",
"TOPIC_SUBNET_RENTAL",
"TOPIC_PROTOCOL_CANISTER_MANAGEMENT",
"TOPIC_SERVICE_NERVOUS_SYSTEM_MANAGEMENT"
],
"nullable": true
}
}
],
"responses": {
"422": {
"$ref": "#/components/responses/UNPROCESSABLE_ENTITY"
},
"default": {
"$ref": "#/components/responses/DEFAULT_ERROR"
}
},
"tags": [
"proposals"
]
}
},
"/api/v3/proposals/{proposal_id}": {
"get": {
"responses": {
"default": {
"$ref": "#/components/responses/DEFAULT_ERROR"
}
},
"tags": [
"proposals"
]
},
"parameters": [
{
"in": "path",
"name": "proposal_id",
"required": true,
"schema": {
"type": "integer",
"minimum": 0
}
}
]
},
"/api/v3/proposals-count": {
"get": {
"responses": {
"default": {
"$ref": "#/components/responses/DEFAULT_ERROR"
}
},
"tags": [
"proposals"
]
}
},
"/api/v3/latest-proposal-id": {
"get": {
"responses": {
"default": {
"$ref": "#/components/responses/DEFAULT_ERROR"
}
},
"tags": [
"proposals"
]
}
},
"/api/v3/metrics/latest-proposal-id": {
"get": {
"responses": {
"default": {
"$ref": "#/components/responses/DEFAULT_ERROR"
}
},
"tags": [
"proposals"
],
"deprecated": true
}
},
"/api/v3/proposals-over-past-7d": {
"get": {
"responses": {
"default": {
"$ref": "#/components/responses/DEFAULT_ERROR"
}
},
"tags": [
"proposals"
]
}
},
"/api/v3/proposals-over-time": {
"get": {
"parameters": [
{
"in": "query",
"name": "end",
"required": false,
"description": "End Timestamp",
"schema": {
"type": "number",
"default": null,
"nullable": true
}
},
{
"in": "query",
"name": "format",
"required": false,
"schema": {
"type": "string",
"default": "json",
"enum": [
"json",
"csv"
]
}
},
{
"in": "query",
"name": "start",
"required": true,
"description": "Start Timestamp",
"schema": {
"type": "number"
}
},
{
"in": "query",
"name": "step",
"required": false,
"description": "Step value",
"schema": {
"type": "number",
"default": 7200.0
}
}
],
"responses": {
"422": {
"$ref": "#/components/responses/UNPROCESSABLE_ENTITY"
},
"default": {
"$ref": "#/components/responses/DEFAULT_ERROR"
}
},
"tags": [
"proposals_over_time"
]
}
},
"/api/v3/proposals/{proposal_id}/tallies": {
"get": {
"parameters": [
{
"in": "query",
"name": "format",
"required": false,
"schema": {
"type": "string",
"default": "json",
"enum": [
"json",
"csv"
]
}
},
{
"in": "query",
"name": "step",
"required": false,
"description": "Step value",
"schema": {
"type": "integer",
"default": null,
"nullable": true,
"minimum": 60,
"maximum": 259200
}
}
],
"responses": {
"422": {
"$ref": "#/components/responses/UNPROCESSABLE_ENTITY"
},
"default": {
"$ref": "#/components/responses/DEFAULT_ERROR"
}
},
"tags": [
"proposal_tallies"
]
},
"parameters": [
{
"in": "path",
"name": "proposal_id",
"required": true,
"schema": {
"type": "integer",
"minimum": 0
}
}
]
},
"/api/v3/proposals/{proposal_id}/deadline-extensions": {
"get": {
"responses": {
"default": {
"$ref": "#/components/responses/DEFAULT_ERROR"
}
},
"tags": [
"proposal_deadline_extensions"
]
},
"parameters": [
{
"in": "path",
"name": "proposal_id",
"required": true,
"schema": {
"type": "integer",
"minimum": 0
}
}
]
},
"/api/v3/timeseries/reward-node-providers": {
"get": {
"parameters": [
{
"in": "query",
"name": "end",
"required": false,
"description": "End Timestamp",
"schema": {
"type": "number",
"default": null,
"nullable": true
}
},
{
"in": "query",
"name": "format",
"required": false,
"schema": {
"type": "string",
"default": "json",
"enum": [
"json",
"csv"
]
}
},
{
"in": "query",
"name": "start",
"required": false,
"description": "Start Timestamp",
"schema": {
"type": "number",
"default": null,
"nullable": true
}
},
{
"in": "query",
"name": "step",
"required": false,
"description": "Float Step value",
"schema": {
"type": "number",
"default": 86400.0,
"minimum": 60,
"maximum": 259200
}
}
],
"responses": {
"422": {
"$ref": "#/components/responses/UNPROCESSABLE_ENTITY"
},
"default": {
"$ref": "#/components/responses/DEFAULT_ERROR"
}
},
"tags": [
"reward_node_providers"
]
}
},
"/api/v3/reward-node-providers": {
"get": {
"parameters": [
{
"in": "query",
"name": "max_reward_node_provider_index",
"required": false,
"schema": {
"type": "integer",
"default": null,
"nullable": true,
"minimum": 0
}
},
{
"in": "query",
"name": "format",
"required": false,
"schema": {
"type": "string",
"default": "json",
"enum": [
"json",
"csv"
]
}
},
{
"in": "query",
"name": "offset",
"required": false,
"schema": {
"type": "integer",
"default": 0,
"minimum": 0
}
},
{
"in": "query",
"name": "limit",
"required": false,
"schema": {
"type": "integer",
"default": 50,
"minimum": 0,
"maximum": 100
}
}
],
"responses": {
"422": {
"$ref": "#/components/responses/UNPROCESSABLE_ENTITY"
},
"default": {
"$ref": "#/components/responses/DEFAULT_ERROR"
}
},
"tags": [
"reward_node_providers"
]
}
},
"/api/v3/reward-node-providers/{id}": {
"get": {
"responses": {
"default": {
"$ref": "#/components/responses/DEFAULT_ERROR"
}
},
"tags": [
"reward_node_providers"
]
},
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "integer",
"minimum": 0
}
}
]
},
"/api/v3/": {
"get": {
"responses": {
"default": {
"$ref": "#/components/responses/DEFAULT_ERROR"
}
},
"tags": [
"root"
]
}
},
"/api/v3/changelog": {
"get": {
"responses": {
"default": {
"$ref": "#/components/responses/DEFAULT_ERROR"
}
},
"tags": [
"root"
]
}
},
"/api/v3/subnets": {
"get": {
"parameters": [
{
"in": "query",
"name": "dc_id",
"required": false,
"description": "Data Center ID",
"schema": {
"type": "string",
"default": null,
"nullable": true,
"minLength": 3,
"maxLength": 4
}
},
{
"in": "query",
"name": "format",
"required": false,
"schema": {
"type": "string",
"default": "json",
"enum": [
"json",
"csv"
]
}
}
],
"responses": {
"422": {
"$ref": "#/components/responses/UNPROCESSABLE_ENTITY"
},
"default": {
"$ref": "#/components/responses/DEFAULT_ERROR"
}
},
"tags": [
"subnets"
]
}
},
"/api/v3/subnets/{subnet_id}": {
"get": {
"parameters": [
{
"in": "path",
"name": "subnet_id",
"required": true,
"description": "Subnet ID",
"schema": {
"type": "string",
"pattern": "^([a-zA-Z0-9]{5}-){10}[a-zA-Z0-9]{3}$"
}
}
],
"responses": {
"422": {
"$ref": "#/components/responses/UNPROCESSABLE_ENTITY"
},
"default": {
"$ref": "#/components/responses/DEFAULT_ERROR"
}
},
"tags": [
"subnets"
]
},
"parameters": [
{
"in": "path",
"name": "subnet_id",
"required": true,
"schema": {
"type": "string",
"minLength": 1
}
}
]
},
"/api/v3/subnet-replica-versions": {
"get": {
"parameters": [
{
"in": "query",
"name": "start",
"required": false,
"description": "Start Timestamp",
"schema": {
"type": "number",
"default": null,
"nullable": true
}
},
{
"in": "query",
"name": "limit",
"required": false,
"schema": {
"type": "integer",
"default": 50,
"minimum": 0,
"maximum": 100
}
},
{
"in": "query",
"name": "max_proposal_index",
"required": false,
"schema": {
"type": "integer",
"default": null,
"nullable": true,
"minimum": 0
}
},
{
"in": "query",
"name": "include_status",
"required": false,
"explode": true,
"style": "form",
"schema": {
"type": "array",
"default": [
"EXECUTED",
"OPEN",
"ADOPTED"
],
"items": {
"type": "string",
"enum": [
"EXECUTED",
"OPEN",
"ADOPTED"
]
}
}
},
{
"in": "query",
"name": "offset",
"required": false,
"schema": {
"type": "integer",
"default": 0,
"minimum": 0
}
},
{
"in": "query",
"name": "sort_by",
"required": false,
"description": "Available values : proposal_id, executed_timestamp_seconds",
"schema": {
"default": "-executed_timestamp_seconds"
}
},
{
"in": "query",
"name": "end",
"required": false,
"description": "End Timestamp",
"schema": {
"type": "number",
"default": null,
"nullable": true
}
},
{
"in": "query",
"name": "format",
"required": false,
"schema": {
"type": "string",
"default": "json",
"enum": [
"json",
"csv"
]
}
}
],
"responses": {
"422": {
"$ref": "#/components/responses/UNPROCESSABLE_ENTITY"
},
"default": {
"$ref": "#/components/responses/DEFAULT_ERROR"
}
},
"tags": [
"subnet_replica_versions"
]
}
},
"/api/v3/subnet-replica-versions/{replica_version_id}": {
"get": {
"responses": {
"default": {
"$ref": "#/components/responses/DEFAULT_ERROR"
}
},
"tags": [
"subnet_replica_versions"
]
},
"parameters": [
{
"in": "path",
"name": "replica_version_id",
"required": true,
"schema": {
"type": "string",
"minLength": 1
}
}
]
},
"/api/v4/boundary-node-data-centers": {
"get": {
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ListBoundaryNodeDataCentersResponse"
}
}
}
},
"default": {
"$ref": "#/components/responses/DEFAULT_ERROR"
}
},
"tags": [
"v4 boundary node data centers"
]
}
},
"/api/v4/neuron-voting-powers": {
"get": {
"parameters": [
{
"in": "query",
"name": "start",
"required": false,
"description": "Start Timestamp",
"schema": {
"type": "integer",
"default": null,
"nullable": true
}
},
{
"in": "query",
"name": "owner",
"required": false,
"explode": true,
"style": "form",
"schema": {
"type": "array",
"default": [
"DFINITY",
"ALL"
],
"items": {
"type": "string",
"enum": [
"DFINITY",
"ALL"
]
}
}
},
{
"in": "query",
"name": "kind",
"required": false,
"explode": true,
"style": "form",
"schema": {
"type": "array",
"default": [
"deciding_voting_power"
],
"items": {
"type": "string",
"enum": [
"deciding_voting_power",
"potential_voting_power"
]
}
}
},
{
"in": "query",
"name": "end",
"required": false,
"description": "End Timestamp",
"schema": {
"type": "integer",
"default": null,
"nullable": true
}
},
{
"in": "query",
"name": "step",
"required": false,
"description": "Integer step value multiple of 600(10min)",
"schema": {
"type": "integer",
"default": 86400,
"minimum": 600,
"maximum": 604800
}
}
],
"responses": {
"422": {
"$ref": "#/components/responses/UNPROCESSABLE_ENTITY"
},
"default": {
"$ref": "#/components/responses/DEFAULT_ERROR"
}
},
"tags": [
"V4 neuron_voting_powers"
]
}
},
"/api/v4/subnets": {
"get": {
"parameters": [
{
"in": "query",
"name": "after",
"required": false,
"explode": true,
"style": "form",
"description": "Only match values after this ledger_canister_id",
"schema": {
"type": "array",
"default": [],
"minItems": 1,
"maxItems": 2,
"items": {
"type": "string"
}
}
},
{
"in": "query",
"name": "subnet_specialization_or_type",
"required": false,
"explode": true,
"style": "form",
"description": "Subnet Specialization or Type",
"schema": {
"type": "array",
"default": [],
"items": {
"type": "string",
"enum": [
"european",
"fiduciary",
"application",
"system"
]
}
}
},
{
"in": "query",
"name": "limit",
"required": false,
"schema": {
"type": "integer",
"default": 20
}
},
{
"in": "query",
"name": "subnet_specialization",
"required": false,
"explode": true,
"style": "form",
"description": "Subnet Specialization",
"schema": {
"type": "array",
"default": [],
"items": {
"type": "string",
"enum": [
"european",
"fiduciary"
]
}
}
},
{
"in": "query",
"name": "sort_by",
"required": false,
"schema": {
"type": "string",
"default": "subnet_id",
"enum": [
"instruction_rate",
"-instruction_rate",
"memory_usage",
"-memory_usage",
"message_execution_rate",
"-message_execution_rate",
"nakamoto_coefficient_overall",
"-nakamoto_coefficient_overall",
"subnet_authorization",
"-subnet_authorization",
"subnet_id",
"-subnet_id",
"subnet_type",
"-subnet_type",
"subnet_specialization",
"-subnet_specialization",
"subnet_specialization_or_type",
"-subnet_specialization_or_type",
"total_nodes",
"-total_nodes",
"total_canisters",
"-total_canisters",
"total_countries",
"-total_countries"
]
}
},
{
"in": "query",
"name": "format",
"required": false,
"schema": {
"type": "string",
"default": "json",
"enum": [
"json",
"csv"
]
}
},
{
"in": "query",
"name": "before",
"required": false,
"explode": true,
"style": "form",
"description": "Only match values before this ledger_canister_id",
"schema": {
"type": "array",
"default": [],
"minItems": 1,
"maxItems": 2,
"items": {
"type": "string"
}
}
},
{
"in": "query",
"name": "subnet_authorization",
"required": false,
"explode": true,
"style": "form",
"description": "Subnet Authorization",
"schema": {
"type": "array",
"default": [],
"items": {
"type": "string",
"enum": [
"public",
"authorized_only"
]
}
}
},
{
"in": "query",
"name": "include_replica_versions",
"required": false,
"description": "Include Replica Versions",
"schema": {
"type": "boolean",
"default": false
}
},
{
"in": "query",
"name": "subnet_type",
"required": false,
"explode": true,
"style": "form",
"description": "Subnet Type",
"schema": {
"type": "array",
"default": [],
"items": {
"type": "string",
"enum": [
"application",
"system",
"verified_application"
]
}
}
},
{
"in": "query",
"name": "dc_id",
"required": false,
"description": "Data Center ID",
"schema": {
"type": "string",
"default": null,
"nullable": true,
"minLength": 3,
"maxLength": 4
}
}
],
"responses": {
"422": {
"$ref": "#/components/responses/UNPROCESSABLE_ENTITY"
},
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ListSubnetsResponse"
}
}
}
},
"default": {
"$ref": "#/components/responses/DEFAULT_ERROR"
}
},
"tags": [
"v4 subnets"
]
}
},
"/api/v4/subnets/{subnet_id}": {
"get": {
"parameters": [
{
"in": "path",
"name": "subnet_id",
"required": true,
"description": "Subnet ID",
"schema": {
"type": "string",
"pattern": "^([a-zA-Z0-9]{5}-){10}[a-zA-Z0-9]{3}$"
}
}
],
"responses": {
"422": {
"$ref": "#/components/responses/UNPROCESSABLE_ENTITY"
},
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Subnet"
}
}
}
},
"default": {
"$ref": "#/components/responses/DEFAULT_ERROR"
}
},
"tags": [
"v4 subnets"
]
},
"parameters": [
{
"in": "path",
"name": "subnet_id",
"required": true,
"schema": {
"type": "string",
"minLength": 1
}
}
]
},
"/api/v4/subnets/count": {
"get": {
"parameters": [
{
"in": "query",
"name": "subnet_specialization_or_type",
"required": false,
"explode": true,
"style": "form",
"description": "Subnet Specialization or Type",
"schema": {
"type": "array",
"default": [],
"items": {
"type": "string",
"enum": [
"european",
"fiduciary",
"application",
"system"
]
}
}
},
{
"in": "query",
"name": "subnet_specialization",
"required": false,
"explode": true,
"style": "form",
"description": "Subnet Specialization",
"schema": {
"type": "array",
"default": [],
"items": {
"type": "string",
"enum": [
"european",
"fiduciary"
]
}
}
},
{
"in": "query",
"name": "format",
"required": false,
"schema": {
"type": "string",
"default": "json",
"enum": [
"json",
"csv"
]
}
},
{
"in": "query",
"name": "subnet_authorization",
"required": false,
"explode": true,
"style": "form",
"description": "Subnet Authorization",
"schema": {
"type": "array",
"default": [],
"items": {
"type": "string",
"enum": [
"public",
"authorized_only"
]
}
}
},
{
"in": "query",
"name": "subnet_type",
"required": false,
"explode": true,
"style": "form",
"description": "Subnet Type",
"schema": {
"type": "array",
"default": [],
"items": {
"type": "string",
"enum": [
"application",
"system",
"verified_application"
]
}
}
},
{
"in": "query",
"name": "dc_id",
"required": false,
"description": "Data Center ID",
"schema": {
"type": "string",
"default": null,
"nullable": true,
"minLength": 3,
"maxLength": 4
}
}
],
"responses": {
"422": {
"$ref": "#/components/responses/UNPROCESSABLE_ENTITY"
},
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CountSubnetsResponse"
}
}
}
},
"default": {
"$ref": "#/components/responses/DEFAULT_ERROR"
}
},
"tags": [
"v4 subnets"
]
}
}
},
"info": {
"title": "Public Dashboard API",
"version": "v3"
},
"tags": [
{
"name": "avg_icp_xdr_conversion_rates",
"description": "AVG ICP/XDR Conversion Rates"
},
{
"name": "bitcoin",
"description": "Bitcoin Metrics"
},
{
"name": "block_heights",
"description": "Block Heights"
},
{
"name": "block_heights_over_time",
"description": "Block Heights Over Time"
},
{
"name": "boundary-node-locations",
"description": "Boundary Node Locations"
},
{
"name": "canisters",
"description": "Canisters"
},
{
"name": "data_centers",
"description": "DataCenters"
},
{
"name": "daily_stats",
"description": "Daily Stats"
},
{
"name": "governance_metrics",
"description": "Governance Metrics"
},
{
"name": "health-check",
"description": "Health Check Endpoint"
},
{
"name": "icp_usd_rate",
"description": "Current ICP/USD rate"
},
{
"name": "icp_xdr_conversion_rates",
"description": "ICP/XDR Conversion Rates"
},
{
"name": "images",
"description": "Generated Images"
},
{
"name": "metrics",
"description": "Prometheus metrics"
},
{
"name": "messages_counts",
"description": "Messages Counts"
},
{
"name": "messages_counts_over_time",
"description": "Messages Counts Over Time"
},
{
"name": "network_economics_parameters",
"description": "Network Economics Parameters"
},
{
"name": "neurons",
"description": "Neurons"
},
{
"name": "neuron_maturity_modulations",
"description": "Neuron Maturity Modulations"
},
{
"name": "neuron_voting_powers",
"description": "Neuron Voting Powers"
},
{
"name": "nodes",
"description": "Nodes"
},
{
"name": "node_providers",
"description": "Node Providers"
},
{
"name": "participation_rates",
"description": "Participation Rates"
},
{
"name": "proposals",
"description": "NNS Proposals"
},
{
"name": "proposals_over_time",
"description": "NNS Proposals Over Time"
},
{
"name": "proposal_tallies",
"description": "Proposal Tallies"
},
{
"name": "proposal_deadline_extensions",
"description": "Proposal Deadline Extension"
},
{
"name": "reward_node_providers",
"description": "Reward Node Providers"
},
{
"name": "root",
"description": "Root"
},
{
"name": "subnets",
"description": "Subnets"
},
{
"name": "subnet_replica_versions",
"description": "Subnet Replica Versions"
},
{
"name": "v4 boundary node data centers",
"description": "Boundary Node Data Centers"
},
{
"name": "V4 neuron_voting_powers",
"description": "Neuron Voting Powers"
},
{
"name": "v4 subnets",
"description": "Subnets"
}
],
"openapi": "3.0.3",
"components": {
"schemas": {
"Error": {
"type": "object",
"properties": {
"message": {
"type": "string",
"description": "Error message"
},
"code": {
"type": "integer",
"description": "Error code"
},
"status": {
"type": "string",
"description": "Error name"
},
"errors": {
"type": "object",
"description": "Errors"
}
}
},
"BoundaryNodeDataCenter": {
"type": "object",
"properties": {
"longitude": {
"type": "string",
"description": "Longitude"
},
"latitude": {
"type": "string",
"description": "Latitude"
},
"total_nodes": {
"type": "string",
"description": "Total Nodes"
},
"owner": {
"type": "string",
"description": "Owner"
},
"region": {
"type": "string",
"description": "Region"
},
"name": {
"type": "string",
"description": "Name"
},
"dc_id": {
"type": "string",
"description": "Data Center ID"
}
}
},
"ListBoundaryNodeDataCentersResponse": {
"type": "object",
"properties": {
"data": {
"type": "array",
"description": "List of Boundary Node Data Centers",
"items": {
"$ref": "#/components/schemas/BoundaryNodeDataCenter"
}
}
}
},
"DecentralizationSubScore": {
"type": "object",
"properties": {
"countries": {
"type": "string",
"description": "Countries Score"
},
"cities": {
"type": "string",
"description": "Cities Score"
},
"data_centers": {
"type": "string",
"description": "Data Centers Score"
},
"node_providers": {
"type": "string",
"description": "Node Providers Score"
},
"data_center_owners": {
"type": "string",
"description": "Data Center Owners Score"
}
}
},
"DecentralizationScore": {
"type": "object",
"properties": {
"nakamoto_sub_percentages": {
"description": "Nakamoto Sub Percentages",
"allOf": [
{
"$ref": "#/components/schemas/DecentralizationSubScore"
}
]
},
"nakamoto_sub_coefficients": {
"description": "Nakamoto Sub Coefficients",
"allOf": [
{
"$ref": "#/components/schemas/DecentralizationSubScore"
}
]
},
"nakamoto_percentage_overall": {
"type": "string",
"description": "Nakamoto Percentage Overall"
},
"nakamoto_coefficient_overall": {
"type": "string",
"description": "Nakamoto Coefficient Overall"
}
}
},
"ReplicaVersion": {
"type": "object",
"properties": {
"replica_version_id": {
"type": "string",
"description": "Replica Version ID"
},
"executed_timestamp_seconds": {
"type": "string",
"description": "Executed Timestamp Seconds"
},
"proposal_id": {
"type": "string",
"description": "Proposal ID"
}
}
},
"DataCenter": {
"type": "object",
"properties": {
"longitude": {
"type": "string",
"description": "Longitude"
},
"latitude": {
"type": "string",
"description": "Latitude"
},
"owner": {
"type": "string",
"description": "Owner"
},
"region": {
"type": "string",
"description": "Region"
},
"name": {
"type": "string",
"description": "Name"
},
"dc_id": {
"type": "string",
"description": "Data Center ID"
}
}
},
"Subnet": {
"type": "object",
"properties": {
"decentralization_score": {
"description": "Decentralization Score",
"allOf": [
{
"$ref": "#/components/schemas/DecentralizationScore"
}
]
},
"display_name": {
"type": "string",
"description": "Display Name"
},
"total_nodes": {
"type": "string",
"description": "Total Nodes"
},
"instruction_rate": {
"type": "string",
"description": "Instruction Rate"
},
"memory_usage": {
"type": "string",
"description": "Memory Usage"
},
"running_canisters": {
"type": "string",
"description": "Running Canisters"
},
"subnet_specialization": {
"type": "string",
"description": "Subnet Specialization"
},
"replica_versions": {
"type": "array",
"description": "Replica Versions",
"items": {
"$ref": "#/components/schemas/ReplicaVersion"
}
},
"total_canisters": {
"type": "string",
"description": "Total Canisters"
},
"data_centers": {
"type": "array",
"description": "Data Centers",
"items": {
"$ref": "#/components/schemas/DataCenter"
}
},
"total_countries": {
"type": "string",
"description": "Total Countries"
},
"subnet_id": {
"type": "string",
"description": "Subnet ID"
},
"subnet_authorization": {
"type": "string",
"description": "Subnet Authorization"
},
"up_nodes": {
"type": "string",
"description": "Up Nodes"
},
"message_execution_rate": {
"type": "string",
"description": "Message Execution"
},
"total_node_providers": {
"type": "string",
"description": "Total Node Providers"
},
"subnet_type": {
"type": "string",
"description": "Subnet Type"
},
"stopped_canisters": {
"type": "string",
"description": "Stopped Canisters"
}
}
},
"ListSubnetsResponse": {
"type": "object",
"properties": {
"data": {
"type": "array",
"description": "Subnets",
"items": {
"$ref": "#/components/schemas/Subnet"
}
},
"next_cursor": {
"type": "string",
"description": "Next Cursor"
},
"previous_cursor": {
"type": "string",
"description": "Previous Cursor"
}
}
},
"CountSubnetsResponse": {
"type": "object",
"properties": {
"total": {
"type": "integer",
"description": "Total"
}
}
}
},
"responses": {
"UNPROCESSABLE_ENTITY": {
"description": "Unprocessable Entity",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"DEFAULT_ERROR": {
"description": "Default error response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}
}
}