GET

API index

/api/v1 · public, no key needed

Every endpoint, and who you are signed in as.

The map of the API, for people and agents: every endpoint with its docs, and links to the OpenAPI spec, the MCP server and the agent guide. With a key it also says whose account the key is for.

Request

curl "https://www.vancouverpx.ca/api/v1"

Response

200 with this object:

Field	Type	Description
name	`string`
version	`string`
docs	`string`
openapi	`string`
mcp	`string`
agents	`string`	A CLAUDE.md for coding agents: VPX and this API in one file
you	`object \| null`	Whose account your key opens, or null without one
endpoints	`object[]`

Example

{
  "name": "Vancouver Prediction Exchange API",
  "version": "1",
  "docs": "https://www.vancouverpx.ca/docs/api",
  "openapi": "https://www.vancouverpx.ca/docs/api/openapi.json",
  "mcp": "https://www.vancouverpx.ca/api/mcp",
  "agents": "https://www.vancouverpx.ca/docs/api/claude.md",
  "you": null,
  "endpoints": [
    {
      "method": "GET",
      "path": "/api/v1/markets",
      "summary": "Markets with their prices, newest first",
      "auth": "public",
      "docs": "https://www.vancouverpx.ca/docs/api/get-markets"
    }
  ]
}

Errors

The errors every endpoint can answer.

← Get a market group Get your account →