Developer Gateway

ValkX Chain API documentation.

Use these working REST routes for chain health, API keys, FIX execution reports, reconciliation, BBO status, paper trading, live approvals, and trade-ticket workflows.

Generate User API Key Admin Console

Auth Header

Header X-VALKX-API-KEY: vxk_...

Key Manager /key-api/health

Working Public API Routes

Area	Route	Method	Scope	Purpose
Core Chain	`/api/health`	GET	`health:read`	Chain status, height, validity, latest hash.
API Keys	`/key-api/health`	GET	`health:read`	API key manager health.
API Keys	`/key-api/create`	POST	`keys:create`	Create client API key. Key is shown once.
API Keys	`/key-api/validate`	POST	n/a	Validate key and scope.
API Keys	`/key-api/logs`	GET	`keys:admin`	Usage and error logs.
FIX Execution	`/fix-exec-api/health`	GET	`fix:read`	FIX execution listener health.
FIX Execution	`/fix-exec-api/parse`	POST	`fix:read`	Parse FIX 4.2/4.4 message.
FIX Execution	`/fix-exec-api/ingest`	POST	`fix:submit`	Ingest 35=8 ExecutionReport and update order state.
FIX Execution	`/fix-exec-api/reports`	GET	`fix:read`	Read execution reports.
Reconciliation	`/recon-api/health`	GET	`recon:read`	Reconciliation service health.
Reconciliation	`/recon-api/run`	POST	`recon:run`	Run reconciliation.
Reconciliation	`/recon-api/latest`	GET	`recon:read`	Latest reconciliation result.
Reconciliation	`/recon-api/issues`	GET	`recon:read`	Current reconciliation issues.
BBO	`/bbo-api/health`	GET	`market:read`	BBO connector health.
Risk	`/risk-api/health`	GET	`risk:read`	Risk API health.
Paper Trading	`/paper-api/health`	GET	`trade:paper`	Paper trading health.
Approval	`/approval-api/health`	GET	`trade:live_request`	Live approval service health.
Trade Ticket	`/trade-api/health`	GET	`trade:preview`	Trade ticket service health.

Create API Key

Creates a basic scoped API key. Copy the key immediately; it is shown once.

curl -k -X POST https://valkx.net/key-api/create \
  -H "Content-Type: application/json" \
  -d '{
    "username":"client_user",
    "email":"client@example.com",
    "role":"basic",
    "label":"client-integration",
    "scopes":["health:read","market:read","fix:read","fix:submit","recon:read","audit:read"]
  }'

Validate API Key

Checks whether a key can use a requested scope.

curl -k -X POST https://valkx.net/key-api/validate \
  -H "Content-Type: application/json" \
  -d '{
    "api_key":"vxk_PASTE_KEY_HERE",
    "scope":"health:read",
    "request_path":"/api/health"
  }'

Ingest FIX Execution Report

Accepts FIX 4.2/4.4 35=8 ExecutionReport messages using pipe or SOH separators.

curl -k -X POST https://valkx.net/fix-exec-api/ingest \
  -H "Content-Type: application/json" \
  -H "X-VALKX-API-KEY: vxk_PASTE_KEY_HERE" \
  -d '{
    "source":"partner",
    "connection_id":"bbo-main",
    "raw_fix":"8=FIX.4.4|35=8|11=CL123|37=ORD123|17=EX123|150=2|39=2|55=ROCX|54=1|38=100|32=100|31=1.23|14=100|151=0|6=1.23|"
  }'

Run Reconciliation

Compares FIX reports, order state, paper fills, live router attempts, and audit activity.

curl -k -X POST https://valkx.net/recon-api/run \
  -H "Content-Type: application/json" \
  -H "X-VALKX-API-KEY: vxk_PASTE_KEY_HERE" \
  -d '{}'

API Health Check

Checks public service health routes.

Click “Run Health Check”.