API docs by Redocly

Signer Metrics API (v0.12.0)

Download OpenAPI specification:Download

Welcome to the API reference overview for the Signer Metrics API.

Source Repository

Status

Service status endpoints

API Status

Displays the status of the API and its current workload

Responses

Response samples

Content type
application/json
{
  • "server_version": "signer-metrics-api v0.0.1 (master:a1b2c3)",
  • "status": "ready",
  • "chain_tip": {
    }
}

Signers

PoX Cycle Signers

List of signers for a given PoX cycle

path Parameters
cycle_number
required
integer

PoX cycle number

query Parameters
from
string

Start of time range (e.g., now-2h or ISO timestamp)

to
string

End of time range (e.g., now or ISO timestamp)

limit
required
integer
Default: 100

Number of results to return (default: 100)

offset
required
integer
Default: 0

Number of results to skip (default: 0)

Responses

Response samples

Content type
application/json
{
  • "total": 0,
  • "limit": 0,
  • "offset": 0,
  • "results": [
    ]
}

PoX Cycle Signer

Get stats for a specific signer in a given PoX cycle

path Parameters
cycle_number
required
integer

PoX cycle number

signer_id
required
string

Signer public key (hex encoded)

Responses

Response samples

Content type
application/json
{
  • "signer_key": "string",
  • "slot_index": 0,
  • "weight": 0,
  • "weight_percentage": 0,
  • "stacked_amount": "string",
  • "stacked_amount_percent": 0,
  • "stacked_amount_rank": 0,
  • "proposals_accepted_count": 0,
  • "proposals_rejected_count": 0,
  • "proposals_missed_count": 0,
  • "average_response_time_ms": 0,
  • "last_seen": "string",
  • "version": "string"
}

Blocks

Aggregated signer information for most recent blocks

Aggregated signer information for most recent blocks

query Parameters
limit
required
integer
Default: 100

Number of results to return

offset
required
integer
Default: 0

Number of results to skip

Responses

Response samples

Content type
application/json
{
  • "total": 0,
  • "limit": 0,
  • "offset": 0,
  • "results": [
    ]
}

Aggregated signer information for a block

Aggregated signer information for a block

path Parameters
required
string or Block hash (string) or Block height (integer)

Responses

Response samples

Content type
application/json
{
  • "block_height": 0,
  • "block_hash": "string",
  • "block_time": 0,
  • "index_block_hash": "string",
  • "burn_block_height": 0,
  • "tenure_height": 0,
  • "signer_data": {
    }
}

Blocks Proposals

Signer information for most recent block proposals

Signer information for most recent block proposals

query Parameters
limit
required
integer [ 1 .. 50 ]
Default: 25

Number of results to return

offset
required
integer
Default: 0

Number of results to skip

Responses

Response samples

Content type
application/json
{
  • "limit": 0,
  • "offset": 0,
  • "results": [
    ]
}

Signer information for most recent block proposals

Signer information for most recent block proposals

path Parameters
block_hash
required
string (Block hash) ^(0x)?[a-fA-F0-9]{64}$
Example: 0xdaf79950c5e8bb0c620751333967cdd62297137cdaf79950c5e8bb0c62075133

Block hash

query Parameters
limit
required
integer [ 1 .. 50 ]
Default: 25

Number of results to return

offset
required
integer
Default: 0

Number of results to skip

Responses

Response samples

Content type
application/json
{
  • "received_at": "string",
  • "block_height": 0,
  • "block_hash": "string",
  • "index_block_hash": "string",
  • "burn_block_height": 0,
  • "block_time": 0,
  • "cycle_number": 0,
  • "status": "pending",
  • "push_time_ms": { },
  • "total_signer_count": 0,
  • "total_signer_weight": 0,
  • "total_signer_stacked_amount": "string",
  • "accepted_count": 0,
  • "rejected_count": 0,
  • "missing_count": 0,
  • "accepted_weight": 0,
  • "rejected_weight": 0,
  • "missing_weight": 0,
  • "signer_data": [
    ]
}

Prometheus Metrics

API Signer Prometheus Metrics

Retreives the Prometheus metrics signer and block proposal related data

Responses