TorqueTorque

Search docs

Search Torque documentation pages and sections

Platform Data API

Shipped read-only datasets under GET /api/v1/data/*. Each pipeline is one route, one subscription SKU, and the same JSON Torque computes for in-app Home rails. Discover products via GET /api/v1/capabilities data.catalog (manifest v10). npm 0.1.2 covers funding and earnings; events is HTTP-first until SDK 0.1.3.

Product Model

Each Torque data pipeline is a sellable unit. Torque UI (Home cards, Markets tables, Assistant tools) is an optional consumer of the same pipeline, not the public API product name.

ConceptMeaning
PipelineFetch → normalize → rank → stable JSON
Data productOne pipeline exposed as one GET under /api/v1/data/{id}
SKUSame id as the route suffix (events, funding-radar, …)
Torque UIOptional in-app consumer — not the partner product name
Pipeline lib (single source of truth)
        │
        ├─ /api/home/* or in-app fetch     ← Torque UI
        ├─ /api/v1/data/{pipelineId}       ← partner API (canonical)
        └─ Assistant / TI tools            ← conversational access

Subscriptions & Entitlements

OfferingIncludesTypical Buyer
platform-data-proAll /api/v1/data/* pipelinesTerminals, full-stack dashboards
À la carte SKUOne pipeline (e.g. only events)Macro desks, earnings-only apps
opportunities add-onyield + lendingTreasury / DeFi rate tiles
Intelligence add-onFeed + desk presetsNews / carousel products
PhaseMechanism
TodayOpt-in env TORQUE_V1_WIDGETS_REQUIRE_PRO=1 + TORQUE_V1_PRO_INTEGRATOR_BUSINESS_IDS (all-or-nothing Pro gate)
RoadmapConvex business API entitlements — data.catalog.products[].id per key; bundle grants all SKUs
Responsemeta.integratorTier + future meta.entitlements[] / 403 with SKU id when not subscribed

Three Integrator Lanes

Pick the lane that matches the result, not how Torque displays it.

LaneShapeExample Endpoints
IntelligenceIntelligenceItemV1[]/intelligence/feed, /trade-angles
OpportunitiesRate rows + actions/opportunities/yield, /opportunities/lending
Platform dataPipeline-native DTOs/data/events, /data/funding-radar

Auth

Authorization: Bearer sk_live_…

Response meta.pipelineId is the subscription SKU id. meta.integratorTier is "pro" or "standard".

EnvBehavior
defaultAll active business keys
TORQUE_V1_WIDGETS_REQUIRE_PRO=1Only TORQUE_V1_PRO_INTEGRATOR_BUSINESS_IDS

Data Product Catalog

GET /api/v1/capabilities data.catalog lists SKUs, routes, and status. Legacy aliases remain for funding and earnings: /api/v1/widgets/funding-radar, /api/v1/widgets/earnings-spotlight.

SKURouteStatusTierTorque UISDK
funding-radarGET /api/v1/data/funding-radarShippedProfundinggetFundingRadarWidget()
earnings-spotlightGET /api/v1/data/earnings-spotlightShippedProearningsgetEarningsSpotlightWidget()
eventsGET /api/v1/data/eventsShippedProeventsHTTP only (SDK 0.1.3+)
moversGET /api/v1/data/moversPlannedPromovers
flight-radarGET /api/v1/data/flight-radarPlannedProflight_radar
marine-trafficGET /api/v1/data/marine-trafficPlannedPro
allocationGET /api/v1/data/allocation?walletAddress=PlannedProallocation_treemap

Sibling Lanes (Not Under /data/)

SKURouteStatusGuide
yieldGET /api/v1/opportunities/yieldShipped/api/intelligence#opportunities
lendingGET /api/v1/opportunities/lendingShipped/api/intelligence#opportunities
Intelligence presetsGET /api/v1/intelligence/*Shipped/api/intelligence

GET /api/v1/data/events

SKU: events · FOMC schedule + curated US macro + tracked earnings. Same data as the in-app Events rail and GET /api/economic-calendar (session).

Query: days look-ahead window (default 90, max 365). Response: { meta, from, to, daysAhead, events[] }. Event types: fomc, earnings, macro. Impact: high, medium, low.

fetch-events.sh
curl -sS "https://app.torque.fi/api/v1/data/events?days=30" \
  -H "Authorization: Bearer sk_live_…"

GET /api/v1/data/funding-radar

SKU: funding-radar · Hyperliquid perp funding long/short bias.

fetch-funding-radar.sh
curl -sS "https://app.torque.fi/api/v1/data/funding-radar" \
  -H "Authorization: Bearer sk_live_…"

SDK: getFundingRadarWidget() · Types: @torquefi/types/widgets

GET /api/v1/data/earnings-spotlight

SKU: earnings-spotlight · Upcoming earnings (~14 days), estimates, perp/spot flags.

fetch-earnings-spotlight.sh
curl -sS "https://app.torque.fi/api/v1/data/earnings-spotlight" \
  -H "Authorization: Bearer sk_live_…"

SDK: getEarningsSpotlightWidget()

Shared Meta

PlatformDataMetaV1
interface PlatformDataMetaV1 {
  generatedAtMs: number
  pipelineId: string       // SKU + route suffix, e.g. "events"
  homeWidgetId?: string    // Torque UI consumer — optional
  integratorTier: 'standard' | 'pro'
}

Design rules: one pipeline → one GET → one DTO → one SKU. Do not force pipeline rows into IntelligenceItemV1 when a dedicated shape exists. meta.pipelineId matches the route suffix and subscription SKU. meta.homeWidgetId is optional traceability for Torque UI, not the public product name.

npm

yarn add @torquefi/types@^0.1.2 torque-intelligence@^0.1.2
server.ts
const radar = await ti.getFundingRadarWidget()
const earnings = await ti.getEarningsSpotlightWidget()
// events — call GET /api/v1/data/events until SDK 0.1.3+

Unified client: torque-node exposes the same helpers on torque.intelligence.

See Also

Was this helpful?