📚 Pricing & Reference Data Implementation Guides

Comprehensive developer guide for Pricing & Reference Data — symbols, indices, and FX rates — derived only from openapi/pricing-refdata.yaml.

🚀 Quick Navigation

  • Getting Started
  • Core Operations
  • Best Practices

🎯 API Overview & Architecture

Business Purpose

  • Provide canonical symbol/reference metadata for trading and matching
  • Expose FX rates (real-time and historical) used in pricing and settlements
  • Publish indices and composite reference data for market feeds

Technical Architecture

Clients -> API Gateway -> Pricing/Refdata Service -> Data Providers / Index Engines

Core Data Models

Defined in openapi/pricing-refdata.yaml (use these schemas exactly):

  • Symbol: symbol, name, baseAsset, quoteAsset, assetClass, tradingHours, tickSize, precision, status (ACTIVE INACTIVE), createdAt
  • FxRate: baseCurrency, quoteCurrency, rate, timestamp, source
  • Index: id, name

🎯 Quick Start

Prerequisites

  • OAuth2 token with scope read:pricing or an apiKey.

5-Minute Setup

  1. Obtain a token (OAuth2) or X-API-KEY.
  2. Call a read endpoint such as GET /refdata/symbols.

Example (curl) — list symbols:

curl -G "https://api.quub.exchange/v1/refdata/symbols" \
  --data-urlencode "assetClass=CRYPTO" \
  --data-urlencode "baseAsset=BTC" \
  -H "Authorization: Bearer <ACCESS_TOKEN>"

🏗️ Core API Operations

All operations and schemas below are taken directly from openapi/pricing-refdata.yaml.

Symbols

GET /refdata/symbols — List symbols. Query params: assetClass, baseAsset, quoteAsset, cursor, limit.

GET /refdata/symbols/{symbol} — Get symbol details. Path param: symbol.

Response: Symbol schema.

Example (Node.js) — get symbol details:

const resp = await axios.get(
  `${baseURL}/refdata/symbols/${encodeURIComponent(symbol)}`,
  {
    headers: { Authorization: `Bearer ${token}` },
  }
);
// resp.data.data -> Symbol

FX Rates

GET /refdata/fx-rates — Retrieve FX rates. Query params: base, quote, since, cursor, limit.

Response: paginated list of FxRate.

Example (curl) — get recent USD/EUR rates:

curl -G "https://api.quub.exchange/v1/refdata/fx-rates" \
  --data-urlencode "base=USD" \
  --data-urlencode "quote=EUR" \
  --data-urlencode "since={since}" \
  -H "Authorization: Bearer <ACCESS_TOKEN>"

Indices

GET /refdata/indices — List indices. Query params: type, cursor, limit.

Response: paginated list of Index.

🔐 Authentication Setup

  • Security schemes defined in the OpenAPI: bearerAuth (OAuth2), oauth2, and apiKey (see components). Use read:pricing scope for these read-only endpoints.

✨ Best Practices

  • Use pagination (cursor/limit) for large symbol lists.
  • Filter by assetClass or baseAsset to reduce payloads.
  • For FX rates historical retrieval use since with ISO date-time.

🔍 Troubleshooting

  • 400: BadRequest — invalid query parameters.
  • 401/403: auth/permission issues — verify token scopes and API key permissions.
  • 429: rate limits — implement exponential backoff.

📚 Additional Resources

  • OpenAPI spec: /openapi/pricing-refdata.yaml (source of truth)
  • API docs: /capabilities/pricing-refdata/api-documentation/

This guide was generated strictly from openapi/pricing-refdata.yaml and existing capability docs; no endpoints or schema properties were invented.

layout: docs title: Pricing Refdata Guides permalink: /capabilities/pricing-refdata/guides/

Pricing Refdata Implementation Guides

Comprehensive guides for implementing and integrating Pricing Refdata capabilities.

📚 Available Guides

Getting Started

Best Practices

Advanced Topics

Migration & Deployment

For API reference, see Pricing Refdata API Documentation

Edit this page on GitHub