DOCUMENTATIONv2

GET

Price feeds

List delivery plans

/api/v2/price-feed-plans

AUTHENTICATIONBearer token · pricing:readAUTHORITATIVE OWNERmarket-data-serviceCONTRACT AUTHORITYGenerated Rust OpenAPISTATUSSource ready · production listed

PURPOSE + BUSINESS CONTEXT

List active price-delivery plans and the feed, connection, cadence, replay-window, and retention limits agents must evaluate before planning a subscription.

WHEN THIS CALL IS USEFUL

Use before planning a delivery subscription so the integration can select an active plan from authoritative limits instead of hard-coding DEVELOPER or guessing entitlements.

OUTCOME · Discover

What changes

Read-only projection; it grants no mutation, settlement, traffic, or authority change.

WHY IT MATTERS

Gives people and agents a contract-backed way to discover delivery plans.
Makes feed provenance, quality, delivery entitlement, replay limits, and workspace-owned composite policy explicit before price data enters valuation or decision workflows.

ISOLATION + AUTHORITY

Instrument, provider, observation, signature, hash-chain, aggregation, composite owner, subscription, delivery, billing, valuation, market, and trading boundaries remain distinct. A feed, snapshot, replay, plan, or subscription supplies data only and grants no oracle-finality, valuation approval, publisher, order, matching, settlement, or trading authority.

BEFORE YOU CALL

Authenticate at the documented boundary: bearer+scope.
Use the live OpenAPI schema as the authority for the exact request shape and response model.
Resolve the canonical instrument and feed, source and aggregation policy, required freshness and quality, and any subscription entitlement or replay window.

WHAT TO DO NEXT

Select a canonical feed identifier and inspect its source composition, normalization, cadence, quality, and failover policy.
Verify the latest signed snapshot or bounded history under the selected feed and any required subscription entitlement.

AGENT GUIDANCE

Use delivery plans only for the purpose and lifecycle stage described by this operation; do not treat it as authority for an adjacent action.
Use the live OpenAPI schema as the authority for the exact request shape and response model.
Preserve decimal values and observation timestamps exactly; distinguish source time, ingestion time, sequence, freshness, health, quality, aggregation, delivery entitlement, and business acceptance.
Use response links and canonical identifiers instead of constructing internal service URLs or scraping the website.

MACHINE CONTRACT

The exact deployed parameters, schemas, responses, security requirements, and Hybrid-Chain agent metadata are authoritative at this operation's production OpenAPI JSON Pointer. The readable tables below add integration guidance; the deployed OpenAPI controls if guidance and the machine contract ever differ.

Open the authoritative production contract ↗

EXTENDED INTEGRATION GUIDANCE

Readable request and response reference

Examples illustrate integration intent; the referenced OpenAPI operation and component schemas define the executable shape.

PARAMETERS

Headers, path, query, and body

NAMELOCATIONPRESENCETYPE / RULES / PURPOSE

AuthorizationheaderRequired

Bearer tokenCredential containing the pricing:read scope.EXAMPLEBearer hc_live_…

RESPONSES

Status and payload examples

200Active delivery plans with their feed, connection, cadence, replay, and retention entitlements.Read completed · JSON RESPONSE+

{
  "items": [
    {
      "code": "DEVELOPER",
      "name": "Developer",
      "max_feeds": 5,
      "max_connections": 2,
      "replay_window_minutes": 1440,
      "min_cadence_ms": 1000,
      "retained_history_days": 7
    }
  ]
}

INTEGRATION DECISION

CALLER ACTION: Accept the returned representation or receipt, then select a canonical feed identifier and inspect its source composition, normalization, cadence, quality, and failover policy.
RETRY SAFETY: Repeat only when the integration needs a fresher authoritative projection.
STATE RECONCILIATION: Use returned identifiers and versions as the comparison point for later reads. Refresh the feed, source mapping, observation timestamp, quality and staleness state, policy version, and delivery or command receipt.

401The bearer credential is missing, expired, or invalid.Authentication required · JSON RESPONSE+

{
  "code": "invalid_credentials",
  "message": "The bearer credential is missing, expired, or invalid."
}

INTEGRATION DECISIONinvalid_credentials

CALLER ACTION: Discard the rejected credential, complete the documented authentication or reassertion flow, and rebuild any request signature with fresh timestamps and nonces.
RETRY SAFETY: Retry only with a newly valid credential and fresh replay-protection values. Do not replay an expired signature.
STATE RECONCILIATION: Authentication failed before an authoritative read was returned for workspace price-feed definitions, source mappings, observations, quality status, subscriptions, and delivery receipts.
ESCALATE WHEN: Escalate when source identity, observation time, confidence, staleness, entitlement, or delivery evidence cannot be reconciled.

403The credential lacks pricing:read or the subscription does not entitle this replay.Authority or policy denied · JSON RESPONSE+

{
  "code": "insufficient_scope",
  "message": "The credential lacks pricing:read or the subscription does not entitle this replay."
}

INTEGRATION DECISIONinsufficient_scope

CALLER ACTION: Verify the exact scope, tenant or workspace membership, owner boundary, step-up purpose, feature policy, and resource eligibility. Never broaden authority automatically.
RETRY SAFETY: Do not retry until the missing authority or policy condition has been deliberately resolved with least privilege.
STATE RECONCILIATION: Confirm the caller and resource resolve to the same authority boundary for workspace price-feed definitions, source mappings, observations, quality status, subscriptions, and delivery receipts.
ESCALATE WHEN: Escalate when source identity, observation time, confidence, staleness, entitlement, or delivery evidence cannot be reconciled.

503The authoritative Core pricing projection is unavailable.Dependency unavailable or outcome uncertain · JSON RESPONSE+

{
  "code": "price_feeds_unavailable",
  "message": "The authoritative Core pricing projection is unavailable."
}

INTEGRATION DECISIONprice_feeds_unavailable

CALLER ACTION: Treat the failure as transient and preserve the last known good representation without presenting it as fresh.
RETRY SAFETY: Retry with bounded exponential backoff and jitter; stop after the integration's failure budget is exhausted.
STATE RECONCILIATION: Refresh the feed, source mapping, observation timestamp, quality and staleness state, policy version, and delivery or command receipt.
ESCALATE WHEN: Escalate when source identity, observation time, confidence, staleness, entitlement, or delivery evidence cannot be reconciled.

OPERATIONAL NOTES

Security and lifecycle guarantees

Fetch this catalog before planning a delivery subscription; plan codes and limits are server-owned and should never be guessed or frozen into agent logic.
Compare max_feeds, max_connections, min_cadence_ms, replay_window_minutes, and retained_history_days with the workload's real-time delivery and audit requirements.
min_cadence_ms is a lower delivery-frequency bound: an entitled feed is delivered no faster than the greater of its own cadence and the plan minimum.
Replay and retention limits describe entitlements, not proof that evidence exists for every instant. No query parameters or request body are accepted; responses are no-store.

DOCUMENTATION STATUS

This route is implemented in canonical gateway source and appears in the production OpenAPI snapshot observed 2026-09-11T06:35:11.572Z. Authentication, tenant, feature, venue, and market policy still apply.

Verify the exact production OpenAPI operation ↗Return to the V2 directory ↗