REST API

Interact with the Convex peer network using our RESTful API endpoints

The Convex REST API allows you to interact with the network programmatically. All API endpoints are served over HTTPS and can return responses in application/json or application/cvx format.

Base URL: https://peer.convex.live/api/v1

Endpoints are documented using OpenAPI (Swagger) and are available at most Convex peers.

Open Swagger UI

API Endpoints

GET/api/v1/status

Get the current status of the Convex peer including key network and consensus information.

Example Request

bash
curl https://peer.convex.live/api/v1/status

Example Response

json
{
  "consensus-point": 605,
  "proposal-point": 605,
  "genesis": "0xb0e44f2a645abfa539f5b96b7a0eabb0f902866feaff0f7c12d1213e02333f13",
  "peer": "0xf167b15c46ea3e5db7d059230a6b18aa891418261014c4afc93e7b3c572b63a1",
  "belief": "0x3afd30f048506f504f773a7ae804ea10fd5674e474f542011a03941dc737a0e7",
  "state": "0x4a313e33da05964e930b14cdcf9385fb65dca580e9d9167a54f18b6806399cf2",
  "consensus": [605,
                605,
                605,
                605],
  "block-point": 605,
  "states": "0x4a313e33da05964e930b14cdcf9385fb65dca580e9d9167a54f18b6806399cf2"
}