Signer Metrics API (v0.4.6)

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

200

Content type

application/json

{"server_version": "signer-metrics-api v0.0.1 (master:a1b2c3)",
"status": "ready",
"chain_tip": {"block_height": 163541
}
}

Signers

PoX Cycle Signers

List of signers for a given PoX cycle

path Parameters

cycle_number

required

integer

PoX cycle number

query Parameters

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

200

Content type

application/json

{"total": 0,
"limit": 0,
"offset": 0,
"results": [{"signer_key": "string",
"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
}
]
}

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

200
404

Content type

application/json

{"signer_key": "string",
"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
}

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

200

Content type

application/json

{"total": 0,
"limit": 0,
"offset": 0,
"results": [{"block_height": 0,
"block_hash": "string",
"block_time": 0,
"index_block_hash": "string",
"burn_block_height": 0,
"tenure_height": 0,
"signer_data": {"cycle_number": 0,
"total_signer_count": 0,
"accepted_count": 0,
"rejected_count": 0,
"missing_count": 0,
"accepted_excluded_count": 0,
"average_response_time_ms": 0,
"block_proposal_time_ms": 0,
"accepted_stacked_amount": "string",
"rejected_stacked_amount": "string",
"missing_stacked_amount": "string",
"accepted_weight": 0,
"rejected_weight": 0,
"missing_weight": 0
}
}
]
}