Symbol Data

GET /data/symbols

Symbol Data

Responds with a list of symbols and their data including pricing and other market related data.

Responses

  • 200

    Ok

    Hide response attributes Show response attributes array[object]
    • code string Required
    • market string Required
    • marketInfo object Required
      Hide marketInfo attributes Show marketInfo attributes object
      • Alternate object Required
        Hide Alternate attributes Show Alternate attributes object
        • base string | null
        • isin string | null
        • uid string | null
      • Attributes object Required
        Hide Attributes attribute Show Attributes attribute object
        • FpsxMarket string | null
      • BestAskCount integer(int64) Required
      • BestAskHasUndisclosed boolean Required
      • BestBidCount integer(int64) Required
      • BestBidHasUndisclosed boolean Required
      • BestBuyPrice number(double) | null
      • BestSellPrice number(double) | null
      • Board string Required
      • BuyQuantity integer(int64) Required
      • CallOrPut string | null
      • Cfi string Required
      • Class string | null
      • Close number(double) | null
      • ContractSize number(double) | null
      • Currency string Required

        Values are ARS, AUD, BWP, BRL, CAD, CNH, CNY, COP, CZK, DKK, DOP, EGP, EUR, GBP, HKD, HUF, IDR, INR, ISK, JPY, KZT, LTL, LUF, MXN, MYR, TWD, NZD, NOK, PEN, PLN, KRW, RON, RUB, SGD, SKK, SIT, ZAR, SEK, CHF, THB, TRY, USD, UYU, or VND.

      • DepthDirection string Required
      • EquilibriumVolume number(double) | null
      • ExerciseType string | null
      • ExpiryDate string(date-time) | null
      • High number(double) | null
      • IndicativePrice number(double) | null
      • IsCombination boolean Required
      • IsIndex boolean Required
      • Last number(double) | null
      • LastTradedTime string(date-time) | null
      • Low number(double) | null
      • NumberOfTrades integer(int64) Required
      • Open number(double) | null
      • OpenInterest number(double) | null
      • PreviousClose number(double) | null
      • QuotationBasis string | null
      • SellQuantity integer(int64) Required
      • StartDate string(date-time) | null
      • Status string Required
      • StatusNote string | null
      • StrikePrice number(double) | null
      • SurplusVolume number(double) | null
      • TotalClassIssue string | null
      • Trend string Required

        Values are None, Up, or Down.

      • Underlying string | null
      • ValueTraded number(double) Required
      • Volume integer(int64) Required
      • Vwap number(double) | null
    • name string Required
GET /data/symbols
curl \
 -X GET http://api.example.com/data/symbols
Response examples (200)
[
  {
    "code": "string",
    "market": "string",
    "marketInfo": {
      "Alternate": {
        "base": "string",
        "isin": "string",
        "uid": "string"
      },
      "Attributes": {
        "FpsxMarket": "string"
      },
      "BestAskCount": 42,
      "BestAskHasUndisclosed": true,
      "BestBidCount": 42,
      "BestBidHasUndisclosed": true,
      "BestBuyPrice": 42.0,
      "BestSellPrice": 42.0,
      "Board": "string",
      "BuyQuantity": 42,
      "CallOrPut": "string",
      "Cfi": "string",
      "Class": "string",
      "Close": 42.0,
      "ContractSize": 42.0,
      "Currency": "ARS",
      "DepthDirection": "string",
      "EquilibriumVolume": 42.0,
      "ExerciseType": "string",
      "ExpiryDate": "2023-05-04T09:42:00+00:00",
      "High": 42.0,
      "IndicativePrice": 42.0,
      "IsCombination": true,
      "IsIndex": true,
      "Last": 42.0,
      "LastTradedTime": "2023-05-04T09:42:00+00:00",
      "Low": 42.0,
      "NumberOfTrades": 42,
      "Open": 42.0,
      "OpenInterest": 42.0,
      "PreviousClose": 42.0,
      "QuotationBasis": "string",
      "SellQuantity": 42,
      "StartDate": "2023-05-04T09:42:00+00:00",
      "Status": "string",
      "StatusNote": "string",
      "StrikePrice": 42.0,
      "SurplusVolume": 42.0,
      "TotalClassIssue": "string",
      "Trend": "None",
      "Underlying": "string",
      "ValueTraded": 42.0,
      "Volume": 42,
      "Vwap": 42.0
    },
    "name": "string"
  }
]
Response examples (200)
[
  {
    "code": "string",
    "market": "string",
    "marketInfo": {
      "Alternate": {
        "base": "string",
        "isin": "string",
        "uid": "string"
      },
      "Attributes": {
        "FpsxMarket": "string"
      },
      "BestAskCount": 42,
      "BestAskHasUndisclosed": true,
      "BestBidCount": 42,
      "BestBidHasUndisclosed": true,
      "BestBuyPrice": 42.0,
      "BestSellPrice": 42.0,
      "Board": "string",
      "BuyQuantity": 42,
      "CallOrPut": "string",
      "Cfi": "string",
      "Class": "string",
      "Close": 42.0,
      "ContractSize": 42.0,
      "Currency": "ARS",
      "DepthDirection": "string",
      "EquilibriumVolume": 42.0,
      "ExerciseType": "string",
      "ExpiryDate": "2025-05-04T09:42:00Z",
      "High": 42.0,
      "IndicativePrice": 42.0,
      "IsCombination": true,
      "IsIndex": true,
      "Last": 42.0,
      "LastTradedTime": "2025-05-04T09:42:00Z",
      "Low": 42.0,
      "NumberOfTrades": 42,
      "Open": 42.0,
      "OpenInterest": 42.0,
      "PreviousClose": 42.0,
      "QuotationBasis": "string",
      "SellQuantity": 42,
      "StartDate": "2025-05-04T09:42:00Z",
      "Status": "string",
      "StatusNote": "string",
      "StrikePrice": 42.0,
      "SurplusVolume": 42.0,
      "TotalClassIssue": "string",
      "Trend": "None",
      "Underlying": "string",
      "ValueTraded": 42.0,
      "Volume": 42,
      "Vwap": 42.0
    },
    "name": "string"
  }
]