Developer Ecosystem & API References

Engine Docs. Real Core APIs.

Production Host

https://api.verterfin.prime/v1

Authentication Header

X-Verterfin-API-Key

Rate Limits

120 requests / sec (P99)

GET

/auth/verify

All requests issued to Verterfin Prime must be authenticated via a valid organization API key. In order to mitigate replay vectors, your infrastructure must generate cryptographic HMAC hex signatures matching current request epoch block ticks.

Warning: Production keys carry direct authorization privileges over programmatic escrow accounts. Never log keys or deploy client-exposed frontends containing plaintext secret tokens.

Request Syntax
curl -X GET "https://api.verterfin.prime/v1/auth/verify" \
  -H "X-Verterfin-API-Key: vf_live_7a9f2c8d..." \
  -H "X-Verterfin-Signature: t=1717056000,v1=e3b0c442..."
Response Wire Format (200 OK)
{
  "authenticated": true,
  "organization_id": "org_91c28f3b",
  "permissions": ["read:liquidity", "write:deployments"],
  "environment": "production"
}
GET

/markets/book

Queries aggregated multi-venue book layers inside our digital clearing nodes. This endpoint retrieves depth statistics, target market tracking spreads, and institutional bid/ask order configurations inside a consolidated view.

symbolstring (e.g., BTC-USDC)
depthinteger [1 - 500]
Order Book Query
curl -X GET "https://api.verterfin.prime/v1/markets/book?symbol=BTC-USDC" \
  -H "X-Verterfin-API-Key: vf_live_7a9f2c8d..."
Response Wire Format (200 OK)
{
  "symbol": "BTC-USDC",
  "timestamp": 1717056000142,
  "target_spread": "0.01%",
  "aggregated_depth_1pct": "450000000.00",
  "bids": [["67250.00", "4.215"], ["67249.50", "12.801"]],
  "asks": [["67250.50", "3.114"], ["67251.00", "9.452"]]
}
POST

/tranches/deploy

Deploys automated institutional liquidity units directly into a specified real-world credit facility. Passing the parameter isolated_escrow: true completely instantiates an isolated ledger context container for the fund pool.

facility_idstring (Required)
allocation_amountfloat (Required)
isolated_escrowboolean (Default: true)
Tranche Deployment Payload
curl -X POST "https://api.verterfin.prime/v1/tranches/deploy" \
  -H "X-Verterfin-API-Key: vf_live_7a9f2c8d..." \
  -H "Content-Type: application/json" \
  -d '{
    "facility_id": "fac_agri_01",
    "allocation_amount": 500000.00,
    "currency": "USDC",
    "isolated_escrow": true
  }'
Response Wire Format (201 Created)
{
  "deployment_id": "dep_tranche_88f21a",
  "facility_id": "fac_agri_01",
  "status": "cleared",
  "escrow_address": "0x742d35Cc6634C0532925a3b844Bc454e4438f44e",
  "clearing_latency_ms": 138,
  "timestamp": 1717056004000
}

Real-Time Webhooks

Receive instant JSON payloads directly inside your network backend when clearing events complete, dynamic LTV thresholds transition, or operational oracle updates publish to the public ledger tracking systems.

signature_verification: mandatory
tranche.clearedActive
escrow.ltv_alertActive
reserve.buffer_rebalanceActive