Skip to main content

GET Metadata

Returns the dataset metadata including which fields are available, the data type of the field, and a description.

GET /metadata/group/{group name}/name/{dataset name}

Optional Request Parameters

None.

Request Headers

header required description default
Authorization required Contains the word Basic followed by a space and a base64-encoded string of the form "clientid:clientsecret". n/a
Data-API-Version optional Used to specify version of the API to use. version 1

Sample Request

https://api.finra.org/metadata/group/otcmarket/name/weeklysummary

Sample Response


{
  "datasetGroup" : "OTCMARKET",
  "datasetName" : "WEEKLYSUMMARY",
  "partitionFields" : [ "weekStartDate", "tierIdentifier" ],
  "fields" : [ {
    "name" : "issueSymbolIdentifier",
    "type" : "String",
    "description" : "Assigned by the NASDAQ listing market and ACT Symbol for Other Exchange Listed (NMS stocks), or by FINRA (OTCE securities). Suffix is separated from root symbol with a special character"
  }, {
    "name" : "issueName",
    "type" : "String",
    "description" : "Company name associated with the Symbol"
  }, {
    "name" : "firmCRDNumber",
    "type" : "Number",
    "description" : "Firm CRD Number"
  }, {
    "name" : "MPID",
    "type" : "String",
    "description" : "ATS/OTC identifier"
  }, {
    "name" : "marketParticipantName",
    "type" : "String",
    "description" : "Company name of the ATS/OTC or or De Minimis Firm"
  }, {
    "name" : "tierIdentifier",
    "type" : "String",
    "description" : "T1 - Securities included in the S&P 500, Russell 1000 and selected exchange-traded products; T2 - All other NMS stocks; OTC - Over-the-Counter equity securities"
  }, {
    "name" : "tierDescription",
    "type" : "String",
    "description" : "NMS Tier 1 - Securities included in the S&P 500, Russell 1000 and selected exchange-traded products; NMS Tier 2 - All other NMS stocks; OTCE - Over-the-Counter equity securities"
  }, {
    "name" : "summaryStartDate",
    "type" : "Date",
    "format" : "yyyy-MM-dd",
    "description" : "Report Start Date (Monday)"
  }, {
    "name" : "totalWeeklyTradeCount",
    "type" : "Number",
    "description" : "Aggregate weekly total number of trades reported by each ATS for the Symbol"
  }, {
    "name" : "totalWeeklyShareQuantity",
    "type" : "Number",
    "description" : "Aggregate weekly total number of shares reported by each ATS for the Symbol"
  }, {
    "name" : "productTypeCode",
    "type" : "String",
    "description" : "Product Type"
  }, {
    "name" : "summaryTypeCode",
    "type" : "String",
    "description" : "Report Type Identifier ( OTC_ W_FIRM: OTC Weekly Firm, OTC_ W_SMBL: OTC Weekly Symbol, OTC_ W_SMBL_FIRM: OTC Weekly Symbol Firm, OTC_ W_VOL_STATS: OTC Volume Statistics, ATS_ W_Firm: ATS Weekly Firm, ATS_ W_SMBL: ATS Weekly Symbol, ATS_ W_SMBL_FIRM: ATS Weekly Symbol Firm, ATS_ W_VOL_STATS: ATS Volume Statistics)"
  }, {
    "name" : "weekStartDate",
    "type" : "Date",
    "format" : "yyyy-MM-dd",
    "description" : "Partition Key - the first business day of the week (Monday)"
  }, {
    "name" : "lastUpdateDate",
    "type" : "Date",
    "format" : "yyyy-MM-dd",
    "description" : "Most recent date on which total trades is updated based on data received from each ATS/OTC"
  }, {
    "name" : "initialPublishedDate",
    "type" : "Date",
    "format" : "yyyy-MM-dd",
    "description" : "The initial publish date is the first Monday or next business day after the reporting delay based on NMS Tier 1 (two week delay), NMS Tier 2 (four week delay) and OTC securities (four week delay)"
  }, {
    "name" : "lastReportedDate",
    "type" : "Date",
    "format" : "yyyy-MM-dd",
    "description" : "This date represents the last time a firm sent an update to any underlying data that contributes to the aggregate count"
  } ]
}