{"components":{"schemas":{"AddressError":{"additionalProperties":false,"properties":{"address":{"description":"The address as we read it, null when it couldn't be read, since it may have been a key","type":["string","null"]},"code":{"enum":["invalid_symbol","instrument_not_found","not_supported","data_unavailable","data_pending","source_failed"],"type":"string"},"message":{"type":"string"}},"required":["address","code","message"],"type":"object"},"Balance":{"additionalProperties":false,"properties":{"address":{"description":"The derived address, on derived rows only","type":["string","null"]},"amount":{"description":"Raw on-chain integer, divide by 10^decimals for whole units","examples":["1500000"],"type":"string"},"asset":{"description":"native for the chain's own coin, else the token contract","type":"string"},"decimals":{"examples":[6],"format":"int64","type":"integer"},"path":{"description":"The derivation path, on derived rows only","examples":["m/84'/0'/0'/0/0"],"type":["string","null"]},"reputation":{"description":"listed for the chain's own coin and tokens a token list knows. spam when the indexer flags it or its name advertises a site or a claim, the usual airdrop scam. unlisted for anything else","enum":["listed","unlisted","spam"],"type":"string"},"symbol":{"examples":["USDC"],"type":"string"},"value":{"description":"Whole units at the latest price. Spam is never valued, and an unlisted token only once we know it, so quote it with /v1/quotes first. Also null when the asset has no price or we couldn't price it in time, so ask again shortly for those","format":"double","type":["number","null"]}},"required":["asset","symbol","decimals","amount","reputation","value","address","path"],"type":"object"},"CalendarEarnings":{"additionalProperties":false,"properties":{"currency":{"type":["string","null"]},"epsActual":{"format":"double","type":["number","null"]},"epsEstimate":{"format":"double","type":["number","null"]},"periodEnd":{"format":"date","type":["string","null"]},"reportTime":{"enum":["before_open","after_close","during_market"],"type":["string","null"]}},"required":["reportTime","periodEnd","currency","epsEstimate","epsActual"],"type":"object"},"CalendarEvent":{"additionalProperties":false,"properties":{"date":{"description":"The exchange's local date, the UTC date for economic releases","format":"date","type":"string"},"earnings":{"$ref":"#/components/schemas/CalendarEarnings"},"economic":{"$ref":"#/components/schemas/CalendarRelease"},"ipo":{"$ref":"#/components/schemas/CalendarIPO"},"name":{"description":"The company, or the release","type":"string"},"region":{"description":"The MIC or country the event belongs to","type":"string"},"symbol":{"description":"null for IPOs and economic releases","type":["string","null"]}},"required":["date","region","symbol","name","earnings","ipo","economic"],"type":"object"},"CalendarEventList":{"additionalProperties":false,"properties":{"data":{"items":{"$ref":"#/components/schemas/CalendarEvent"},"type":"array"},"meta":{"$ref":"#/components/schemas/PageMeta"}},"required":["data","meta"],"type":"object"},"CalendarIPO":{"additionalProperties":false,"properties":{"currency":{"type":["string","null"]},"price":{"format":"double","type":["number","null"]},"priceHigh":{"format":"double","type":["number","null"]},"priceLow":{"format":"double","type":["number","null"]},"shares":{"format":"double","type":["number","null"]},"status":{"enum":["expected","priced","withdrawn"],"type":["string","null"]},"ticker":{"description":"null until the exchange assigns one","type":["string","null"]}},"required":["status","ticker","priceLow","priceHigh","price","currency","shares"],"type":"object"},"CalendarRelease":{"additionalProperties":false,"properties":{"actual":{"format":"double","type":["number","null"]},"forecast":{"format":"double","type":["number","null"]},"importance":{"enum":["low","medium","high"],"type":["string","null"]},"period":{"description":"The period the figure covers, as published, like Aug or Q2","type":["string","null"]},"previous":{"format":"double","type":["number","null"]},"time":{"format":"date-time","type":["string","null"]},"unit":{"type":["string","null"]}},"required":["time","period","importance","actual","forecast","previous","unit"],"type":"object"},"CapitalReturnDetail":{"additionalProperties":false,"properties":{"amount":{"description":"Per share","format":"double","type":["number","null"]},"currency":{"type":["string","null"]}},"required":["amount","currency"],"type":"object"},"ChainInfo":{"additionalProperties":false,"properties":{"evmChainId":{"description":"The EIP-155 chain id, null for chains that aren't EVM","format":"int64","type":["integer","null"]},"id":{"examples":["solana"],"type":"string"},"kind":{"enum":["evm","utxo","svm","tvm","other"],"type":"string"},"name":{"examples":["Solana"],"type":"string"},"namespace":{"examples":["SOLANA"],"type":"string"},"nativeDecimals":{"examples":[9],"format":"int64","type":"integer"},"nativeSymbol":{"examples":["SOL"],"type":"string"}},"required":["id","name","kind","namespace","evmChainId","nativeSymbol","nativeDecimals"],"type":"object"},"ChainInfoList":{"additionalProperties":false,"properties":{"data":{"items":{"$ref":"#/components/schemas/ChainInfo"},"type":"array"},"meta":{"$ref":"#/components/schemas/PageMeta"}},"required":["data","meta"],"type":"object"},"CompanyProfile":{"additionalProperties":false,"properties":{"asOf":{"description":"The point in time this data describes. For history and events it's the date of the newest record, or the end of your range when there are none. Live values give when they were observed, and reference data gives when we last checked it with a source","format":"date-time","type":"string"},"cik":{"description":"SEC Central Index Key, for SEC registrants","type":["string","null"]},"country":{"examples":["AU"],"type":["string","null"]},"industry":{"description":"Industry id from /v1/sectors","examples":["diversified_mining"],"type":["string","null"]},"instrument":{"$ref":"#/components/schemas/Instrument","description":"What the symbol resolved to"},"lei":{"description":"Legal Entity Identifier","type":["string","null"]},"logo":{"description":"URL of the logo, served by us","format":"uri","type":["string","null"]},"name":{"type":"string"},"sector":{"description":"Sector id from /v1/sectors","examples":["materials"],"type":["string","null"]},"symbol":{"description":"The symbol as sent","type":"string"}},"required":["name","sector","industry","country","logo","lei","cik","symbol","instrument","asOf"],"type":"object"},"CompanyProfileBatch":{"additionalProperties":false,"properties":{"data":{"items":{"$ref":"#/components/schemas/CompanyProfile"},"type":"array"},"errors":{"items":{"$ref":"#/components/schemas/SymbolError"},"type":"array"},"meta":{"$ref":"#/components/schemas/Meta"}},"required":["data","errors","meta"],"type":"object"},"CorporateAction":{"additionalProperties":false,"properties":{"announcedDate":{"format":"date","type":["string","null"]},"delisting":{"$ref":"#/components/schemas/DelistingDetail"},"demerger":{"$ref":"#/components/schemas/DemergerDetail"},"effectiveDate":{"description":"The ex date of splits and demergers, the first day under a new symbol or name, the last trading day before a delisting","format":"date","type":"string"},"merger":{"$ref":"#/components/schemas/MergerDetail"},"nameChange":{"$ref":"#/components/schemas/RenameDetail"},"returnOfCapital":{"$ref":"#/components/schemas/CapitalReturnDetail"},"split":{"$ref":"#/components/schemas/SplitDetail","description":"Filled in for split and consolidation"},"status":{"enum":["announced","confirmed","completed","cancelled"],"type":"string"},"symbolChange":{"$ref":"#/components/schemas/RenameDetail"},"type":{"enum":["split","consolidation","demerger","merger","return_of_capital","symbol_change","name_change","delisting"],"type":"string"}},"required":["type","status","effectiveDate","announcedDate","split","demerger","merger","returnOfCapital","symbolChange","nameChange","delisting"],"type":"object"},"CorporateActions":{"additionalProperties":false,"properties":{"actions":{"description":"Oldest effective date first","items":{"$ref":"#/components/schemas/CorporateAction"},"type":"array"},"asOf":{"description":"The point in time this data describes. For history and events it's the date of the newest record, or the end of your range when there are none. Live values give when they were observed, and reference data gives when we last checked it with a source","format":"date-time","type":"string"},"instrument":{"$ref":"#/components/schemas/Instrument","description":"What the symbol resolved to"},"symbol":{"description":"The symbol as sent","type":"string"}},"required":["actions","symbol","instrument","asOf"],"type":"object"},"CorporateActionsBatch":{"additionalProperties":false,"properties":{"data":{"items":{"$ref":"#/components/schemas/CorporateActions"},"type":"array"},"errors":{"items":{"$ref":"#/components/schemas/SymbolError"},"type":"array"},"meta":{"$ref":"#/components/schemas/Meta"}},"required":["data","errors","meta"],"type":"object"},"CurrencyInfo":{"additionalProperties":false,"properties":{"code":{"examples":["AUD"],"type":"string"},"minorUnits":{"description":"Decimal places of the minor unit, null for units without one like gold","examples":[2],"format":"int64","type":["integer","null"]},"name":{"examples":["Australian Dollar"],"type":"string"}},"required":["code","name","minorUnits"],"type":"object"},"CurrencyInfoList":{"additionalProperties":false,"properties":{"data":{"items":{"$ref":"#/components/schemas/CurrencyInfo"},"type":"array"},"meta":{"$ref":"#/components/schemas/PageMeta"}},"required":["data","meta"],"type":"object"},"DailyBar":{"additionalProperties":false,"properties":{"close":{"format":"double","type":"number"},"date":{"format":"date","type":"string"},"high":{"format":"double","type":["number","null"]},"low":{"format":"double","type":["number","null"]},"open":{"format":"double","type":["number","null"]},"volume":{"format":"double","type":["number","null"]}},"required":["date","open","high","low","close","volume"],"type":"object"},"DailySeries":{"additionalProperties":false,"properties":{"adjust":{"enum":["none","splits","total"],"type":"string"},"asOf":{"description":"The point in time this data describes. For history and events it's the date of the newest record, or the end of your range when there are none. Live values give when they were observed, and reference data gives when we last checked it with a source","format":"date-time","type":"string"},"bars":{"items":{"$ref":"#/components/schemas/DailyBar"},"type":"array"},"currency":{"type":"string"},"instrument":{"$ref":"#/components/schemas/Instrument","description":"What the symbol resolved to"},"symbol":{"description":"The symbol as sent","type":"string"}},"required":["currency","adjust","bars","symbol","instrument","asOf"],"type":"object"},"DailySeriesBatch":{"additionalProperties":false,"properties":{"data":{"items":{"$ref":"#/components/schemas/DailySeries"},"type":"array"},"errors":{"items":{"$ref":"#/components/schemas/SymbolError"},"type":"array"},"meta":{"$ref":"#/components/schemas/Meta"}},"required":["data","errors","meta"],"type":"object"},"DelistingDetail":{"additionalProperties":false,"properties":{"reason":{"description":"As the exchange gave it","type":["string","null"]}},"required":["reason"],"type":"object"},"DemergerAU":{"additionalProperties":false,"properties":{"costBaseApportionmentPct":{"description":"Share of the original cost base that moves to the demerged company, as the ATO sets it","format":"double","type":["number","null"]}},"required":["costBaseApportionmentPct"],"type":"object"},"DemergerDetail":{"additionalProperties":false,"properties":{"au":{"$ref":"#/components/schemas/DemergerAU"},"child":{"description":"The demerged company's symbol, null until it's known","type":["string","null"]},"childName":{"description":"The demerged company","type":["string","null"]},"ratio":{"description":"Demerged shares for every share held","format":"double","type":["number","null"]}},"required":["childName","child","ratio","au"],"type":"object"},"Dividend":{"additionalProperties":false,"properties":{"adjustedAmount":{"description":"Per share today, after every split and consolidation since the ex date","format":"double","type":"number"},"amount":{"description":"Per share as declared","format":"double","type":"number"},"au":{"$ref":"#/components/schemas/DividendAU","description":"Australian franking, null fields elsewhere"},"currency":{"examples":["AUD"],"type":"string"},"declaredDate":{"format":"date","type":["string","null"]},"drp":{"$ref":"#/components/schemas/DividendDRP","description":"Dividend reinvestment plan, null fields when there is none"},"exDate":{"format":"date","type":"string"},"payDate":{"format":"date","type":["string","null"]},"recordDate":{"format":"date","type":["string","null"]},"status":{"enum":["announced","confirmed","paid","cancelled"],"type":"string"},"type":{"enum":["regular","interim","final","special","return_of_capital","capital_gains"],"type":"string"}},"required":["exDate","type","status","declaredDate","recordDate","payDate","amount","adjustedAmount","currency","drp","au"],"type":"object"},"DividendAU":{"additionalProperties":false,"properties":{"conduitForeignIncome":{"description":"Per share, in the dividend's currency","format":"double","type":["number","null"]},"frankedPct":{"description":"Share of the dividend that is franked, 0 to 100","format":"double","type":["number","null"]},"frankingCredit":{"description":"Per share, in the dividend's currency","format":"double","type":["number","null"]},"taxRatePct":{"description":"Company tax rate the credit was worked out at","format":"double","type":["number","null"]}},"required":["frankedPct","frankingCredit","taxRatePct","conduitForeignIncome"],"type":"object"},"DividendDRP":{"additionalProperties":false,"properties":{"discountPct":{"description":"Discount to market the plan gives, 0 to 100","format":"double","type":["number","null"]},"price":{"description":"Reinvestment price per share, in the dividend's currency","format":"double","type":["number","null"]}},"required":["price","discountPct"],"type":"object"},"Dividends":{"additionalProperties":false,"properties":{"asOf":{"description":"The point in time this data describes. For history and events it's the date of the newest record, or the end of your range when there are none. Live values give when they were observed, and reference data gives when we last checked it with a source","format":"date-time","type":"string"},"dividends":{"description":"Oldest ex date first","items":{"$ref":"#/components/schemas/Dividend"},"type":"array"},"instrument":{"$ref":"#/components/schemas/Instrument","description":"What the symbol resolved to"},"symbol":{"description":"The symbol as sent","type":"string"}},"required":["dividends","symbol","instrument","asOf"],"type":"object"},"DividendsBatch":{"additionalProperties":false,"properties":{"data":{"items":{"$ref":"#/components/schemas/Dividends"},"type":"array"},"errors":{"items":{"$ref":"#/components/schemas/SymbolError"},"type":"array"},"meta":{"$ref":"#/components/schemas/Meta"}},"required":["data","errors","meta"],"type":"object"},"Earning":{"additionalProperties":false,"properties":{"currency":{"type":"string"},"epsActual":{"format":"double","type":["number","null"]},"epsEstimate":{"format":"double","type":["number","null"]},"fiscalPeriod":{"enum":["FY","H1","H2","Q1","Q2","Q3","Q4"],"type":"string"},"fiscalYear":{"examples":[2026],"format":"int64","type":"integer"},"periodEnd":{"format":"date","type":["string","null"]},"reportDate":{"format":"date","type":["string","null"]},"reportTime":{"description":"When on the report date, relative to the exchange's session","enum":["before_open","after_close","during_market"],"type":["string","null"]},"revenueActual":{"format":"double","type":["number","null"]},"revenueEstimate":{"format":"double","type":["number","null"]}},"required":["fiscalYear","fiscalPeriod","periodEnd","reportDate","reportTime","currency","epsActual","epsEstimate","revenueActual","revenueEstimate"],"type":"object"},"Earnings":{"additionalProperties":false,"properties":{"asOf":{"description":"The point in time this data describes. For history and events it's the date of the newest record, or the end of your range when there are none. Live values give when they were observed, and reference data gives when we last checked it with a source","format":"date-time","type":"string"},"earnings":{"items":{"$ref":"#/components/schemas/Earning"},"type":"array"},"instrument":{"$ref":"#/components/schemas/Instrument","description":"What the symbol resolved to"},"symbol":{"description":"The symbol as sent","type":"string"}},"required":["earnings","symbol","instrument","asOf"],"type":"object"},"EarningsBatch":{"additionalProperties":false,"properties":{"data":{"items":{"$ref":"#/components/schemas/Earnings"},"type":"array"},"errors":{"items":{"$ref":"#/components/schemas/SymbolError"},"type":"array"},"meta":{"$ref":"#/components/schemas/Meta"}},"required":["data","errors","meta"],"type":"object"},"Exchange":{"additionalProperties":false,"properties":{"aliases":{"description":"Other names symbols can use for this exchange, like ASX","items":{"type":"string"},"type":"array"},"breaks":{"description":"Midday pauses, local time","items":{"$ref":"#/components/schemas/LocalBreak"},"type":"array"},"close":{"description":"Regular session close, local time","examples":["16:00"],"type":"string"},"country":{"examples":["AU"],"type":"string"},"currency":{"examples":["AUD"],"type":"string"},"mic":{"examples":["XASX"],"type":"string"},"name":{"type":"string"},"open":{"description":"Regular session open, local time","examples":["10:00"],"type":"string"},"operatingMic":{"examples":["XASX"],"type":"string"},"quoteUnit":{"description":"The minor unit prices are quoted in, like GBX, null when quoted in major units","type":["string","null"]},"timezone":{"description":"IANA timezone the hours are in","examples":["Australia/Sydney"],"type":"string"},"weekend":{"items":{"enum":["monday","tuesday","wednesday","thursday","friday","saturday","sunday"],"type":"string"},"type":"array"}},"required":["mic","operatingMic","aliases","name","country","timezone","currency","quoteUnit","open","close","breaks","weekend"],"type":"object"},"ExchangeCalendar":{"additionalProperties":false,"properties":{"holidays":{"description":"Weekdays in the range the exchange is closed or closes early","items":{"$ref":"#/components/schemas/ExchangeHoliday"},"type":"array"},"mic":{"examples":["XASX"],"type":"string"},"sessions":{"description":"Every trading day in the range","items":{"$ref":"#/components/schemas/TradingSession"},"type":"array"},"timezone":{"examples":["Australia/Sydney"],"type":"string"}},"required":["mic","timezone","sessions","holidays"],"type":"object"},"ExchangeCalendarResponse":{"additionalProperties":false,"properties":{"data":{"$ref":"#/components/schemas/ExchangeCalendar"},"meta":{"$ref":"#/components/schemas/ResourceMeta"}},"required":["data","meta"],"type":"object"},"ExchangeHoliday":{"additionalProperties":false,"properties":{"close":{"description":"The early close in local time, null when closed all day","examples":["14:10"],"type":["string","null"]},"date":{"format":"date","type":"string"},"kind":{"enum":["closed","early_close"],"type":"string"},"name":{"type":"string"}},"required":["date","name","kind","close"],"type":"object"},"ExchangeList":{"additionalProperties":false,"properties":{"data":{"items":{"$ref":"#/components/schemas/Exchange"},"type":"array"},"meta":{"$ref":"#/components/schemas/PageMeta"}},"required":["data","meta"],"type":"object"},"Filing":{"additionalProperties":false,"properties":{"accession":{"description":"The regulator's own id for the filing","type":"string"},"documents":{"items":{"$ref":"#/components/schemas/FilingDocument"},"type":"array"},"form":{"examples":["10-K"],"type":"string"},"id":{"examples":["fil_qx4N01c27x5bJURh1rILe"],"type":"string"},"periodEnd":{"description":"The period a report covers","format":"date","type":["string","null"]},"priceSensitive":{"description":"The exchange's flag on announcements it expects to move the price, null where the exchange doesn't flag","type":["boolean","null"]},"publishedAt":{"format":"date-time","type":"string"},"regulator":{"examples":["ASX"],"type":"string"},"status":{"enum":["filed","revised","cancelled"],"type":"string"},"title":{"type":"string"},"type":{"enum":["annual_report","interim_report","quarterly_report","current_report","proxy","registration","insider","ownership","announcement","other"],"type":"string"}},"required":["id","regulator","accession","form","type","status","title","publishedAt","periodEnd","priceSensitive","documents"],"type":"object"},"FilingDocument":{"additionalProperties":false,"properties":{"mediaType":{"examples":["application/pdf"],"type":"string"},"name":{"type":"string"},"role":{"description":"data is a machine readable part, like XBRL","enum":["primary","exhibit","data"],"type":"string"},"url":{"description":"The original document, served by us","type":["string","null"]}},"required":["role","name","mediaType","url"],"type":"object"},"FilingHit":{"additionalProperties":false,"properties":{"accession":{"description":"The regulator's own id for the filing","type":"string"},"documents":{"items":{"$ref":"#/components/schemas/FilingDocument"},"type":"array"},"form":{"examples":["10-K"],"type":"string"},"id":{"examples":["fil_qx4N01c27x5bJURh1rILe"],"type":"string"},"periodEnd":{"description":"The period a report covers","format":"date","type":["string","null"]},"priceSensitive":{"description":"The exchange's flag on announcements it expects to move the price, null where the exchange doesn't flag","type":["boolean","null"]},"publishedAt":{"format":"date-time","type":"string"},"rank":{"description":"Higher is a better match, only comparable within one search","format":"double","type":"number"},"regulator":{"examples":["ASX"],"type":"string"},"snippet":{"description":"Where the match is in the text","type":"string"},"status":{"enum":["filed","revised","cancelled"],"type":"string"},"title":{"type":"string"},"type":{"enum":["annual_report","interim_report","quarterly_report","current_report","proxy","registration","insider","ownership","announcement","other"],"type":"string"}},"required":["rank","snippet","id","regulator","accession","form","type","status","title","publishedAt","periodEnd","priceSensitive","documents"],"type":"object"},"FilingHitList":{"additionalProperties":false,"properties":{"data":{"items":{"$ref":"#/components/schemas/FilingHit"},"type":"array"},"meta":{"$ref":"#/components/schemas/PageMeta"}},"required":["data","meta"],"type":"object"},"FilingText":{"additionalProperties":false,"properties":{"accession":{"description":"The regulator's own id for the filing","type":"string"},"documents":{"items":{"$ref":"#/components/schemas/FilingDocument"},"type":"array"},"form":{"examples":["10-K"],"type":"string"},"id":{"examples":["fil_qx4N01c27x5bJURh1rILe"],"type":"string"},"periodEnd":{"description":"The period a report covers","format":"date","type":["string","null"]},"priceSensitive":{"description":"The exchange's flag on announcements it expects to move the price, null where the exchange doesn't flag","type":["boolean","null"]},"publishedAt":{"format":"date-time","type":"string"},"regulator":{"examples":["ASX"],"type":"string"},"status":{"enum":["filed","revised","cancelled"],"type":"string"},"text":{"description":"Text of every document in order, separated by blank lines","type":"string"},"title":{"type":"string"},"type":{"enum":["annual_report","interim_report","quarterly_report","current_report","proxy","registration","insider","ownership","announcement","other"],"type":"string"}},"required":["text","id","regulator","accession","form","type","status","title","publishedAt","periodEnd","priceSensitive","documents"],"type":"object"},"FilingTextResponse":{"additionalProperties":false,"properties":{"data":{"$ref":"#/components/schemas/FilingText"},"meta":{"$ref":"#/components/schemas/ResourceMeta"}},"required":["data","meta"],"type":"object"},"Filings":{"additionalProperties":false,"properties":{"asOf":{"description":"The point in time this data describes. For history and events it's the date of the newest record, or the end of your range when there are none. Live values give when they were observed, and reference data gives when we last checked it with a source","format":"date-time","type":"string"},"filings":{"items":{"$ref":"#/components/schemas/Filing"},"type":"array"},"instrument":{"$ref":"#/components/schemas/Instrument","description":"What the symbol resolved to"},"symbol":{"description":"The symbol as sent","type":"string"}},"required":["filings","symbol","instrument","asOf"],"type":"object"},"FilingsBatch":{"additionalProperties":false,"properties":{"data":{"items":{"$ref":"#/components/schemas/Filings"},"type":"array"},"errors":{"items":{"$ref":"#/components/schemas/SymbolError"},"type":"array"},"meta":{"$ref":"#/components/schemas/Meta"}},"required":["data","errors","meta"],"type":"object"},"FinancialPeriod":{"additionalProperties":false,"properties":{"currency":{"description":"null when the period only holds share counts","type":["string","null"]},"fiscalPeriod":{"enum":["FY","H1","H2","Q1","Q2","Q3","Q4"],"type":"string"},"fiscalYear":{"examples":[2026],"format":"int64","type":"integer"},"periodEnd":{"format":"date","type":"string"},"values":{"items":{"$ref":"#/components/schemas/LineValue"},"type":"array"}},"required":["fiscalYear","fiscalPeriod","periodEnd","currency","values"],"type":"object"},"Financials":{"additionalProperties":false,"properties":{"asOf":{"description":"The point in time this data describes. For history and events it's the date of the newest record, or the end of your range when there are none. Live values give when they were observed, and reference data gives when we last checked it with a source","format":"date-time","type":"string"},"instrument":{"$ref":"#/components/schemas/Instrument","description":"What the symbol resolved to"},"lineItems":{"description":"The lines present, in display order","items":{"$ref":"#/components/schemas/LineItem"},"type":"array"},"period":{"enum":["annual","half","quarterly","ttm"],"type":"string"},"periods":{"items":{"$ref":"#/components/schemas/FinancialPeriod"},"type":"array"},"statement":{"enum":["income","balance","cash_flow"],"type":"string"},"symbol":{"description":"The symbol as sent","type":"string"}},"required":["statement","period","periods","lineItems","symbol","instrument","asOf"],"type":"object"},"FinancialsBatch":{"additionalProperties":false,"properties":{"data":{"items":{"$ref":"#/components/schemas/Financials"},"type":"array"},"errors":{"items":{"$ref":"#/components/schemas/SymbolError"},"type":"array"},"meta":{"$ref":"#/components/schemas/Meta"}},"required":["data","errors","meta"],"type":"object"},"Fund":{"additionalProperties":false,"properties":{"apir":{"description":"The Australian fund code, null outside Australia","examples":["VAN0002AU"],"type":["string","null"]},"asOf":{"description":"The point in time this data describes. For history and events it's the date of the newest record, or the end of your range when there are none. Live values give when they were observed, and reference data gives when we last checked it with a source","format":"date-time","type":"string"},"aum":{"description":"Net assets","format":"double","type":["number","null"]},"benchmark":{"examples":["S&P/ASX 300 Index"],"type":["string","null"]},"currency":{"description":"Currency of aum and nav","type":["string","null"]},"distributionFrequency":{"enum":["monthly","quarterly","semi_annual","annual","none"],"type":["string","null"]},"domicile":{"examples":["AU"],"type":["string","null"]},"inception":{"format":"date","type":["string","null"]},"instrument":{"$ref":"#/components/schemas/Instrument","description":"What the symbol resolved to"},"issuer":{"examples":["Vanguard Investments Australia"],"type":["string","null"]},"managementFee":{"description":"Yearly percentage of net assets","examples":[0.07],"format":"double","type":["number","null"]},"mer":{"description":"Management expense ratio as a yearly percentage of net assets","examples":[0.07],"format":"double","type":["number","null"]},"nav":{"description":"Net asset value per unit","format":"double","type":["number","null"]},"navDate":{"description":"The day aum, nav and unitsOnIssue are from","format":"date","type":["string","null"]},"symbol":{"description":"The symbol as sent","type":"string"},"unitsOnIssue":{"format":"double","type":["number","null"]}},"required":["issuer","apir","benchmark","mer","managementFee","inception","domicile","distributionFrequency","navDate","currency","aum","nav","unitsOnIssue","symbol","instrument","asOf"],"type":"object"},"FundBatch":{"additionalProperties":false,"properties":{"data":{"items":{"$ref":"#/components/schemas/Fund"},"type":"array"},"errors":{"items":{"$ref":"#/components/schemas/SymbolError"},"type":"array"},"meta":{"$ref":"#/components/schemas/Meta"}},"required":["data","errors","meta"],"type":"object"},"Holder":{"additionalProperties":false,"properties":{"cik":{"type":["string","null"]},"kind":{"enum":["institution","fund","person","company","other"],"type":"string"},"lei":{"type":["string","null"]},"name":{"type":"string"}},"required":["name","kind","cik","lei"],"type":"object"},"HolderPosition":{"additionalProperties":false,"properties":{"change":{"description":"Shares bought or sold since the holder's previous report","format":"double","type":["number","null"]},"currency":{"description":"Of value","type":["string","null"]},"holder":{"$ref":"#/components/schemas/Holder"},"percent":{"description":"Of shares outstanding, 0 to 100","format":"double","type":["number","null"]},"reportDate":{"description":"The date the holder reported the position at","format":"date","type":"string"},"shares":{"format":"double","type":"number"},"value":{"format":"double","type":["number","null"]}},"required":["holder","reportDate","shares","value","currency","percent","change"],"type":"object"},"Holders":{"additionalProperties":false,"properties":{"asOf":{"description":"The point in time this data describes. For history and events it's the date of the newest record, or the end of your range when there are none. Live values give when they were observed, and reference data gives when we last checked it with a source","format":"date-time","type":"string"},"date":{"description":"The day the holdings stand at","format":"date","type":"string"},"instrument":{"$ref":"#/components/schemas/Instrument","description":"What the symbol resolved to"},"positions":{"items":{"$ref":"#/components/schemas/HolderPosition"},"type":"array"},"symbol":{"description":"The symbol as sent","type":"string"},"type":{"enum":["institutional","substantial"],"type":"string"}},"required":["type","date","positions","symbol","instrument","asOf"],"type":"object"},"HoldersBatch":{"additionalProperties":false,"properties":{"data":{"items":{"$ref":"#/components/schemas/Holders"},"type":"array"},"errors":{"items":{"$ref":"#/components/schemas/SymbolError"},"type":"array"},"meta":{"$ref":"#/components/schemas/Meta"}},"required":["data","errors","meta"],"type":"object"},"Holdings":{"additionalProperties":false,"properties":{"asOf":{"description":"The point in time this data describes. For history and events it's the date of the newest record, or the end of your range when there are none. Live values give when they were observed, and reference data gives when we last checked it with a source","format":"date-time","type":"string"},"currency":{"description":"Currency of every position's value","type":["string","null"]},"date":{"description":"The day of this snapshot","format":"date","type":"string"},"fund":{"$ref":"#/components/schemas/Instrument","description":"Where the positions come from, the tracking fund when the symbol is an index"},"instrument":{"$ref":"#/components/schemas/Instrument","description":"What the symbol resolved to"},"positions":{"items":{"$ref":"#/components/schemas/Position"},"type":"array"},"symbol":{"description":"The symbol as sent","type":"string"}},"required":["fund","date","currency","positions","symbol","instrument","asOf"],"type":"object"},"HoldingsBatch":{"additionalProperties":false,"properties":{"data":{"items":{"$ref":"#/components/schemas/Holdings"},"type":"array"},"errors":{"items":{"$ref":"#/components/schemas/SymbolError"},"type":"array"},"meta":{"$ref":"#/components/schemas/Meta"}},"required":["data","errors","meta"],"type":"object"},"Industry":{"additionalProperties":false,"properties":{"id":{"examples":["diversified_mining"],"type":"string"},"name":{"examples":["Diversified Mining"],"type":"string"}},"required":["id","name"],"type":"object"},"InsiderTrade":{"additionalProperties":false,"properties":{"acquired":{"type":"boolean"},"code":{"description":"The form's own transaction code, like P or S on a Form 4","type":["string","null"]},"currency":{"description":"Of price","type":["string","null"]},"derivative":{"description":"True for options, rights and other contracts on the shares","type":"boolean"},"filedDate":{"format":"date","type":["string","null"]},"indirect":{"description":"True when held through someone else, like a family trust","type":"boolean"},"insider":{"type":"string"},"price":{"format":"double","type":["number","null"]},"relation":{"examples":["Director"],"type":["string","null"]},"security":{"description":"What changed hands, as the form names it","type":["string","null"]},"shares":{"format":"double","type":"number"},"sharesAfter":{"format":"double","type":["number","null"]},"tradeDate":{"format":"date","type":"string"},"type":{"enum":["buy","sell","award","exercise","gift","other"],"type":"string"}},"required":["insider","relation","tradeDate","filedDate","type","code","security","derivative","acquired","shares","price","currency","sharesAfter","indirect"],"type":"object"},"InsiderTrades":{"additionalProperties":false,"properties":{"asOf":{"description":"The point in time this data describes. For history and events it's the date of the newest record, or the end of your range when there are none. Live values give when they were observed, and reference data gives when we last checked it with a source","format":"date-time","type":"string"},"instrument":{"$ref":"#/components/schemas/Instrument","description":"What the symbol resolved to"},"symbol":{"description":"The symbol as sent","type":"string"},"trades":{"items":{"$ref":"#/components/schemas/InsiderTrade"},"type":"array"}},"required":["trades","symbol","instrument","asOf"],"type":"object"},"InsiderTradesBatch":{"additionalProperties":false,"properties":{"data":{"items":{"$ref":"#/components/schemas/InsiderTrades"},"type":"array"},"errors":{"items":{"$ref":"#/components/schemas/SymbolError"},"type":"array"},"meta":{"$ref":"#/components/schemas/Meta"}},"required":["data","errors","meta"],"type":"object"},"Instrument":{"additionalProperties":false,"properties":{"country":{"examples":["AU"],"type":["string","null"]},"currency":{"examples":["AUD"],"type":["string","null"]},"id":{"examples":["ins_7Hq2kP3xY9vLmN4bR8sT1u"],"type":"string"},"mic":{"examples":["XASX"],"type":["string","null"]},"name":{"type":"string"},"symbol":{"examples":["ASX:VAS"],"type":"string"},"type":{"enum":["equity","etf","fund","index","fx","crypto","token","rate","future","commodity","bond"],"type":"string"}},"required":["id","symbol","name","type","mic","currency","country"],"type":"object"},"InstrumentDetails":{"additionalProperties":false,"properties":{"asOf":{"description":"The point in time this data describes. For history and events it's the date of the newest record, or the end of your range when there are none. Live values give when they were observed, and reference data gives when we last checked it with a source","format":"date-time","type":"string"},"identifiers":{"$ref":"#/components/schemas/InstrumentIdentifiers"},"instrument":{"$ref":"#/components/schemas/Instrument","description":"What the symbol resolved to"},"listedFrom":{"description":"First trading day on any exchange, null when unknown or never listed","format":"date","type":["string","null"]},"listedTo":{"description":"Last trading day, null while listed","format":"date","type":["string","null"]},"listings":{"description":"Every exchange and ticker it has traded under, oldest first","items":{"$ref":"#/components/schemas/InstrumentListing"},"type":"array"},"names":{"description":"Every name it has had, oldest first","items":{"$ref":"#/components/schemas/InstrumentName"},"type":"array"},"status":{"enum":["active","delisted","suspended"],"type":"string"},"symbol":{"description":"The symbol as sent","type":"string"}},"required":["status","listedFrom","listedTo","identifiers","listings","names","symbol","instrument","asOf"],"type":"object"},"InstrumentDetailsBatch":{"additionalProperties":false,"properties":{"data":{"items":{"$ref":"#/components/schemas/InstrumentDetails"},"type":"array"},"errors":{"items":{"$ref":"#/components/schemas/SymbolError"},"type":"array"},"meta":{"$ref":"#/components/schemas/Meta"}},"required":["data","errors","meta"],"type":"object"},"InstrumentIdentifiers":{"additionalProperties":false,"properties":{"apir":{"type":["string","null"]},"cik":{"type":["string","null"]},"compositeFigi":{"type":["string","null"]},"contract":{"description":"chain:address, for tokens","type":["string","null"]},"cryptoSymbol":{"type":["string","null"]},"figi":{"type":["string","null"]},"futureCode":{"type":["string","null"]},"fxPair":{"examples":["AUDUSD"],"type":["string","null"]},"indexCode":{"type":["string","null"]},"isin":{"examples":["AU000000VAS1"],"type":["string","null"]},"lei":{"type":["string","null"]},"rateCode":{"type":["string","null"]},"shareClassFigi":{"type":["string","null"]}},"required":["isin","figi","compositeFigi","shareClassFigi","lei","cik","apir","contract","fxPair","cryptoSymbol","indexCode","rateCode","futureCode"],"type":"object"},"InstrumentList":{"additionalProperties":false,"properties":{"data":{"items":{"$ref":"#/components/schemas/Instrument"},"type":"array"},"meta":{"$ref":"#/components/schemas/PageMeta"}},"required":["data","meta"],"type":"object"},"InstrumentListing":{"additionalProperties":false,"properties":{"from":{"description":"First trading day, null when unknown","format":"date","type":["string","null"]},"mic":{"examples":["XASX"],"type":"string"},"ticker":{"examples":["VAS"],"type":"string"},"to":{"description":"Last trading day, null while listed","format":"date","type":["string","null"]}},"required":["mic","ticker","from","to"],"type":"object"},"InstrumentName":{"additionalProperties":false,"properties":{"from":{"description":"First day under this name, null when unknown","format":"date","type":["string","null"]},"name":{"type":"string"},"to":{"description":"Last day under this name, null for the current name","format":"date","type":["string","null"]}},"required":["name","from","to"],"type":"object"},"IntradayBar":{"additionalProperties":false,"properties":{"close":{"format":"double","type":"number"},"high":{"format":"double","type":["number","null"]},"low":{"format":"double","type":["number","null"]},"open":{"format":"double","type":["number","null"]},"session":{"description":"pre or post outside regular hours","enum":["pre","open","post"],"type":"string"},"time":{"description":"Start of the candle","format":"date-time","type":"string"},"volume":{"format":"double","type":["number","null"]}},"required":["time","open","high","low","close","volume","session"],"type":"object"},"IntradaySeries":{"additionalProperties":false,"properties":{"asOf":{"description":"The point in time this data describes. For history and events it's the date of the newest record, or the end of your range when there are none. Live values give when they were observed, and reference data gives when we last checked it with a source","format":"date-time","type":"string"},"bars":{"items":{"$ref":"#/components/schemas/IntradayBar"},"type":"array"},"currency":{"type":"string"},"instrument":{"$ref":"#/components/schemas/Instrument","description":"What the symbol resolved to"},"symbol":{"description":"The symbol as sent","type":"string"}},"required":["currency","bars","symbol","instrument","asOf"],"type":"object"},"IntradaySeriesBatch":{"additionalProperties":false,"properties":{"data":{"items":{"$ref":"#/components/schemas/IntradaySeries"},"type":"array"},"errors":{"items":{"$ref":"#/components/schemas/SymbolError"},"type":"array"},"meta":{"$ref":"#/components/schemas/Meta"}},"required":["data","errors","meta"],"type":"object"},"LineItem":{"additionalProperties":false,"properties":{"code":{"examples":["revenue"],"type":"string"},"name":{"examples":["Revenue"],"type":"string"},"unit":{"enum":["money","per_share","shares"],"type":"string"}},"required":["code","name","unit"],"type":"object"},"LineValue":{"additionalProperties":false,"properties":{"lineItem":{"description":"Code from lineItems","examples":["revenue"],"type":"string"},"value":{"format":"double","type":"number"}},"required":["lineItem","value"],"type":"object"},"ListedInstrument":{"additionalProperties":false,"properties":{"industry":{"description":"An industry id from /v1/sectors, null when unclassified","examples":["diversified_mining"],"type":["string","null"]},"instrument":{"$ref":"#/components/schemas/Instrument"},"isin":{"type":["string","null"]},"snapshotDate":{"description":"The trading day this listing was last seen on","format":"date","type":"string"}},"required":["instrument","isin","industry","snapshotDate"],"type":"object"},"ListedInstrumentList":{"additionalProperties":false,"properties":{"data":{"items":{"$ref":"#/components/schemas/ListedInstrument"},"type":"array"},"meta":{"$ref":"#/components/schemas/PageMeta"}},"required":["data","meta"],"type":"object"},"LocalBreak":{"additionalProperties":false,"properties":{"end":{"examples":["12:30"],"type":"string"},"start":{"examples":["11:30"],"type":"string"}},"required":["start","end"],"type":"object"},"MarketCapRange":{"additionalProperties":false,"properties":{"max":{"format":"double","minimum":0,"type":"number"},"min":{"format":"double","minimum":0,"type":"number"}},"type":"object"},"MergerDetail":{"additionalProperties":false,"properties":{"acquirer":{"description":"Symbol of the company whose shares are paid","type":["string","null"]},"cash":{"description":"Cash for every share held","format":"double","type":["number","null"]},"currency":{"type":["string","null"]},"ratio":{"description":"Acquirer shares for every share held","format":"double","type":["number","null"]}},"required":["acquirer","ratio","cash","currency"],"type":"object"},"Meta":{"additionalProperties":false,"properties":{"credits":{"description":"Credits this call cost","format":"int64","type":"integer"},"requestId":{"type":"string"}},"required":["credits","requestId"],"type":"object"},"Observation":{"additionalProperties":false,"properties":{"period":{"description":"First day of the period","format":"date","type":"string"},"released":{"description":"When this value was published, null when unknown","format":"date","type":["string","null"]},"value":{"format":"double","type":"number"}},"required":["period","value","released"],"type":"object"},"Observations":{"additionalProperties":false,"properties":{"asOf":{"description":"The point in time this data describes. For history and events it's the date of the newest record, or the end of your range when there are none. Live values give when they were observed, and reference data gives when we last checked it with a source","format":"date-time","type":"string"},"code":{"description":"The canonical code it resolved to","examples":["AU.POLICY_RATE"],"type":"string"},"frequency":{"description":"The frequency served","enum":["daily","weekly","monthly","quarterly","annual"],"type":"string"},"name":{"type":"string"},"observations":{"items":{"$ref":"#/components/schemas/Observation"},"type":"array"},"series":{"description":"The code as sent","type":"string"},"unit":{"enum":["percent","index","persons"],"type":"string"}},"required":["series","code","name","unit","frequency","observations","asOf"],"type":"object"},"ObservationsBatch":{"additionalProperties":false,"properties":{"data":{"items":{"$ref":"#/components/schemas/Observations"},"type":"array"},"errors":{"items":{"$ref":"#/components/schemas/SeriesError"},"type":"array"},"meta":{"$ref":"#/components/schemas/Meta"}},"required":["data","errors","meta"],"type":"object"},"PageMeta":{"additionalProperties":false,"properties":{"credits":{"description":"Credits this call cost","format":"int64","type":"integer"},"nextCursor":{"description":"Pass as cursor to get the next page, null on the last page","type":["string","null"]},"requestId":{"type":"string"}},"required":["credits","requestId","nextCursor"],"type":"object"},"PairError":{"additionalProperties":false,"properties":{"code":{"enum":["invalid_symbol","not_supported","data_unavailable","data_pending","source_failed"],"type":"string"},"message":{"type":"string"},"pair":{"description":"The pair upper cased, or as sent when it isn't a pair","type":"string"}},"required":["pair","code","message"],"type":"object"},"Pool":{"additionalProperties":false,"properties":{"apy":{"description":"Total yearly yield, the sum of apyBase and apyReward when both are known","format":"double","type":["number","null"]},"apyBase":{"description":"Yield from the pool's own activity, like fees or interest","format":"double","type":["number","null"]},"apyReward":{"description":"Yield paid in incentive tokens","format":"double","type":["number","null"]},"chain":{"examples":["ethereum"],"type":"string"},"currency":{"description":"Currency of tvl","type":"string"},"id":{"description":"Chain, protocol and the pool's own reference, for /v1/yields/history","examples":["ethereum:lido:STETH-1ab36d714f01"],"type":"string"},"protocol":{"examples":["lido"],"type":"string"},"symbol":{"examples":["STETH"],"type":"string"},"tvl":{"description":"Total value locked","format":"double","type":["number","null"]},"underlying":{"description":"Contracts of the tokens the pool holds","items":{"type":"string"},"type":"array"}},"required":["id","chain","protocol","symbol","underlying","currency","tvl","apy","apyBase","apyReward"],"type":"object"},"PoolError":{"additionalProperties":false,"properties":{"code":{"enum":["invalid_symbol","instrument_not_found","not_supported","data_unavailable","data_pending","source_failed"],"type":"string"},"message":{"type":"string"},"pool":{"type":"string"}},"required":["pool","code","message"],"type":"object"},"PoolHistory":{"additionalProperties":false,"properties":{"asOf":{"description":"The point in time this data describes. For history and events it's the date of the newest record, or the end of your range when there are none. Live values give when they were observed, and reference data gives when we last checked it with a source","format":"date-time","type":"string"},"currency":{"description":"Currency of tvl","type":"string"},"points":{"items":{"$ref":"#/components/schemas/PoolPoint"},"type":"array"},"pool":{"description":"The pool id as sent","type":"string"}},"required":["pool","currency","points","asOf"],"type":"object"},"PoolHistoryBatch":{"additionalProperties":false,"properties":{"data":{"items":{"$ref":"#/components/schemas/PoolHistory"},"type":"array"},"errors":{"items":{"$ref":"#/components/schemas/PoolError"},"type":"array"},"meta":{"$ref":"#/components/schemas/Meta"}},"required":["data","errors","meta"],"type":"object"},"PoolList":{"additionalProperties":false,"properties":{"data":{"items":{"$ref":"#/components/schemas/Pool"},"type":"array"},"meta":{"$ref":"#/components/schemas/PageMeta"}},"required":["data","meta"],"type":"object"},"PoolPoint":{"additionalProperties":false,"properties":{"apy":{"description":"Total yearly yield, the sum of apyBase and apyReward when both are known","format":"double","type":["number","null"]},"apyBase":{"description":"Yield from the pool's own activity, like fees or interest","format":"double","type":["number","null"]},"apyReward":{"description":"Yield paid in incentive tokens","format":"double","type":["number","null"]},"date":{"format":"date","type":"string"},"tvl":{"description":"Total value locked","format":"double","type":["number","null"]}},"required":["date","tvl","apy","apyBase","apyReward"],"type":"object"},"Position":{"additionalProperties":false,"properties":{"assetClass":{"enum":["equity","fixed_income","cash","derivative","fund","real_estate","commodity","other"],"type":["string","null"]},"country":{"type":["string","null"]},"currency":{"description":"The constituent's own trading currency","type":["string","null"]},"instrumentId":{"description":"Our id for the constituent, null until it resolves to an instrument","type":["string","null"]},"isin":{"type":["string","null"]},"mic":{"type":["string","null"]},"name":{"type":"string"},"position":{"description":"Order in the issuer's file, from 1","format":"int64","type":"integer"},"sector":{"type":["string","null"]},"shares":{"description":"Shares or units held, null for positions held by face value","format":"double","type":["number","null"]},"symbol":{"description":"The constituent's symbol, null until it resolves to an instrument","type":["string","null"]},"ticker":{"type":["string","null"]},"value":{"format":"double","type":["number","null"]},"weight":{"description":"Percentage of net assets, 4.5 for 4.5%","format":"double","type":["number","null"]}},"required":["position","instrumentId","symbol","name","ticker","mic","isin","weight","shares","value","currency","sector","country","assetClass"],"type":"object"},"Problem":{"additionalProperties":false,"properties":{"code":{"type":"string"},"detail":{"type":"string"},"errors":{"items":{"$ref":"#/components/schemas/ProblemDetail"},"type":"array"},"requestId":{"type":"string"},"status":{"format":"int64","type":"integer"},"title":{"type":"string"},"type":{"type":"string"}},"required":["type","title","status","detail","code","requestId","errors"],"type":"object"},"ProblemDetail":{"additionalProperties":false,"properties":{"location":{"type":"string"},"message":{"type":"string"}},"required":["location","message"],"type":"object"},"Quote":{"additionalProperties":false,"properties":{"asOf":{"description":"The point in time this data describes. For history and events it's the date of the newest record, or the end of your range when there are none. Live values give when they were observed, and reference data gives when we last checked it with a source","format":"date-time","type":"string"},"ask":{"format":"double","type":["number","null"]},"askSize":{"format":"double","type":["number","null"]},"bid":{"format":"double","type":["number","null"]},"bidSize":{"format":"double","type":["number","null"]},"change":{"description":"Price minus the previous close","format":"double","type":["number","null"]},"changePercent":{"description":"Change as a percentage of the previous close","format":"double","type":["number","null"]},"currency":{"type":"string"},"delaySeconds":{"description":"How far behind the market this quote is","format":"int64","type":"integer"},"high":{"format":"double","type":["number","null"]},"instrument":{"$ref":"#/components/schemas/Instrument","description":"What the symbol resolved to"},"low":{"format":"double","type":["number","null"]},"marketState":{"enum":["pre","open","post","closed"],"type":"string"},"open":{"format":"double","type":["number","null"]},"prevClose":{"format":"double","type":["number","null"]},"price":{"format":"double","type":"number"},"quotedAt":{"format":"date-time","type":"string"},"symbol":{"description":"The symbol as sent","type":"string"},"volume":{"format":"double","type":["number","null"]}},"required":["currency","price","change","changePercent","prevClose","open","high","low","volume","bid","ask","bidSize","askSize","marketState","delaySeconds","quotedAt","symbol","instrument","asOf"],"type":"object"},"QuoteBatch":{"additionalProperties":false,"properties":{"data":{"items":{"$ref":"#/components/schemas/Quote"},"type":"array"},"errors":{"items":{"$ref":"#/components/schemas/SymbolError"},"type":"array"},"meta":{"$ref":"#/components/schemas/Meta"}},"required":["data","errors","meta"],"type":"object"},"RenameDetail":{"additionalProperties":false,"properties":{"new":{"type":["string","null"]},"old":{"type":["string","null"]}},"required":["old","new"],"type":"object"},"ResourceMeta":{"additionalProperties":false,"properties":{"asOf":{"description":"The point in time this data describes, like when a filing was published. Null where that doesn't apply, as with account data","format":"date-time","type":["string","null"]},"credits":{"description":"Credits this call cost","format":"int64","type":"integer"},"requestId":{"type":"string"}},"required":["credits","requestId","asOf"],"type":"object"},"RiskFlag":{"additionalProperties":false,"properties":{"flag":{"enum":["honeypot","mintable","freezable","blacklist","pausable","upgradeable","owner_control","high_tax","low_liquidity","unlocked_liquidity","concentrated_holders","closed_source","impersonator","spam"],"type":"string"},"reason":{"type":"string"}},"required":["flag","reason"],"type":"object"},"ScreenerMatch":{"additionalProperties":false,"properties":{"close":{"format":"double","type":["number","null"]},"currency":{"description":"The currency close and marketCap are in","type":["string","null"]},"industry":{"description":"An industry id from /v1/sectors","type":["string","null"]},"instrument":{"$ref":"#/components/schemas/Instrument"},"marketCap":{"format":"double","type":["number","null"]},"snapshotDate":{"description":"The trading day these values are from","format":"date","type":"string"}},"required":["instrument","snapshotDate","currency","close","marketCap","industry"],"type":"object"},"ScreenerMatchList":{"additionalProperties":false,"properties":{"data":{"items":{"$ref":"#/components/schemas/ScreenerMatch"},"type":"array"},"meta":{"$ref":"#/components/schemas/PageMeta"}},"required":["data","meta"],"type":"object"},"ScreenerQuery":{"additionalProperties":false,"properties":{"depositaryReceipts":{"description":"true keeps only depositary receipts like ADRs, false leaves them out","type":"boolean"},"exchanges":{"description":"MICs or aliases like ASX","examples":[["ASX"]],"items":{"type":"string"},"maxItems":50,"type":"array"},"fields":{"description":"Values to fill in. Leave out to fill every one, the rest come back null","items":{"enum":["close","market_cap","industry"],"type":"string"},"type":"array"},"industries":{"description":"Industry ids from /v1/sectors","items":{"type":"string"},"maxItems":100,"type":"array"},"limit":{"default":100,"examples":[5],"format":"int64","maximum":1000,"minimum":1,"type":"integer"},"marketCap":{"$ref":"#/components/schemas/MarketCapRange","description":"In each instrument's own currency"},"order":{"description":"Defaults to desc, or asc when sorting by name","enum":["asc","desc"],"type":"string"},"sort":{"default":"market_cap","enum":["market_cap","close","name"],"type":"string"},"types":{"examples":[["equity"]],"items":{"enum":["equity","etf","fund","index","fx","crypto","token","rate","future","commodity","bond"],"type":"string"},"maxItems":11,"type":"array"}},"type":"object"},"Sector":{"additionalProperties":false,"properties":{"id":{"examples":["materials"],"type":"string"},"industries":{"items":{"$ref":"#/components/schemas/Industry"},"type":"array"},"name":{"examples":["Materials"],"type":"string"}},"required":["id","name","industries"],"type":"object"},"SectorList":{"additionalProperties":false,"properties":{"data":{"items":{"$ref":"#/components/schemas/Sector"},"type":"array"},"meta":{"$ref":"#/components/schemas/PageMeta"}},"required":["data","meta"],"type":"object"},"Series":{"additionalProperties":false,"properties":{"adjustment":{"description":"sa is seasonally adjusted, nsa isn't","enum":["sa","nsa"],"type":"string"},"aggregation":{"description":"How periods combine when a coarser frequency is asked for","enum":["mean","sum","last"],"type":"string"},"aliases":{"description":"Other codes that resolve to this series","items":{"type":"string"},"type":"array"},"category":{"enum":["inflation","gdp","labour","rates"],"type":"string"},"code":{"examples":["AU.CPI.YOY"],"type":"string"},"country":{"examples":["AU"],"type":"string"},"frequency":{"enum":["daily","weekly","monthly","quarterly","annual"],"type":"string"},"name":{"type":"string"},"nextRelease":{"description":"Our estimate of the next release, null until the series has been fetched","format":"date","type":["string","null"]},"unit":{"enum":["percent","index","persons"],"type":"string"}},"required":["code","aliases","name","country","category","unit","frequency","adjustment","aggregation","nextRelease"],"type":"object"},"SeriesError":{"additionalProperties":false,"properties":{"code":{"enum":["invalid_symbol","instrument_not_found","not_supported","data_unavailable","data_pending","source_failed"],"type":"string"},"message":{"type":"string"},"series":{"type":"string"}},"required":["series","code","message"],"type":"object"},"SeriesList":{"additionalProperties":false,"properties":{"data":{"items":{"$ref":"#/components/schemas/Series"},"type":"array"},"meta":{"$ref":"#/components/schemas/PageMeta"}},"required":["data","meta"],"type":"object"},"SessionBreak":{"additionalProperties":false,"properties":{"end":{"format":"date-time","type":"string"},"start":{"format":"date-time","type":"string"}},"required":["start","end"],"type":"object"},"ShortInterest":{"additionalProperties":false,"properties":{"asOf":{"description":"The point in time this data describes. For history and events it's the date of the newest record, or the end of your range when there are none. Live values give when they were observed, and reference data gives when we last checked it with a source","format":"date-time","type":"string"},"instrument":{"$ref":"#/components/schemas/Instrument","description":"What the symbol resolved to"},"positions":{"items":{"$ref":"#/components/schemas/ShortPosition"},"type":"array"},"symbol":{"description":"The symbol as sent","type":"string"}},"required":["positions","symbol","instrument","asOf"],"type":"object"},"ShortInterestBatch":{"additionalProperties":false,"properties":{"data":{"items":{"$ref":"#/components/schemas/ShortInterest"},"type":"array"},"errors":{"items":{"$ref":"#/components/schemas/SymbolError"},"type":"array"},"meta":{"$ref":"#/components/schemas/Meta"}},"required":["data","errors","meta"],"type":"object"},"ShortPosition":{"additionalProperties":false,"properties":{"averageVolume":{"format":"double","type":["number","null"]},"date":{"format":"date","type":"string"},"daysToCover":{"format":"double","type":["number","null"]},"percent":{"description":"Of shares on issue, 0 to 100","format":"double","type":["number","null"]},"shares":{"format":"double","type":["number","null"]},"sharesOutstanding":{"description":"The shares on issue the regulator measured against","format":"double","type":["number","null"]}},"required":["date","shares","sharesOutstanding","percent","averageVolume","daysToCover"],"type":"object"},"SplitDetail":{"additionalProperties":false,"properties":{"new":{"description":"Shares held after, for every old number of shares","format":"double","type":["number","null"]},"old":{"description":"Shares held before","format":"double","type":["number","null"]}},"required":["old","new"],"type":"object"},"SymbolError":{"additionalProperties":false,"properties":{"code":{"enum":["invalid_symbol","instrument_not_found","not_supported","data_unavailable","data_pending","source_failed"],"type":"string"},"message":{"type":"string"},"symbol":{"type":"string"}},"required":["symbol","code","message"],"type":"object"},"TaxComponents":{"additionalProperties":false,"properties":{"amitCostBaseDecrease":{"format":"double","type":["number","null"]},"amitCostBaseIncrease":{"format":"double","type":["number","null"]},"basis":{"enum":["estimate","final"],"type":"string"},"cashDistribution":{"format":"double","type":["number","null"]},"cgtConcession":{"format":"double","type":["number","null"]},"currency":{"examples":["AUD"],"type":"string"},"discountedCapitalGainsNtap":{"description":"On other than taxable Australian property","format":"double","type":["number","null"]},"discountedCapitalGainsTap":{"description":"On taxable Australian property","format":"double","type":["number","null"]},"exDate":{"format":"date","type":["string","null"]},"foreignIncome":{"description":"Assessable foreign income grossed up for the foreign tax paid on it","format":"double","type":["number","null"]},"foreignIncomeTaxOffset":{"format":"double","type":["number","null"]},"frankedDividends":{"format":"double","type":["number","null"]},"frankingCredits":{"format":"double","type":["number","null"]},"indexedCapitalGains":{"format":"double","type":["number","null"]},"interest":{"format":"double","type":["number","null"]},"netExemptIncome":{"format":"double","type":["number","null"]},"nonAssessableNonExempt":{"format":"double","type":["number","null"]},"otherCapitalGainsNtap":{"format":"double","type":["number","null"]},"otherCapitalGainsTap":{"format":"double","type":["number","null"]},"otherIncome":{"format":"double","type":["number","null"]},"otherNonAttributable":{"format":"double","type":["number","null"]},"payDate":{"format":"date","type":"string"},"unfrankedCfiDividends":{"description":"Unfranked dividends that are conduit foreign income","format":"double","type":["number","null"]},"unfrankedDividends":{"format":"double","type":["number","null"]}},"required":["payDate","exDate","basis","currency","cashDistribution","frankedDividends","frankingCredits","unfrankedDividends","unfrankedCfiDividends","interest","otherIncome","discountedCapitalGainsTap","discountedCapitalGainsNtap","indexedCapitalGains","otherCapitalGainsTap","otherCapitalGainsNtap","cgtConcession","foreignIncome","foreignIncomeTaxOffset","netExemptIncome","nonAssessableNonExempt","otherNonAttributable","amitCostBaseIncrease","amitCostBaseDecrease"],"type":"object"},"TaxDistributions":{"additionalProperties":false,"properties":{"asOf":{"description":"The point in time this data describes. For history and events it's the date of the newest record, or the end of your range when there are none. Live values give when they were observed, and reference data gives when we last checked it with a source","format":"date-time","type":"string"},"distributions":{"items":{"$ref":"#/components/schemas/TaxComponents"},"type":"array"},"financialYear":{"examples":[2026],"format":"int64","type":"integer"},"instrument":{"$ref":"#/components/schemas/Instrument","description":"What the symbol resolved to"},"symbol":{"description":"The symbol as sent","type":"string"}},"required":["financialYear","distributions","symbol","instrument","asOf"],"type":"object"},"TaxDistributionsBatch":{"additionalProperties":false,"properties":{"data":{"items":{"$ref":"#/components/schemas/TaxDistributions"},"type":"array"},"errors":{"items":{"$ref":"#/components/schemas/SymbolError"},"type":"array"},"meta":{"$ref":"#/components/schemas/Meta"}},"required":["data","errors","meta"],"type":"object"},"TaxFXSeries":{"additionalProperties":false,"properties":{"asOf":{"description":"The point in time this data describes. For history and events it's the date of the newest record, or the end of your range when there are none. Live values give when they were observed, and reference data gives when we last checked it with a source","format":"date-time","type":"string"},"base":{"examples":["AUD"],"type":"string"},"pair":{"examples":["AUDUSD"],"type":"string"},"quote":{"examples":["USD"],"type":"string"},"rates":{"items":{"$ref":"#/components/schemas/TaxRate"},"type":"array"}},"required":["pair","base","quote","rates","asOf"],"type":"object"},"TaxFXSeriesBatch":{"additionalProperties":false,"properties":{"data":{"items":{"$ref":"#/components/schemas/TaxFXSeries"},"type":"array"},"errors":{"items":{"$ref":"#/components/schemas/PairError"},"type":"array"},"meta":{"$ref":"#/components/schemas/Meta"}},"required":["data","errors","meta"],"type":"object"},"TaxRate":{"additionalProperties":false,"properties":{"date":{"format":"date","type":"string"},"rate":{"description":"Units of quote per unit of base","format":"double","type":"number"}},"required":["date","rate"],"type":"object"},"TechnicalSeries":{"additionalProperties":false,"properties":{"adjust":{"enum":["none","splits","total"],"type":"string"},"asOf":{"description":"The point in time this data describes. For history and events it's the date of the newest record, or the end of your range when there are none. Live values give when they were observed, and reference data gives when we last checked it with a source","format":"date-time","type":"string"},"currency":{"description":"The currency values are in, null for rsi","type":["string","null"]},"instrument":{"$ref":"#/components/schemas/Instrument","description":"What the symbol resolved to"},"symbol":{"description":"The symbol as sent","type":"string"},"values":{"items":{"$ref":"#/components/schemas/TechnicalValue"},"type":"array"}},"required":["currency","adjust","values","symbol","instrument","asOf"],"type":"object"},"TechnicalSeriesBatch":{"additionalProperties":false,"properties":{"data":{"items":{"$ref":"#/components/schemas/TechnicalSeries"},"type":"array"},"errors":{"items":{"$ref":"#/components/schemas/SymbolError"},"type":"array"},"meta":{"$ref":"#/components/schemas/Meta"}},"required":["data","errors","meta"],"type":"object"},"TechnicalValue":{"additionalProperties":false,"properties":{"date":{"format":"date","type":"string"},"histogram":{"description":"MACD minus its signal, null for other indicators","format":"double","type":["number","null"]},"signal":{"description":"The MACD signal line, null for other indicators","format":"double","type":["number","null"]},"value":{"description":"The indicator, or the MACD line","format":"double","type":"number"}},"required":["date","value","signal","histogram"],"type":"object"},"Token":{"additionalProperties":false,"properties":{"asOf":{"description":"The point in time this data describes. For history and events it's the date of the newest record, or the end of your range when there are none. Live values give when they were observed, and reference data gives when we last checked it with a source","format":"date-time","type":"string"},"chain":{"description":"A chain id from /v1/chains","examples":["solana"],"type":"string"},"contract":{"examples":["EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v"],"type":"string"},"decimals":{"format":"int64","type":["integer","null"]},"graduated":{"description":"Whether the token has left its launchpad's bonding curve for a real pool","type":["boolean","null"]},"instrument":{"$ref":"#/components/schemas/Instrument","description":"What the symbol resolved to"},"launchpad":{"description":"Where the token launched, null for most tokens","examples":["pump.fun"],"type":["string","null"]},"logo":{"format":"uri","type":["string","null"]},"supply":{"description":"Total supply as a raw on-chain integer, divide by 10^decimals for whole tokens","examples":["9512337401220551"],"type":["string","null"]},"symbol":{"description":"The symbol as sent","type":"string"},"verified":{"type":["boolean","null"]}},"required":["chain","contract","decimals","supply","logo","verified","launchpad","graduated","symbol","instrument","asOf"],"type":"object"},"TokenBatch":{"additionalProperties":false,"properties":{"data":{"items":{"$ref":"#/components/schemas/Token"},"type":"array"},"errors":{"items":{"$ref":"#/components/schemas/SymbolError"},"type":"array"},"meta":{"$ref":"#/components/schemas/Meta"}},"required":["data","errors","meta"],"type":"object"},"TokenRisk":{"additionalProperties":false,"properties":{"asOf":{"description":"The point in time this data describes. For history and events it's the date of the newest record, or the end of your range when there are none. Live values give when they were observed, and reference data gives when we last checked it with a source","format":"date-time","type":"string"},"assessedAt":{"format":"date-time","type":"string"},"flags":{"items":{"$ref":"#/components/schemas/RiskFlag"},"type":"array"},"instrument":{"$ref":"#/components/schemas/Instrument","description":"What the symbol resolved to"},"score":{"description":"0 for no known risk up to 100 for a certain scam, null when unscored","format":"double","type":["number","null"]},"symbol":{"description":"The symbol as sent","type":"string"}},"required":["score","flags","assessedAt","symbol","instrument","asOf"],"type":"object"},"TokenRiskBatch":{"additionalProperties":false,"properties":{"data":{"items":{"$ref":"#/components/schemas/TokenRisk"},"type":"array"},"errors":{"items":{"$ref":"#/components/schemas/SymbolError"},"type":"array"},"meta":{"$ref":"#/components/schemas/Meta"}},"required":["data","errors","meta"],"type":"object"},"TradingSession":{"additionalProperties":false,"properties":{"breaks":{"items":{"$ref":"#/components/schemas/SessionBreak"},"type":"array"},"close":{"format":"date-time","type":"string"},"date":{"format":"date","type":"string"},"earlyClose":{"type":"boolean"},"open":{"format":"date-time","type":"string"}},"required":["date","open","close","earlyClose","breaks"],"type":"object"},"Transaction":{"additionalProperties":false,"properties":{"failed":{"description":"True when the transaction reverted and moved nothing","type":"boolean"},"fee":{"description":"Raw amount in the chain's native coin","type":["string","null"]},"feePayer":{"description":"Null on UTXO chains, where the inputs pay the fee together","type":["string","null"]},"hash":{"type":"string"},"height":{"description":"Block height, or the slot on Solana","format":"int64","type":"integer"},"position":{"description":"Index within the block","format":"int64","type":["integer","null"]},"time":{"format":"date-time","type":"string"},"transfers":{"items":{"$ref":"#/components/schemas/Transfer"},"type":"array"}},"required":["hash","height","time","position","fee","feePayer","failed","transfers"],"type":"object"},"TransactionList":{"additionalProperties":false,"properties":{"data":{"items":{"$ref":"#/components/schemas/Transaction"},"type":"array"},"meta":{"$ref":"#/components/schemas/PageMeta"}},"required":["data","meta"],"type":"object"},"Transfer":{"additionalProperties":false,"properties":{"amount":{"description":"Raw on-chain integer, divide by 10^decimals for whole units","type":"string"},"asset":{"description":"native for the chain's own coin, else the token contract","type":"string"},"decimals":{"format":"int64","type":"integer"},"from":{"description":"Null on UTXO outputs","type":["string","null"]},"index":{"description":"Orders transfers of one kind within the transaction","format":"int64","type":"integer"},"kind":{"description":"native is the coin a transaction moves itself, internal is the coin moved by a contract call","enum":["input","output","native","internal","token","nft"],"type":"string"},"to":{"description":"Null on UTXO inputs","type":["string","null"]},"tokenId":{"description":"Set on NFT transfers","type":["string","null"]}},"required":["kind","index","asset","from","to","amount","decimals","tokenId"],"type":"object"},"Usage":{"additionalProperties":false,"properties":{"creditsRemaining":{"description":"Credits left under the tightest limit right now, null when unlimited","format":"int64","type":["integer","null"]},"creditsUsed":{"format":"int64","type":"integer"},"from":{"format":"date-time","type":"string"},"keyId":{"description":"The key making this call","type":"string"},"lines":{"items":{"$ref":"#/components/schemas/UsageLine"},"type":"array"},"to":{"format":"date-time","type":"string"}},"required":["from","to","keyId","creditsUsed","creditsRemaining","lines"],"type":"object"},"UsageLine":{"additionalProperties":false,"properties":{"credits":{"format":"int64","type":"integer"},"keyId":{"type":"string"},"operationId":{"type":"string"},"requests":{"format":"int64","type":"integer"}},"required":["keyId","operationId","requests","credits"],"type":"object"},"UsageResponse":{"additionalProperties":false,"properties":{"data":{"$ref":"#/components/schemas/Usage"},"meta":{"$ref":"#/components/schemas/ResourceMeta"}},"required":["data","meta"],"type":"object"},"Valuation":{"additionalProperties":false,"properties":{"asOf":{"description":"The point in time this data describes. For history and events it's the date of the newest record, or the end of your range when there are none. Live values give when they were observed, and reference data gives when we last checked it with a source","format":"date-time","type":"string"},"circulatingSupply":{"description":"Coins in circulation, for crypto","format":"double","type":["number","null"]},"currency":{"description":"Of price, marketCap and fdv","type":"string"},"date":{"description":"The day the figures are for","format":"date","type":"string"},"fdv":{"description":"Fully diluted valuation, null with date","format":"double","type":["number","null"]},"instrument":{"$ref":"#/components/schemas/Instrument","description":"What the symbol resolved to"},"marketCap":{"format":"double","type":"number"},"maxSupply":{"description":"Null with date","format":"double","type":["number","null"]},"price":{"description":"What each share or coin was valued at, null with date","format":"double","type":["number","null"]},"sharesOutstanding":{"description":"The company-wide share count, or a fund's units on issue","format":"double","type":["number","null"]},"symbol":{"description":"The symbol as sent","type":"string"},"totalSupply":{"description":"Null with date","format":"double","type":["number","null"]}},"required":["date","currency","price","marketCap","sharesOutstanding","circulatingSupply","totalSupply","maxSupply","fdv","symbol","instrument","asOf"],"type":"object"},"ValuationBatch":{"additionalProperties":false,"properties":{"data":{"items":{"$ref":"#/components/schemas/Valuation"},"type":"array"},"errors":{"items":{"$ref":"#/components/schemas/SymbolError"},"type":"array"},"meta":{"$ref":"#/components/schemas/Meta"}},"required":["data","errors","meta"],"type":"object"},"Wallet":{"additionalProperties":false,"properties":{"address":{"description":"The address as we read it, or xpub: and the sha256 of an xpub","type":"string"},"asOf":{"description":"The point in time this data describes. For history and events it's the date of the newest record, or the end of your range when there are none. Live values give when they were observed, and reference data gives when we last checked it with a source","format":"date-time","type":"string"},"balances":{"items":{"$ref":"#/components/schemas/Balance"},"type":"array"},"currency":{"description":"Currency of every value","type":"string"},"derived":{"description":"An xpub's balances split by derived address, empty for an address","items":{"$ref":"#/components/schemas/Balance"},"type":"array"}},"required":["address","currency","balances","derived","asOf"],"type":"object"},"WalletBatch":{"additionalProperties":false,"properties":{"data":{"items":{"$ref":"#/components/schemas/Wallet"},"type":"array"},"errors":{"items":{"$ref":"#/components/schemas/AddressError"},"type":"array"},"meta":{"$ref":"#/components/schemas/Meta"}},"required":["data","errors","meta"],"type":"object"}},"securitySchemes":{"bearer":{"description":"Your API key, qv_ followed by 43 characters","scheme":"bearer","type":"http"}}},"info":{"description":"Market data for every listed and traded instrument. Every operation lists its credit cost in x-credits.","title":"Quova API","version":"1.0.0"},"openapi":"3.1.0","paths":{"/v1/calendar/{type}":{"get":{"description":"Events in a range of up to 90 days, in date order. Each event fills in the object named after its calendar and leaves the others with null fields.","operationId":"company.calendar","parameters":[{"in":"path","name":"type","required":true,"schema":{"enum":["earnings","ipos","economic"],"examples":["ipos"],"type":"string"}},{"description":"First day, YYYY-MM-DD","explode":false,"in":"query","name":"from","required":true,"schema":{"description":"First day, YYYY-MM-DD","examples":["2026-06-01"],"format":"date","type":"string"}},{"description":"Last day, at most 90 days after from","explode":false,"in":"query","name":"to","required":true,"schema":{"description":"Last day, at most 90 days after from","examples":["2026-06-07"],"format":"date","type":"string"}},{"description":"Comma separated MICs for ipos, and countries for earnings and economic","explode":false,"in":"query","name":"regions","required":true,"schema":{"description":"Comma separated MICs for ipos, and countries for earnings and economic","examples":[["XNAS"]],"items":{"type":"string"},"maxItems":50,"minItems":1,"type":"array"}},{"description":"Skip our cache and fetch from sources. Items fetched fresh cost double","explode":false,"in":"query","name":"fresh","schema":{"description":"Skip our cache and fetch from sources. Items fetched fresh cost double","type":"boolean"}},{"description":"Response format","explode":false,"in":"query","name":"format","schema":{"default":"json","description":"Response format","enum":["json","csv"],"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CalendarEventList"}},"text/csv":{"schema":{"type":"string"}}},"description":"OK","headers":{"Batch-Errors":{"schema":{"description":"How many inputs failed. Sent with format=csv, whose body only has data rows","type":"string"}},"Content-Type":{"schema":{"description":"application/json, or text/csv with format=csv","type":"string"}},"Credits-Remaining":{"schema":{"description":"Credits left under the tightest limit on this key or organisation","type":"string"}}}},"400":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"description":"Bad Request"},"401":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"description":"Unauthorized"},"402":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"description":"Payment Required"},"403":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"description":"Forbidden"},"422":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"description":"Unprocessable Entity"},"429":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"description":"Too Many Requests"},"500":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"description":"Internal Server Error"},"503":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"description":"Service Unavailable"}},"security":[{"bearer":[]}],"summary":"Earnings, IPO and economic calendars","tags":["Company data"],"x-credits":{"freshMultiplier":2,"per":"call","weight":1}}},"/v1/chains":{"get":{"description":"Every chain we cover. Token symbols use the namespace, like SOLANA:9BB6...pump.","operationId":"reference.chains","parameters":[{"description":"Skip our cache and fetch from sources. Items fetched fresh cost double","explode":false,"in":"query","name":"fresh","schema":{"description":"Skip our cache and fetch from sources. Items fetched fresh cost double","type":"boolean"}},{"description":"Response format","explode":false,"in":"query","name":"format","schema":{"default":"json","description":"Response format","enum":["json","csv"],"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChainInfoList"}},"text/csv":{"schema":{"type":"string"}}},"description":"OK","headers":{"Batch-Errors":{"schema":{"description":"How many inputs failed. Sent with format=csv, whose body only has data rows","type":"string"}},"Content-Type":{"schema":{"description":"application/json, or text/csv with format=csv","type":"string"}},"Credits-Remaining":{"schema":{"description":"Credits left under the tightest limit on this key or organisation","type":"string"}}}},"400":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"description":"Bad Request"},"401":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"description":"Unauthorized"},"402":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"description":"Payment Required"},"403":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"description":"Forbidden"},"422":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"description":"Unprocessable Entity"},"429":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"description":"Too Many Requests"},"500":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"description":"Internal Server Error"},"503":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"description":"Service Unavailable"}},"security":[{"bearer":[]}],"summary":"Supported chains","tags":["Reference"],"x-credits":{"per":"call","weight":0}}},"/v1/corporate-actions":{"get":{"description":"Splits, consolidations, demergers, mergers, returns of capital, symbol and name changes and delistings. type says which detail object is filled in, the others have null fields. from and to bound the effective date.","operationId":"income.corporateActions","parameters":[{"description":"Comma separated identifiers, up to 100, like ASX:VAS, isin:AU000000VAS1 or ins_...","explode":false,"in":"query","name":"symbols","required":true,"schema":{"description":"Comma separated identifiers, up to 100, like ASX:VAS, isin:AU000000VAS1 or ins_...","examples":[["ASX:BHP","ASX:ACE"]],"items":{"type":"string"},"maxItems":100,"minItems":1,"type":"array"}},{"description":"First day, YYYY-MM-DD","explode":false,"in":"query","name":"from","schema":{"description":"First day, YYYY-MM-DD","examples":["2015-01-01"],"format":"date","type":"string"}},{"description":"Last day, YYYY-MM-DD","explode":false,"in":"query","name":"to","schema":{"description":"Last day, YYYY-MM-DD","examples":["2023-12-31"],"format":"date","type":"string"}},{"description":"Skip our cache and fetch from sources. Items fetched fresh cost double","explode":false,"in":"query","name":"fresh","schema":{"description":"Skip our cache and fetch from sources. Items fetched fresh cost double","type":"boolean"}},{"description":"Response format","explode":false,"in":"query","name":"format","schema":{"default":"json","description":"Response format","enum":["json","csv"],"type":"string"}},{"description":"Comma separated action types, every type when empty","explode":false,"in":"query","name":"types","schema":{"description":"Comma separated action types, every type when empty","items":{"enum":["split","consolidation","demerger","merger","return_of_capital","symbol_change","name_change","delisting"],"type":"string"},"type":"array"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CorporateActionsBatch"}},"text/csv":{"schema":{"type":"string"}}},"description":"OK","headers":{"Batch-Errors":{"schema":{"description":"How many inputs failed. Sent with format=csv, whose body only has data rows","type":"string"}},"Content-Type":{"schema":{"description":"application/json, or text/csv with format=csv","type":"string"}},"Credits-Remaining":{"schema":{"description":"Credits left under the tightest limit on this key or organisation","type":"string"}}}},"400":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"description":"Bad Request"},"401":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"description":"Unauthorized"},"402":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"description":"Payment Required"},"403":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"description":"Forbidden"},"422":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"description":"Unprocessable Entity"},"429":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"description":"Too Many Requests"},"500":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"description":"Internal Server Error"},"503":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"description":"Service Unavailable"}},"security":[{"bearer":[]}],"summary":"Corporate actions","tags":["Income and corporate actions"],"x-credits":{"freshMultiplier":2,"per":"instrument","weight":1}}},"/v1/currencies":{"get":{"description":"Every currency prices can be converted into with currency=.","operationId":"reference.currencies","parameters":[{"description":"Skip our cache and fetch from sources. Items fetched fresh cost double","explode":false,"in":"query","name":"fresh","schema":{"description":"Skip our cache and fetch from sources. Items fetched fresh cost double","type":"boolean"}},{"description":"Response format","explode":false,"in":"query","name":"format","schema":{"default":"json","description":"Response format","enum":["json","csv"],"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CurrencyInfoList"}},"text/csv":{"schema":{"type":"string"}}},"description":"OK","headers":{"Batch-Errors":{"schema":{"description":"How many inputs failed. Sent with format=csv, whose body only has data rows","type":"string"}},"Content-Type":{"schema":{"description":"application/json, or text/csv with format=csv","type":"string"}},"Credits-Remaining":{"schema":{"description":"Credits left under the tightest limit on this key or organisation","type":"string"}}}},"400":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"description":"Bad Request"},"401":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"description":"Unauthorized"},"402":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"description":"Payment Required"},"403":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"description":"Forbidden"},"422":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"description":"Unprocessable Entity"},"429":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"description":"Too Many Requests"},"500":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"description":"Internal Server Error"},"503":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"description":"Service Unavailable"}},"security":[{"bearer":[]}],"summary":"Supported currencies","tags":["Reference"],"x-credits":{"per":"call","weight":0}}},"/v1/dividends":{"get":{"description":"Every dividend with its dates, the amount as declared and adjusted for later splits, reinvestment plan details and Australian franking. from and to bound the ex date. Status firms up from announced to confirmed to paid.","operationId":"income.dividends","parameters":[{"description":"Comma separated identifiers, up to 100, like ASX:VAS, isin:AU000000VAS1 or ins_...","explode":false,"in":"query","name":"symbols","required":true,"schema":{"description":"Comma separated identifiers, up to 100, like ASX:VAS, isin:AU000000VAS1 or ins_...","examples":[["NASDAQ:AAPL","ASX:BHP"]],"items":{"type":"string"},"maxItems":100,"minItems":1,"type":"array"}},{"description":"First day, YYYY-MM-DD","explode":false,"in":"query","name":"from","schema":{"description":"First day, YYYY-MM-DD","examples":["2026-01-01"],"format":"date","type":"string"}},{"description":"Last day, YYYY-MM-DD","explode":false,"in":"query","name":"to","schema":{"description":"Last day, YYYY-MM-DD","examples":["2026-06-30"],"format":"date","type":"string"}},{"description":"Skip our cache and fetch from sources. Items fetched fresh cost double","explode":false,"in":"query","name":"fresh","schema":{"description":"Skip our cache and fetch from sources. Items fetched fresh cost double","type":"boolean"}},{"description":"Response format","explode":false,"in":"query","name":"format","schema":{"default":"json","description":"Response format","enum":["json","csv"],"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DividendsBatch"}},"text/csv":{"schema":{"type":"string"}}},"description":"OK","headers":{"Batch-Errors":{"schema":{"description":"How many inputs failed. Sent with format=csv, whose body only has data rows","type":"string"}},"Content-Type":{"schema":{"description":"application/json, or text/csv with format=csv","type":"string"}},"Credits-Remaining":{"schema":{"description":"Credits left under the tightest limit on this key or organisation","type":"string"}}}},"400":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"description":"Bad Request"},"401":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"description":"Unauthorized"},"402":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"description":"Payment Required"},"403":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"description":"Forbidden"},"422":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"description":"Unprocessable Entity"},"429":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"description":"Too Many Requests"},"500":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"description":"Internal Server Error"},"503":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"description":"Service Unavailable"}},"security":[{"bearer":[]}],"summary":"Dividends and distributions","tags":["Income and corporate actions"],"x-credits":{"freshMultiplier":2,"per":"instrument","weight":1}}},"/v1/earnings":{"get":{"description":"Reported and upcoming results per period, EPS and revenue against the consensus estimate, oldest first. Actuals are null until the report is out. from and to bound period ends.","operationId":"company.earnings","parameters":[{"description":"Comma separated identifiers, up to 100, like ASX:VAS, isin:AU000000VAS1 or ins_...","explode":false,"in":"query","name":"symbols","required":true,"schema":{"description":"Comma separated identifiers, up to 100, like ASX:VAS, isin:AU000000VAS1 or ins_...","examples":[["NASDAQ:AAPL","ASX:BHP"]],"items":{"type":"string"},"maxItems":100,"minItems":1,"type":"array"}},{"description":"First day, YYYY-MM-DD","explode":false,"in":"query","name":"from","schema":{"description":"First day, YYYY-MM-DD","examples":["2026-01-01"],"format":"date","type":"string"}},{"description":"Last day, YYYY-MM-DD","explode":false,"in":"query","name":"to","schema":{"description":"Last day, YYYY-MM-DD","examples":["2026-06-30"],"format":"date","type":"string"}},{"description":"Skip our cache and fetch from sources. Items fetched fresh cost double","explode":false,"in":"query","name":"fresh","schema":{"description":"Skip our cache and fetch from sources. Items fetched fresh cost double","type":"boolean"}},{"description":"Response format","explode":false,"in":"query","name":"format","schema":{"default":"json","description":"Response format","enum":["json","csv"],"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EarningsBatch"}},"text/csv":{"schema":{"type":"string"}}},"description":"OK","headers":{"Batch-Errors":{"schema":{"description":"How many inputs failed. Sent with format=csv, whose body only has data rows","type":"string"}},"Content-Type":{"schema":{"description":"application/json, or text/csv with format=csv","type":"string"}},"Credits-Remaining":{"schema":{"description":"Credits left under the tightest limit on this key or organisation","type":"string"}}}},"400":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"description":"Bad Request"},"401":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"description":"Unauthorized"},"402":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"description":"Payment Required"},"403":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"description":"Forbidden"},"422":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"description":"Unprocessable Entity"},"429":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"description":"Too Many Requests"},"500":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"description":"Internal Server Error"},"503":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"description":"Service Unavailable"}},"security":[{"bearer":[]}],"summary":"Earnings","tags":["Company data"],"x-credits":{"freshMultiplier":2,"per":"instrument","weight":2}}},"/v1/exchanges":{"get":{"description":"Every exchange we cover with its country, timezone, currency and regular trading hours in local time.","operationId":"reference.exchanges","parameters":[{"description":"Skip our cache and fetch from sources. Items fetched fresh cost double","explode":false,"in":"query","name":"fresh","schema":{"description":"Skip our cache and fetch from sources. Items fetched fresh cost double","type":"boolean"}},{"description":"Response format","explode":false,"in":"query","name":"format","schema":{"default":"json","description":"Response format","enum":["json","csv"],"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExchangeList"}},"text/csv":{"schema":{"type":"string"}}},"description":"OK","headers":{"Batch-Errors":{"schema":{"description":"How many inputs failed. Sent with format=csv, whose body only has data rows","type":"string"}},"Content-Type":{"schema":{"description":"application/json, or text/csv with format=csv","type":"string"}},"Credits-Remaining":{"schema":{"description":"Credits left under the tightest limit on this key or organisation","type":"string"}}}},"400":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"description":"Bad Request"},"401":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"description":"Unauthorized"},"402":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"description":"Payment Required"},"403":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"description":"Forbidden"},"422":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"description":"Unprocessable Entity"},"429":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"description":"Too Many Requests"},"500":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"description":"Internal Server Error"},"503":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"description":"Service Unavailable"}},"security":[{"bearer":[]}],"summary":"Exchanges","tags":["Reference"],"x-credits":{"per":"call","weight":0}}},"/v1/exchanges/{mic}/calendar":{"get":{"description":"Trading sessions between from and to with their open, close and breaks in UTC, plus the holidays and early closes in that range. Up to five years per call.","operationId":"reference.exchangeCalendar","parameters":[{"description":"A MIC, or an alias like ASX","in":"path","name":"mic","required":true,"schema":{"description":"A MIC, or an alias like ASX","examples":["XASX"],"maxLength":16,"type":"string"}},{"description":"First day, YYYY-MM-DD","explode":false,"in":"query","name":"from","required":true,"schema":{"description":"First day, YYYY-MM-DD","examples":["2026-04-01"],"format":"date","type":"string"}},{"description":"Last day, YYYY-MM-DD","explode":false,"in":"query","name":"to","required":true,"schema":{"description":"Last day, YYYY-MM-DD","examples":["2026-04-30"],"format":"date","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExchangeCalendarResponse"}}},"description":"OK","headers":{"Batch-Errors":{"schema":{"description":"How many inputs failed. Sent with format=csv, whose body only has data rows","type":"string"}},"Content-Type":{"schema":{"description":"application/json, or text/csv with format=csv","type":"string"}},"Credits-Remaining":{"schema":{"description":"Credits left under the tightest limit on this key or organisation","type":"string"}}}},"400":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"description":"Bad Request"},"401":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"description":"Unauthorized"},"402":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"description":"Payment Required"},"403":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"description":"Forbidden"},"404":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"description":"Not Found"},"422":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"description":"Unprocessable Entity"},"429":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"description":"Too Many Requests"},"500":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"description":"Internal Server Error"},"503":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"description":"Service Unavailable"}},"security":[{"bearer":[]}],"summary":"Exchange trading calendar","tags":["Reference"],"x-credits":{"per":"call","weight":0}}},"/v1/exchanges/{mic}/instruments":{"get":{"description":"The exchange's whole listing universe, ordered by ticker.","operationId":"reference.exchangeInstruments","parameters":[{"description":"A MIC, or an alias like ASX","in":"path","name":"mic","required":true,"schema":{"description":"A MIC, or an alias like ASX","examples":["XASX"],"maxLength":16,"type":"string"}},{"description":"From meta.nextCursor of the previous page","explode":false,"in":"query","name":"cursor","schema":{"description":"From meta.nextCursor of the previous page","maxLength":512,"type":"string"}},{"description":"Page size","explode":false,"in":"query","name":"limit","schema":{"default":100,"description":"Page size","examples":[5],"format":"int64","maximum":1000,"minimum":1,"type":"integer"}},{"description":"Skip our cache and fetch from sources. Items fetched fresh cost double","explode":false,"in":"query","name":"fresh","schema":{"description":"Skip our cache and fetch from sources. Items fetched fresh cost double","type":"boolean"}},{"description":"Response format","explode":false,"in":"query","name":"format","schema":{"default":"json","description":"Response format","enum":["json","csv"],"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListedInstrumentList"}},"text/csv":{"schema":{"type":"string"}}},"description":"OK","headers":{"Batch-Errors":{"schema":{"description":"How many inputs failed. Sent with format=csv, whose body only has data rows","type":"string"}},"Content-Type":{"schema":{"description":"application/json, or text/csv with format=csv","type":"string"}},"Credits-Remaining":{"schema":{"description":"Credits left under the tightest limit on this key or organisation","type":"string"}}}},"400":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"description":"Bad Request"},"401":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"description":"Unauthorized"},"402":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"description":"Payment Required"},"403":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"description":"Forbidden"},"404":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"description":"Not Found"},"422":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"description":"Unprocessable Entity"},"429":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"description":"Too Many Requests"},"500":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"description":"Internal Server Error"},"503":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"description":"Service Unavailable"}},"security":[{"bearer":[]}],"summary":"Instruments listed on an exchange","tags":["Reference"],"x-credits":{"freshMultiplier":2,"per":"page","weight":1}}},"/v1/filings":{"get":{"description":"Every filing and announcement a company made, oldest first. Document URLs are ours, so they're stable. from and to bound the publish date in UTC.","operationId":"filings.list","parameters":[{"description":"Comma separated identifiers, up to 100, like ASX:VAS, isin:AU000000VAS1 or ins_...","explode":false,"in":"query","name":"symbols","required":true,"schema":{"description":"Comma separated identifiers, up to 100, like ASX:VAS, isin:AU000000VAS1 or ins_...","examples":[["NASDAQ:AAPL","ASX:BHP"]],"items":{"type":"string"},"maxItems":100,"minItems":1,"type":"array"}},{"description":"First day, YYYY-MM-DD","explode":false,"in":"query","name":"from","schema":{"description":"First day, YYYY-MM-DD","examples":["2026-06-01"],"format":"date","type":"string"}},{"description":"Last day, YYYY-MM-DD","explode":false,"in":"query","name":"to","schema":{"description":"Last day, YYYY-MM-DD","examples":["2026-06-30"],"format":"date","type":"string"}},{"description":"Skip our cache and fetch from sources. Items fetched fresh cost double","explode":false,"in":"query","name":"fresh","schema":{"description":"Skip our cache and fetch from sources. Items fetched fresh cost double","type":"boolean"}},{"description":"Response format","explode":false,"in":"query","name":"format","schema":{"default":"json","description":"Response format","enum":["json","csv"],"type":"string"}},{"description":"Comma separated filing types, every type when empty","explode":false,"in":"query","name":"types","schema":{"description":"Comma separated filing types, every type when empty","items":{"enum":["annual_report","interim_report","quarterly_report","current_report","proxy","registration","insider","ownership","announcement","other"],"type":"string"},"type":"array"}},{"description":"Comma separated forms as the regulator names them, like 10-K or Appendix 3Y","explode":false,"in":"query","name":"forms","schema":{"description":"Comma separated forms as the regulator names them, like 10-K or Appendix 3Y","items":{"type":"string"},"maxItems":50,"type":"array"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FilingsBatch"}},"text/csv":{"schema":{"type":"string"}}},"description":"OK","headers":{"Batch-Errors":{"schema":{"description":"How many inputs failed. Sent with format=csv, whose body only has data rows","type":"string"}},"Content-Type":{"schema":{"description":"application/json, or text/csv with format=csv","type":"string"}},"Credits-Remaining":{"schema":{"description":"Credits left under the tightest limit on this key or organisation","type":"string"}}}},"400":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"description":"Bad Request"},"401":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"description":"Unauthorized"},"402":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"description":"Payment Required"},"403":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"description":"Forbidden"},"422":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"description":"Unprocessable Entity"},"429":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"description":"Too Many Requests"},"500":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"description":"Internal Server Error"},"503":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"description":"Service Unavailable"}},"security":[{"bearer":[]}],"summary":"Filings and announcements","tags":["Company data"],"x-credits":{"freshMultiplier":2,"per":"instrument","weight":2}}},"/v1/filings/search":{"get":{"description":"Filings whose documents match q, best first. q takes quoted phrases, OR, and a leading minus to leave a word out. Reports and announcements from the last three years can be searched as soon as we hold them. Older or very large filings become searchable once someone opens them with filings.get.","operationId":"filings.search","parameters":[{"explode":false,"in":"query","name":"q","required":true,"schema":{"examples":["\"chief executive\" -buyback"],"maxLength":500,"minLength":2,"type":"string"}},{"description":"Comma separated identifiers to search the filings of. Any of their filings in the date range that we don't hold yet are fetched first. Leave it empty to search every filing we hold","explode":false,"in":"query","name":"symbols","schema":{"description":"Comma separated identifiers to search the filings of. Any of their filings in the date range that we don't hold yet are fetched first. Leave it empty to search every filing we hold","examples":[["NASDAQ:AAPL","ASX:BHP"]],"items":{"type":"string"},"maxItems":100,"type":"array"}},{"explode":false,"in":"query","name":"limit","schema":{"default":20,"format":"int64","maximum":100,"minimum":1,"type":"integer"}},{"description":"First day, YYYY-MM-DD","explode":false,"in":"query","name":"from","schema":{"description":"First day, YYYY-MM-DD","examples":["2026-04-01"],"format":"date","type":"string"}},{"description":"Last day, YYYY-MM-DD","explode":false,"in":"query","name":"to","schema":{"description":"Last day, YYYY-MM-DD","examples":["2026-04-30"],"format":"date","type":"string"}},{"description":"Skip our cache and fetch from sources. Items fetched fresh cost double","explode":false,"in":"query","name":"fresh","schema":{"description":"Skip our cache and fetch from sources. Items fetched fresh cost double","type":"boolean"}},{"description":"Response format","explode":false,"in":"query","name":"format","schema":{"default":"json","description":"Response format","enum":["json","csv"],"type":"string"}},{"description":"Comma separated filing types, every type when empty","explode":false,"in":"query","name":"types","schema":{"description":"Comma separated filing types, every type when empty","items":{"enum":["annual_report","interim_report","quarterly_report","current_report","proxy","registration","insider","ownership","announcement","other"],"type":"string"},"type":"array"}},{"description":"Comma separated forms as the regulator names them, like 10-K or Appendix 3Y","explode":false,"in":"query","name":"forms","schema":{"description":"Comma separated forms as the regulator names them, like 10-K or Appendix 3Y","items":{"type":"string"},"maxItems":50,"type":"array"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FilingHitList"}},"text/csv":{"schema":{"type":"string"}}},"description":"OK","headers":{"Batch-Errors":{"schema":{"description":"How many inputs failed. Sent with format=csv, whose body only has data rows","type":"string"}},"Content-Type":{"schema":{"description":"application/json, or text/csv with format=csv","type":"string"}},"Credits-Remaining":{"schema":{"description":"Credits left under the tightest limit on this key or organisation","type":"string"}}}},"400":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"description":"Bad Request"},"401":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"description":"Unauthorized"},"402":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"description":"Payment Required"},"403":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"description":"Forbidden"},"422":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"description":"Unprocessable Entity"},"429":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"description":"Too Many Requests"},"500":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"description":"Internal Server Error"},"503":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"description":"Service Unavailable"}},"security":[{"bearer":[]}],"summary":"Full text search across filings","tags":["Company data"],"x-credits":{"freshMultiplier":2,"per":"call","weight":5}}},"/v1/filings/{id}":{"get":{"description":"A filing with the text of every document, and links to the originals.","operationId":"filings.get","parameters":[{"description":"From filings.list or filings.search","in":"path","name":"id","required":true,"schema":{"description":"From filings.list or filings.search","examples":["fil_qx4N01c27x5bJURh1rILe"],"pattern":"^fil_[0-9A-Za-z]{21}$","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FilingTextResponse"}}},"description":"OK","headers":{"Batch-Errors":{"schema":{"description":"How many inputs failed. Sent with format=csv, whose body only has data rows","type":"string"}},"Content-Type":{"schema":{"description":"application/json, or text/csv with format=csv","type":"string"}},"Credits-Remaining":{"schema":{"description":"Credits left under the tightest limit on this key or organisation","type":"string"}}}},"400":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"description":"Bad Request"},"401":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"description":"Unauthorized"},"402":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"description":"Payment Required"},"403":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"description":"Forbidden"},"404":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"description":"Not Found"},"422":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"description":"Unprocessable Entity"},"429":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"description":"Too Many Requests"},"500":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"description":"Internal Server Error"},"503":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"description":"Service Unavailable"}},"security":[{"bearer":[]}],"summary":"One filing with its full text","tags":["Company data"],"x-credits":{"freshMultiplier":2,"per":"call","weight":2}}},"/v1/financials":{"get":{"description":"One standardised statement per company, oldest period first. Values are in full units of the period's currency, never thousands, and carry the sign they have on the statement, except cash outflows, which are negative. from and to bound period ends.","operationId":"company.financials","parameters":[{"description":"Comma separated identifiers, up to 100, like ASX:VAS, isin:AU000000VAS1 or ins_...","explode":false,"in":"query","name":"symbols","required":true,"schema":{"description":"Comma separated identifiers, up to 100, like ASX:VAS, isin:AU000000VAS1 or ins_...","examples":[["NASDAQ:AAPL","ASX:BHP"]],"items":{"type":"string"},"maxItems":100,"minItems":1,"type":"array"}},{"description":"First day, YYYY-MM-DD","explode":false,"in":"query","name":"from","schema":{"description":"First day, YYYY-MM-DD","examples":["2024-01-01"],"format":"date","type":"string"}},{"description":"Last day, YYYY-MM-DD","explode":false,"in":"query","name":"to","schema":{"description":"Last day, YYYY-MM-DD","examples":["2025-12-31"],"format":"date","type":"string"}},{"description":"Skip our cache and fetch from sources. Items fetched fresh cost double","explode":false,"in":"query","name":"fresh","schema":{"description":"Skip our cache and fetch from sources. Items fetched fresh cost double","type":"boolean"}},{"description":"Response format","explode":false,"in":"query","name":"format","schema":{"default":"json","description":"Response format","enum":["json","csv"],"type":"string"}},{"explode":false,"in":"query","name":"statement","required":true,"schema":{"enum":["income","balance","cash_flow"],"type":"string"}},{"description":"ttm periods are labelled by the quarter they end with","explode":false,"in":"query","name":"period","schema":{"default":"annual","description":"ttm periods are labelled by the quarter they end with","enum":["annual","half","quarterly","ttm"],"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FinancialsBatch"}},"text/csv":{"schema":{"type":"string"}}},"description":"OK","headers":{"Batch-Errors":{"schema":{"description":"How many inputs failed. Sent with format=csv, whose body only has data rows","type":"string"}},"Content-Type":{"schema":{"description":"application/json, or text/csv with format=csv","type":"string"}},"Credits-Remaining":{"schema":{"description":"Credits left under the tightest limit on this key or organisation","type":"string"}}}},"400":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"description":"Bad Request"},"401":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"description":"Unauthorized"},"402":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"description":"Payment Required"},"403":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"description":"Forbidden"},"422":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"description":"Unprocessable Entity"},"429":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"description":"Too Many Requests"},"500":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"description":"Internal Server Error"},"503":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"description":"Service Unavailable"}},"security":[{"bearer":[]}],"summary":"Financial statements","tags":["Company data"],"x-credits":{"freshMultiplier":2,"per":"instrument","weight":2}}},"/v1/funds":{"get":{"description":"Issuer, benchmark, fees, domicile and distribution frequency, with the latest net assets, NAV and units on issue. Fees are yearly percentages of net assets, 0.07 for 0.07%.","operationId":"funds.profiles","parameters":[{"description":"Comma separated identifiers, up to 100, like ASX:VAS, isin:AU000000VAS1 or ins_...","explode":false,"in":"query","name":"symbols","required":true,"schema":{"description":"Comma separated identifiers, up to 100, like ASX:VAS, isin:AU000000VAS1 or ins_...","examples":[["ASX:VAS","ASX:VGS"]],"items":{"type":"string"},"maxItems":100,"minItems":1,"type":"array"}},{"description":"Skip our cache and fetch from sources. Items fetched fresh cost double","explode":false,"in":"query","name":"fresh","schema":{"description":"Skip our cache and fetch from sources. Items fetched fresh cost double","type":"boolean"}},{"description":"Response format","explode":false,"in":"query","name":"format","schema":{"default":"json","description":"Response format","enum":["json","csv"],"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FundBatch"}},"text/csv":{"schema":{"type":"string"}}},"description":"OK","headers":{"Batch-Errors":{"schema":{"description":"How many inputs failed. Sent with format=csv, whose body only has data rows","type":"string"}},"Content-Type":{"schema":{"description":"application/json, or text/csv with format=csv","type":"string"}},"Credits-Remaining":{"schema":{"description":"Credits left under the tightest limit on this key or organisation","type":"string"}}}},"400":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"description":"Bad Request"},"401":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"description":"Unauthorized"},"402":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"description":"Payment Required"},"403":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"description":"Forbidden"},"422":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"description":"Unprocessable Entity"},"429":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"description":"Too Many Requests"},"500":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"description":"Internal Server Error"},"503":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"description":"Service Unavailable"}},"security":[{"bearer":[]}],"summary":"Fund profiles","tags":["Funds"],"x-credits":{"freshMultiplier":2,"per":"instrument","weight":1}}},"/v1/holdings":{"get":{"description":"Every position of a fund with its weight, from the latest snapshot or the one on or before date. An index like INDEX:AXJO returns the holdings of a fund tracking it, named in fund.","operationId":"funds.holdings","parameters":[{"description":"Comma separated identifiers, up to 100, like ASX:VAS, isin:AU000000VAS1 or ins_...","explode":false,"in":"query","name":"symbols","required":true,"schema":{"description":"Comma separated identifiers, up to 100, like ASX:VAS, isin:AU000000VAS1 or ins_...","examples":[["ASX:ILC"]],"items":{"type":"string"},"maxItems":100,"minItems":1,"type":"array"}},{"description":"Skip our cache and fetch from sources. Items fetched fresh cost double","explode":false,"in":"query","name":"fresh","schema":{"description":"Skip our cache and fetch from sources. Items fetched fresh cost double","type":"boolean"}},{"description":"Response format","explode":false,"in":"query","name":"format","schema":{"default":"json","description":"Response format","enum":["json","csv"],"type":"string"}},{"description":"Return the snapshot on or before this day","explode":false,"in":"query","name":"date","schema":{"description":"Return the snapshot on or before this day","examples":["2026-06-30"],"format":"date","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HoldingsBatch"}},"text/csv":{"schema":{"type":"string"}}},"description":"OK","headers":{"Batch-Errors":{"schema":{"description":"How many inputs failed. Sent with format=csv, whose body only has data rows","type":"string"}},"Content-Type":{"schema":{"description":"application/json, or text/csv with format=csv","type":"string"}},"Credits-Remaining":{"schema":{"description":"Credits left under the tightest limit on this key or organisation","type":"string"}}}},"400":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"description":"Bad Request"},"401":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"description":"Unauthorized"},"402":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"description":"Payment Required"},"403":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"description":"Forbidden"},"422":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"description":"Unprocessable Entity"},"429":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"description":"Too Many Requests"},"500":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"description":"Internal Server Error"},"503":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"description":"Service Unavailable"}},"security":[{"bearer":[]}],"summary":"Fund holdings","tags":["Funds"],"x-credits":{"freshMultiplier":2,"per":"instrument","weight":2}}},"/v1/instruments":{"get":{"description":"Every identifier we hold, status, listing dates, and the history of listings and names. Licensed identifiers like CUSIP and SEDOL work as symbols but are never returned.","operationId":"reference.instruments","parameters":[{"description":"Comma separated identifiers, up to 100, like ASX:VAS, isin:AU000000VAS1 or ins_...","explode":false,"in":"query","name":"symbols","required":true,"schema":{"description":"Comma separated identifiers, up to 100, like ASX:VAS, isin:AU000000VAS1 or ins_...","examples":[["NASDAQ:AAPL","ASX:BHP"]],"items":{"type":"string"},"maxItems":100,"minItems":1,"type":"array"}},{"description":"Skip our cache and fetch from sources. Items fetched fresh cost double","explode":false,"in":"query","name":"fresh","schema":{"description":"Skip our cache and fetch from sources. Items fetched fresh cost double","type":"boolean"}},{"description":"Response format","explode":false,"in":"query","name":"format","schema":{"default":"json","description":"Response format","enum":["json","csv"],"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InstrumentDetailsBatch"}},"text/csv":{"schema":{"type":"string"}}},"description":"OK","headers":{"Batch-Errors":{"schema":{"description":"How many inputs failed. Sent with format=csv, whose body only has data rows","type":"string"}},"Content-Type":{"schema":{"description":"application/json, or text/csv with format=csv","type":"string"}},"Credits-Remaining":{"schema":{"description":"Credits left under the tightest limit on this key or organisation","type":"string"}}}},"400":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"description":"Bad Request"},"401":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"description":"Unauthorized"},"402":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"description":"Payment Required"},"403":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"description":"Forbidden"},"422":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"description":"Unprocessable Entity"},"429":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"description":"Too Many Requests"},"500":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"description":"Internal Server Error"},"503":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"description":"Service Unavailable"}},"security":[{"bearer":[]}],"summary":"Instrument details","tags":["Reference"],"x-credits":{"freshMultiplier":2,"per":"instrument","weight":1}}},"/v1/macro/observations":{"get":{"description":"Each series' values by period with the date each was released, so a revision shows up as a later release. frequency downsamples to a coarser one, keeping only complete periods.","operationId":"macro.observations","parameters":[{"description":"Comma separated codes from /v1/macro/series, up to 100","explode":false,"in":"query","name":"series","required":true,"schema":{"description":"Comma separated codes from /v1/macro/series, up to 100","examples":[["AU.CPI.YOY","US.POLICY_RATE"]],"items":{"type":"string"},"maxItems":100,"minItems":1,"type":"array"}},{"description":"First day, YYYY-MM-DD","explode":false,"in":"query","name":"from","schema":{"description":"First day, YYYY-MM-DD","examples":["2026-01-01"],"format":"date","type":"string"}},{"description":"Last day, YYYY-MM-DD","explode":false,"in":"query","name":"to","schema":{"description":"Last day, YYYY-MM-DD","examples":["2026-06-30"],"format":"date","type":"string"}},{"description":"Skip our cache and fetch from sources. Items fetched fresh cost double","explode":false,"in":"query","name":"fresh","schema":{"description":"Skip our cache and fetch from sources. Items fetched fresh cost double","type":"boolean"}},{"description":"Response format","explode":false,"in":"query","name":"format","schema":{"default":"json","description":"Response format","enum":["json","csv"],"type":"string"}},{"description":"Downsample to this frequency, which must not be finer than the series' own","explode":false,"in":"query","name":"frequency","schema":{"description":"Downsample to this frequency, which must not be finer than the series' own","enum":["daily","weekly","monthly","quarterly","annual"],"examples":["quarterly"],"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ObservationsBatch"}},"text/csv":{"schema":{"type":"string"}}},"description":"OK","headers":{"Batch-Errors":{"schema":{"description":"How many inputs failed. Sent with format=csv, whose body only has data rows","type":"string"}},"Content-Type":{"schema":{"description":"application/json, or text/csv with format=csv","type":"string"}},"Credits-Remaining":{"schema":{"description":"Credits left under the tightest limit on this key or organisation","type":"string"}}}},"400":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"description":"Bad Request"},"401":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"description":"Unauthorized"},"402":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"description":"Payment Required"},"403":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"description":"Forbidden"},"422":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"description":"Unprocessable Entity"},"429":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"description":"Too Many Requests"},"500":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"description":"Internal Server Error"},"503":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"description":"Service Unavailable"}},"security":[{"bearer":[]}],"summary":"Macro observations","tags":["Macro"],"x-credits":{"freshMultiplier":2,"per":"series","weight":1}}},"/v1/macro/series":{"get":{"description":"Every economic series we carry, like AU.CPI.YOY or US.POLICY_RATE, with its unit, frequency and the next expected release.","operationId":"macro.series","parameters":[{"description":"ISO country code, EA for the euro area","explode":false,"in":"query","name":"country","schema":{"description":"ISO country code, EA for the euro area","examples":["AU"],"pattern":"^[A-Za-z]{2}$","type":"string"}},{"explode":false,"in":"query","name":"category","schema":{"enum":["inflation","gdp","labour","rates"],"type":"string"}},{"explode":false,"in":"query","name":"frequency","schema":{"enum":["daily","weekly","monthly","quarterly","annual"],"type":"string"}},{"description":"Skip our cache and fetch from sources. Items fetched fresh cost double","explode":false,"in":"query","name":"fresh","schema":{"description":"Skip our cache and fetch from sources. Items fetched fresh cost double","type":"boolean"}},{"description":"Response format","explode":false,"in":"query","name":"format","schema":{"default":"json","description":"Response format","enum":["json","csv"],"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SeriesList"}},"text/csv":{"schema":{"type":"string"}}},"description":"OK","headers":{"Batch-Errors":{"schema":{"description":"How many inputs failed. Sent with format=csv, whose body only has data rows","type":"string"}},"Content-Type":{"schema":{"description":"application/json, or text/csv with format=csv","type":"string"}},"Credits-Remaining":{"schema":{"description":"Credits left under the tightest limit on this key or organisation","type":"string"}}}},"400":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"description":"Bad Request"},"401":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"description":"Unauthorized"},"402":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"description":"Payment Required"},"403":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"description":"Forbidden"},"422":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"description":"Unprocessable Entity"},"429":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"description":"Too Many Requests"},"500":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"description":"Internal Server Error"},"503":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"description":"Service Unavailable"}},"security":[{"bearer":[]}],"summary":"Macro series","tags":["Macro"],"x-credits":{"per":"call","weight":0}}},"/v1/metrics":{"get":{"description":"Market cap with the share count or coin supply behind it. Without date it's as of the latest price, with date as it stood at the close on or before that day, which leaves out the price and the supply figures only tracked live.","operationId":"company.metrics","parameters":[{"description":"Comma separated identifiers, up to 100, like ASX:VAS, isin:AU000000VAS1 or ins_...","explode":false,"in":"query","name":"symbols","required":true,"schema":{"description":"Comma separated identifiers, up to 100, like ASX:VAS, isin:AU000000VAS1 or ins_...","examples":[["NASDAQ:AAPL","ASX:BHP"]],"items":{"type":"string"},"maxItems":100,"minItems":1,"type":"array"}},{"description":"Convert every price into this ISO currency","explode":false,"in":"query","name":"currency","schema":{"description":"Convert every price into this ISO currency","examples":["USD"],"pattern":"^[A-Z]{3}$","type":"string"}},{"description":"Skip our cache and fetch from sources. Items fetched fresh cost double","explode":false,"in":"query","name":"fresh","schema":{"description":"Skip our cache and fetch from sources. Items fetched fresh cost double","type":"boolean"}},{"description":"Response format","explode":false,"in":"query","name":"format","schema":{"default":"json","description":"Response format","enum":["json","csv"],"type":"string"}},{"description":"Market cap at the close on or before this day, the latest when empty","explode":false,"in":"query","name":"date","schema":{"description":"Market cap at the close on or before this day, the latest when empty","examples":["2026-06-30"],"format":"date","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValuationBatch"}},"text/csv":{"schema":{"type":"string"}}},"description":"OK","headers":{"Batch-Errors":{"schema":{"description":"How many inputs failed. Sent with format=csv, whose body only has data rows","type":"string"}},"Content-Type":{"schema":{"description":"application/json, or text/csv with format=csv","type":"string"}},"Credits-Remaining":{"schema":{"description":"Credits left under the tightest limit on this key or organisation","type":"string"}}}},"400":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"description":"Bad Request"},"401":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"description":"Unauthorized"},"402":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"description":"Payment Required"},"403":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"description":"Forbidden"},"422":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"description":"Unprocessable Entity"},"429":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"description":"Too Many Requests"},"500":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"description":"Internal Server Error"},"503":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"description":"Service Unavailable"}},"security":[{"bearer":[]}],"summary":"Market cap","tags":["Company data"],"x-credits":{"freshMultiplier":2,"per":"instrument","weight":1}}},"/v1/ownership/holders":{"get":{"description":"institutional is the latest full scheduled report, like US 13F filings. substantial is each holder's latest notice of crossing a threshold, like ASX Form 604, leaving out holders who have exited. Largest first.","operationId":"ownership.holders","parameters":[{"description":"Comma separated identifiers, up to 100, like ASX:VAS, isin:AU000000VAS1 or ins_...","explode":false,"in":"query","name":"symbols","required":true,"schema":{"description":"Comma separated identifiers, up to 100, like ASX:VAS, isin:AU000000VAS1 or ins_...","examples":[["NASDAQ:CULP"]],"items":{"type":"string"},"maxItems":100,"minItems":1,"type":"array"}},{"description":"Skip our cache and fetch from sources. Items fetched fresh cost double","explode":false,"in":"query","name":"fresh","schema":{"description":"Skip our cache and fetch from sources. Items fetched fresh cost double","type":"boolean"}},{"description":"Response format","explode":false,"in":"query","name":"format","schema":{"default":"json","description":"Response format","enum":["json","csv"],"type":"string"}},{"explode":false,"in":"query","name":"type","schema":{"default":"institutional","enum":["institutional","substantial"],"type":"string"}},{"description":"Holders as they stood on this day, the latest when empty","explode":false,"in":"query","name":"date","schema":{"description":"Holders as they stood on this day, the latest when empty","examples":["2026-06-30"],"format":"date","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HoldersBatch"}},"text/csv":{"schema":{"type":"string"}}},"description":"OK","headers":{"Batch-Errors":{"schema":{"description":"How many inputs failed. Sent with format=csv, whose body only has data rows","type":"string"}},"Content-Type":{"schema":{"description":"application/json, or text/csv with format=csv","type":"string"}},"Credits-Remaining":{"schema":{"description":"Credits left under the tightest limit on this key or organisation","type":"string"}}}},"400":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"description":"Bad Request"},"401":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"description":"Unauthorized"},"402":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"description":"Payment Required"},"403":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"description":"Forbidden"},"422":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"description":"Unprocessable Entity"},"429":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"description":"Too Many Requests"},"500":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"description":"Internal Server Error"},"503":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"description":"Service Unavailable"}},"security":[{"bearer":[]}],"summary":"Institutional and substantial holders","tags":["Company data"],"x-credits":{"freshMultiplier":2,"per":"instrument","weight":2}}},"/v1/ownership/insider-trades":{"get":{"description":"Directors' and officers' trades from Form 4, Appendix 3Y and their equivalents, oldest first. shares is always positive and acquired says which way the trade went. from and to bound the trade date.","operationId":"ownership.insiderTrades","parameters":[{"description":"Comma separated identifiers, up to 100, like ASX:VAS, isin:AU000000VAS1 or ins_...","explode":false,"in":"query","name":"symbols","required":true,"schema":{"description":"Comma separated identifiers, up to 100, like ASX:VAS, isin:AU000000VAS1 or ins_...","examples":[["NASDAQ:AAPL","NASDAQ:NVDA"]],"items":{"type":"string"},"maxItems":100,"minItems":1,"type":"array"}},{"description":"First day, YYYY-MM-DD","explode":false,"in":"query","name":"from","schema":{"description":"First day, YYYY-MM-DD","examples":["2026-06-01"],"format":"date","type":"string"}},{"description":"Last day, YYYY-MM-DD","explode":false,"in":"query","name":"to","schema":{"description":"Last day, YYYY-MM-DD","examples":["2026-06-30"],"format":"date","type":"string"}},{"description":"Skip our cache and fetch from sources. Items fetched fresh cost double","explode":false,"in":"query","name":"fresh","schema":{"description":"Skip our cache and fetch from sources. Items fetched fresh cost double","type":"boolean"}},{"description":"Response format","explode":false,"in":"query","name":"format","schema":{"default":"json","description":"Response format","enum":["json","csv"],"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InsiderTradesBatch"}},"text/csv":{"schema":{"type":"string"}}},"description":"OK","headers":{"Batch-Errors":{"schema":{"description":"How many inputs failed. Sent with format=csv, whose body only has data rows","type":"string"}},"Content-Type":{"schema":{"description":"application/json, or text/csv with format=csv","type":"string"}},"Credits-Remaining":{"schema":{"description":"Credits left under the tightest limit on this key or organisation","type":"string"}}}},"400":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"description":"Bad Request"},"401":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"description":"Unauthorized"},"402":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"description":"Payment Required"},"403":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"description":"Forbidden"},"422":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"description":"Unprocessable Entity"},"429":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"description":"Too Many Requests"},"500":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"description":"Internal Server Error"},"503":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"description":"Service Unavailable"}},"security":[{"bearer":[]}],"summary":"Insider trades","tags":["Company data"],"x-credits":{"freshMultiplier":2,"per":"instrument","weight":2}}},"/v1/prices/daily":{"get":{"description":"Daily OHLCV on the exchange's local trading date. With date, returns the single bar on or before it. History length doesn't change the price.","operationId":"prices.daily","parameters":[{"description":"Comma separated identifiers, up to 100, like ASX:VAS, isin:AU000000VAS1 or ins_...","explode":false,"in":"query","name":"symbols","required":true,"schema":{"description":"Comma separated identifiers, up to 100, like ASX:VAS, isin:AU000000VAS1 or ins_...","examples":[["NASDAQ:AAPL","ASX:BHP"]],"items":{"type":"string"},"maxItems":100,"minItems":1,"type":"array"}},{"description":"First day, YYYY-MM-DD","explode":false,"in":"query","name":"from","schema":{"description":"First day, YYYY-MM-DD","examples":["2026-06-01"],"format":"date","type":"string"}},{"description":"Last day, YYYY-MM-DD","explode":false,"in":"query","name":"to","schema":{"description":"Last day, YYYY-MM-DD","examples":["2026-06-05"],"format":"date","type":"string"}},{"description":"Convert every price into this ISO currency","explode":false,"in":"query","name":"currency","schema":{"description":"Convert every price into this ISO currency","examples":["USD"],"pattern":"^[A-Z]{3}$","type":"string"}},{"description":"Skip our cache and fetch from sources. Items fetched fresh cost double","explode":false,"in":"query","name":"fresh","schema":{"description":"Skip our cache and fetch from sources. Items fetched fresh cost double","type":"boolean"}},{"description":"Response format","explode":false,"in":"query","name":"format","schema":{"default":"json","description":"Response format","enum":["json","csv"],"type":"string"}},{"description":"Return only the bar on or before this day","explode":false,"in":"query","name":"date","schema":{"description":"Return only the bar on or before this day","format":"date","type":"string"}},{"description":"none is raw, splits adjusts for splits, total also reinvests dividends","explode":false,"in":"query","name":"adjust","schema":{"default":"splits","description":"none is raw, splits adjusts for splits, total also reinvests dividends","enum":["none","splits","total"],"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DailySeriesBatch"}},"text/csv":{"schema":{"type":"string"}}},"description":"OK","headers":{"Batch-Errors":{"schema":{"description":"How many inputs failed. Sent with format=csv, whose body only has data rows","type":"string"}},"Content-Type":{"schema":{"description":"application/json, or text/csv with format=csv","type":"string"}},"Credits-Remaining":{"schema":{"description":"Credits left under the tightest limit on this key or organisation","type":"string"}}}},"400":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"description":"Bad Request"},"401":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"description":"Unauthorized"},"402":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"description":"Payment Required"},"403":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"description":"Forbidden"},"422":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"description":"Unprocessable Entity"},"429":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"description":"Too Many Requests"},"500":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"description":"Internal Server Error"},"503":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"description":"Service Unavailable"}},"security":[{"bearer":[]}],"summary":"End of day bars","tags":["Prices"],"x-credits":{"freshMultiplier":2,"per":"instrument","weight":1}}},"/v1/prices/intraday":{"get":{"description":"1m, 5m, 15m or 1h candles stamped in UTC, where from and to are UTC days. Pre and post market candles are left out unless extended is set.","operationId":"prices.intraday","parameters":[{"description":"Comma separated identifiers, up to 100, like ASX:VAS, isin:AU000000VAS1 or ins_...","explode":false,"in":"query","name":"symbols","required":true,"schema":{"description":"Comma separated identifiers, up to 100, like ASX:VAS, isin:AU000000VAS1 or ins_...","examples":[["NASDAQ:AAPL","ASX:BHP"]],"items":{"type":"string"},"maxItems":100,"minItems":1,"type":"array"}},{"description":"First day, YYYY-MM-DD","explode":false,"in":"query","name":"from","schema":{"description":"First day, YYYY-MM-DD","examples":["2026-06-15"],"format":"date","type":"string"}},{"description":"Last day, YYYY-MM-DD","explode":false,"in":"query","name":"to","schema":{"description":"Last day, YYYY-MM-DD","examples":["2026-06-15"],"format":"date","type":"string"}},{"description":"Convert every price into this ISO currency","explode":false,"in":"query","name":"currency","schema":{"description":"Convert every price into this ISO currency","examples":["USD"],"pattern":"^[A-Z]{3}$","type":"string"}},{"description":"Skip our cache and fetch from sources. Items fetched fresh cost double","explode":false,"in":"query","name":"fresh","schema":{"description":"Skip our cache and fetch from sources. Items fetched fresh cost double","type":"boolean"}},{"description":"Response format","explode":false,"in":"query","name":"format","schema":{"default":"json","description":"Response format","enum":["json","csv"],"type":"string"}},{"description":"Candle length","explode":false,"in":"query","name":"interval","required":true,"schema":{"description":"Candle length","enum":["1m","5m","15m","1h"],"examples":["1h"],"type":"string"}},{"description":"Keep pre and post market candles","explode":false,"in":"query","name":"extended","schema":{"description":"Keep pre and post market candles","type":"boolean"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/IntradaySeriesBatch"}},"text/csv":{"schema":{"type":"string"}}},"description":"OK","headers":{"Batch-Errors":{"schema":{"description":"How many inputs failed. Sent with format=csv, whose body only has data rows","type":"string"}},"Content-Type":{"schema":{"description":"application/json, or text/csv with format=csv","type":"string"}},"Credits-Remaining":{"schema":{"description":"Credits left under the tightest limit on this key or organisation","type":"string"}}}},"400":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"description":"Bad Request"},"401":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"description":"Unauthorized"},"402":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"description":"Payment Required"},"403":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"description":"Forbidden"},"422":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"description":"Unprocessable Entity"},"429":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"description":"Too Many Requests"},"500":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"description":"Internal Server Error"},"503":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"description":"Service Unavailable"}},"security":[{"bearer":[]}],"summary":"Intraday bars","tags":["Prices"],"x-credits":{"freshMultiplier":2,"per":"instrument","weight":1}}},"/v1/profiles":{"get":{"description":"Who a company is: its name, country, where it sits in our sector taxonomy, its logo and its identifiers. Unknown fields are null, and the industry is known once the company's exchange listing has been screened.","operationId":"company.profiles","parameters":[{"description":"Comma separated identifiers, up to 100, like ASX:VAS, isin:AU000000VAS1 or ins_...","explode":false,"in":"query","name":"symbols","required":true,"schema":{"description":"Comma separated identifiers, up to 100, like ASX:VAS, isin:AU000000VAS1 or ins_...","examples":[["NASDAQ:AAPL","ASX:BHP"]],"items":{"type":"string"},"maxItems":100,"minItems":1,"type":"array"}},{"description":"Skip our cache and fetch from sources. Items fetched fresh cost double","explode":false,"in":"query","name":"fresh","schema":{"description":"Skip our cache and fetch from sources. Items fetched fresh cost double","type":"boolean"}},{"description":"Response format","explode":false,"in":"query","name":"format","schema":{"default":"json","description":"Response format","enum":["json","csv"],"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CompanyProfileBatch"}},"text/csv":{"schema":{"type":"string"}}},"description":"OK","headers":{"Batch-Errors":{"schema":{"description":"How many inputs failed. Sent with format=csv, whose body only has data rows","type":"string"}},"Content-Type":{"schema":{"description":"application/json, or text/csv with format=csv","type":"string"}},"Credits-Remaining":{"schema":{"description":"Credits left under the tightest limit on this key or organisation","type":"string"}}}},"400":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"description":"Bad Request"},"401":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"description":"Unauthorized"},"402":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"description":"Payment Required"},"403":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"description":"Forbidden"},"422":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"description":"Unprocessable Entity"},"429":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"description":"Too Many Requests"},"500":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"description":"Internal Server Error"},"503":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"description":"Service Unavailable"}},"security":[{"bearer":[]}],"summary":"Company profiles","tags":["Company data"],"x-credits":{"freshMultiplier":2,"per":"instrument","weight":1}}},"/v1/quotes":{"get":{"description":"The latest delayed price with its change on the previous close, the day's range and volume, bid and ask, and the market state. delaySeconds says how far behind the quote is.","operationId":"prices.quotes","parameters":[{"description":"Comma separated identifiers, up to 100, like ASX:VAS, isin:AU000000VAS1 or ins_...","explode":false,"in":"query","name":"symbols","required":true,"schema":{"description":"Comma separated identifiers, up to 100, like ASX:VAS, isin:AU000000VAS1 or ins_...","examples":[["NASDAQ:AAPL","ASX:BHP"]],"items":{"type":"string"},"maxItems":100,"minItems":1,"type":"array"}},{"description":"Convert every price into this ISO currency","explode":false,"in":"query","name":"currency","schema":{"description":"Convert every price into this ISO currency","examples":["USD"],"pattern":"^[A-Z]{3}$","type":"string"}},{"description":"Skip our cache and fetch from sources. Items fetched fresh cost double","explode":false,"in":"query","name":"fresh","schema":{"description":"Skip our cache and fetch from sources. Items fetched fresh cost double","type":"boolean"}},{"description":"Response format","explode":false,"in":"query","name":"format","schema":{"default":"json","description":"Response format","enum":["json","csv"],"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QuoteBatch"}},"text/csv":{"schema":{"type":"string"}}},"description":"OK","headers":{"Batch-Errors":{"schema":{"description":"How many inputs failed. Sent with format=csv, whose body only has data rows","type":"string"}},"Content-Type":{"schema":{"description":"application/json, or text/csv with format=csv","type":"string"}},"Credits-Remaining":{"schema":{"description":"Credits left under the tightest limit on this key or organisation","type":"string"}}}},"400":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"description":"Bad Request"},"401":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"description":"Unauthorized"},"402":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"description":"Payment Required"},"403":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"description":"Forbidden"},"422":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"description":"Unprocessable Entity"},"429":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"description":"Too Many Requests"},"500":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"description":"Internal Server Error"},"503":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"description":"Service Unavailable"}},"security":[{"bearer":[]}],"summary":"Latest quotes","tags":["Prices"],"x-credits":{"freshMultiplier":2,"per":"instrument","weight":1}}},"/v1/screener":{"post":{"description":"Instruments matching every filter in the body, sorted and cut to limit. Leaving a filter out doesn't filter on it.","operationId":"screener.run","parameters":[{"description":"Skip our cache and fetch from sources. Items fetched fresh cost double","explode":false,"in":"query","name":"fresh","schema":{"description":"Skip our cache and fetch from sources. Items fetched fresh cost double","type":"boolean"}},{"description":"Response format","explode":false,"in":"query","name":"format","schema":{"default":"json","description":"Response format","enum":["json","csv"],"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScreenerQuery"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScreenerMatchList"}},"text/csv":{"schema":{"type":"string"}}},"description":"OK","headers":{"Batch-Errors":{"schema":{"description":"How many inputs failed. Sent with format=csv, whose body only has data rows","type":"string"}},"Content-Type":{"schema":{"description":"application/json, or text/csv with format=csv","type":"string"}},"Credits-Remaining":{"schema":{"description":"Credits left under the tightest limit on this key or organisation","type":"string"}}}},"400":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"description":"Bad Request"},"401":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"description":"Unauthorized"},"402":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"description":"Payment Required"},"403":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"description":"Forbidden"},"422":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"description":"Unprocessable Entity"},"429":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"description":"Too Many Requests"},"500":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"description":"Internal Server Error"},"503":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"description":"Service Unavailable"}},"security":[{"bearer":[]}],"summary":"Screen instruments","tags":["Screener"],"x-credits":{"freshMultiplier":2,"per":"call","weight":10}}},"/v1/search":{"get":{"description":"Instruments whose name, ticker, ISIN or contract address matches q, ordered by symbol. Each page costs the same.","operationId":"reference.search","parameters":[{"description":"A name, ticker, ISIN or contract address","explode":false,"in":"query","name":"q","required":true,"schema":{"description":"A name, ticker, ISIN or contract address","examples":["bhp"],"maxLength":100,"minLength":1,"type":"string"}},{"description":"Only instruments of this type","explode":false,"in":"query","name":"type","schema":{"description":"Only instruments of this type","enum":["equity","etf","fund","index","fx","crypto","token","rate","future","commodity","bond"],"type":"string"}},{"description":"Only instruments listed here, as a MIC or an alias like ASX","explode":false,"in":"query","name":"exchange","schema":{"description":"Only instruments listed here, as a MIC or an alias like ASX","maxLength":16,"type":"string"}},{"description":"Only instruments from this ISO country","explode":false,"in":"query","name":"country","schema":{"description":"Only instruments from this ISO country","pattern":"^[A-Z]{2}$","type":"string"}},{"description":"From meta.nextCursor of the previous page","explode":false,"in":"query","name":"cursor","schema":{"description":"From meta.nextCursor of the previous page","maxLength":512,"type":"string"}},{"description":"Page size","explode":false,"in":"query","name":"limit","schema":{"default":100,"description":"Page size","format":"int64","maximum":1000,"minimum":1,"type":"integer"}},{"description":"Skip our cache and fetch from sources. Items fetched fresh cost double","explode":false,"in":"query","name":"fresh","schema":{"description":"Skip our cache and fetch from sources. Items fetched fresh cost double","type":"boolean"}},{"description":"Response format","explode":false,"in":"query","name":"format","schema":{"default":"json","description":"Response format","enum":["json","csv"],"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InstrumentList"}},"text/csv":{"schema":{"type":"string"}}},"description":"OK","headers":{"Batch-Errors":{"schema":{"description":"How many inputs failed. Sent with format=csv, whose body only has data rows","type":"string"}},"Content-Type":{"schema":{"description":"application/json, or text/csv with format=csv","type":"string"}},"Credits-Remaining":{"schema":{"description":"Credits left under the tightest limit on this key or organisation","type":"string"}}}},"400":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"description":"Bad Request"},"401":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"description":"Unauthorized"},"402":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"description":"Payment Required"},"403":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"description":"Forbidden"},"422":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"description":"Unprocessable Entity"},"429":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"description":"Too Many Requests"},"500":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"description":"Internal Server Error"},"503":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"description":"Service Unavailable"}},"security":[{"bearer":[]}],"summary":"Find instruments","tags":["Reference"],"x-credits":{"freshMultiplier":2,"per":"call","weight":1}}},"/v1/sectors":{"get":{"description":"Our sectors and the industries in each. Profiles, listings and the screener use these ids.","operationId":"reference.sectors","parameters":[{"description":"Skip our cache and fetch from sources. Items fetched fresh cost double","explode":false,"in":"query","name":"fresh","schema":{"description":"Skip our cache and fetch from sources. Items fetched fresh cost double","type":"boolean"}},{"description":"Response format","explode":false,"in":"query","name":"format","schema":{"default":"json","description":"Response format","enum":["json","csv"],"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SectorList"}},"text/csv":{"schema":{"type":"string"}}},"description":"OK","headers":{"Batch-Errors":{"schema":{"description":"How many inputs failed. Sent with format=csv, whose body only has data rows","type":"string"}},"Content-Type":{"schema":{"description":"application/json, or text/csv with format=csv","type":"string"}},"Credits-Remaining":{"schema":{"description":"Credits left under the tightest limit on this key or organisation","type":"string"}}}},"400":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"description":"Bad Request"},"401":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"description":"Unauthorized"},"402":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"description":"Payment Required"},"403":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"description":"Forbidden"},"422":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"description":"Unprocessable Entity"},"429":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"description":"Too Many Requests"},"500":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"description":"Internal Server Error"},"503":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"description":"Service Unavailable"}},"security":[{"bearer":[]}],"summary":"Sector and industry taxonomy","tags":["Reference"],"x-credits":{"per":"call","weight":0}}},"/v1/short-interest":{"get":{"description":"The aggregate short position as the regulator publishes it: daily for ASIC, each settlement date for FINRA. Regulators that only publish a percentage leave shares null. Defaults to the last week.","operationId":"company.shortInterest","parameters":[{"description":"Comma separated identifiers, up to 100, like ASX:VAS, isin:AU000000VAS1 or ins_...","explode":false,"in":"query","name":"symbols","required":true,"schema":{"description":"Comma separated identifiers, up to 100, like ASX:VAS, isin:AU000000VAS1 or ins_...","examples":[["NASDAQ:AAPL","ASX:BHP"]],"items":{"type":"string"},"maxItems":100,"minItems":1,"type":"array"}},{"description":"First day, YYYY-MM-DD","explode":false,"in":"query","name":"from","schema":{"description":"First day, YYYY-MM-DD","examples":["2026-06-01"],"format":"date","type":"string"}},{"description":"Last day, YYYY-MM-DD","explode":false,"in":"query","name":"to","schema":{"description":"Last day, YYYY-MM-DD","examples":["2026-06-30"],"format":"date","type":"string"}},{"description":"Skip our cache and fetch from sources. Items fetched fresh cost double","explode":false,"in":"query","name":"fresh","schema":{"description":"Skip our cache and fetch from sources. Items fetched fresh cost double","type":"boolean"}},{"description":"Response format","explode":false,"in":"query","name":"format","schema":{"default":"json","description":"Response format","enum":["json","csv"],"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ShortInterestBatch"}},"text/csv":{"schema":{"type":"string"}}},"description":"OK","headers":{"Batch-Errors":{"schema":{"description":"How many inputs failed. Sent with format=csv, whose body only has data rows","type":"string"}},"Content-Type":{"schema":{"description":"application/json, or text/csv with format=csv","type":"string"}},"Credits-Remaining":{"schema":{"description":"Credits left under the tightest limit on this key or organisation","type":"string"}}}},"400":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"description":"Bad Request"},"401":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"description":"Unauthorized"},"402":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"description":"Payment Required"},"403":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"description":"Forbidden"},"422":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"description":"Unprocessable Entity"},"429":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"description":"Too Many Requests"},"500":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"description":"Internal Server Error"},"503":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"description":"Service Unavailable"}},"security":[{"bearer":[]}],"summary":"Short interest","tags":["Company data"],"x-credits":{"freshMultiplier":2,"per":"instrument","weight":1}}},"/v1/tax/au/components":{"get":{"description":"AMIT attribution components of every distribution in an Australian financial year, per unit. basis is estimate until the issuer publishes its final annual (AMMA) figures. Components the issuer didn't report are null.","operationId":"tax.auComponents","parameters":[{"description":"Comma separated identifiers, up to 100, like ASX:VAS, isin:AU000000VAS1 or ins_...","explode":false,"in":"query","name":"symbols","required":true,"schema":{"description":"Comma separated identifiers, up to 100, like ASX:VAS, isin:AU000000VAS1 or ins_...","examples":[["ASX:VAS","ASX:A200"]],"items":{"type":"string"},"maxItems":100,"minItems":1,"type":"array"}},{"description":"Skip our cache and fetch from sources. Items fetched fresh cost double","explode":false,"in":"query","name":"fresh","schema":{"description":"Skip our cache and fetch from sources. Items fetched fresh cost double","type":"boolean"}},{"description":"Response format","explode":false,"in":"query","name":"format","schema":{"default":"json","description":"Response format","enum":["json","csv"],"type":"string"}},{"description":"Named by the year it ends in, so 2026 runs 1 July 2025 to 30 June 2026. Defaults to the current one","explode":false,"in":"query","name":"financialYear","schema":{"description":"Named by the year it ends in, so 2026 runs 1 July 2025 to 30 June 2026. Defaults to the current one","examples":[2026],"format":"int64","maximum":2100,"minimum":2000,"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TaxDistributionsBatch"}},"text/csv":{"schema":{"type":"string"}}},"description":"OK","headers":{"Batch-Errors":{"schema":{"description":"How many inputs failed. Sent with format=csv, whose body only has data rows","type":"string"}},"Content-Type":{"schema":{"description":"application/json, or text/csv with format=csv","type":"string"}},"Credits-Remaining":{"schema":{"description":"Credits left under the tightest limit on this key or organisation","type":"string"}}}},"400":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"description":"Bad Request"},"401":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"description":"Unauthorized"},"402":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"description":"Payment Required"},"403":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"description":"Forbidden"},"422":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"description":"Unprocessable Entity"},"429":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"description":"Too Many Requests"},"500":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"description":"Internal Server Error"},"503":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"description":"Service Unavailable"}},"security":[{"bearer":[]}],"summary":"Australian trust tax components","tags":["Income and corporate actions"],"x-credits":{"freshMultiplier":2,"per":"instrument","weight":5}}},"/v1/tax/fx":{"get":{"description":"Rates a tax authority publishes for converting foreign amounts, as distinct from market FX, which lives in prices.daily under FX: symbols. Each rate is dated on the last day of its period. Pairs go in the direction the authority publishes, like AUDUSD for the RBA and USDCAD for the BoC.","operationId":"tax.fx","parameters":[{"explode":false,"in":"query","name":"authority","required":true,"schema":{"enum":["RBA","ATO","ECB","HMRC","IRS","BOC"],"type":"string"}},{"description":"Comma separated currency pairs, up to 100","explode":false,"in":"query","name":"pairs","required":true,"schema":{"description":"Comma separated currency pairs, up to 100","examples":[["AUDUSD","AUDEUR"]],"items":{"type":"string"},"maxItems":100,"minItems":1,"type":"array"}},{"description":"What each rate stands for. year_end is the rate on the last day of the tax year","explode":false,"in":"query","name":"period","schema":{"default":"daily","description":"What each rate stands for. year_end is the rate on the last day of the tax year","enum":["daily","monthly","yearly","year_end"],"type":"string"}},{"description":"First day, YYYY-MM-DD","explode":false,"in":"query","name":"from","schema":{"description":"First day, YYYY-MM-DD","examples":["2026-06-01"],"format":"date","type":"string"}},{"description":"Last day, YYYY-MM-DD","explode":false,"in":"query","name":"to","schema":{"description":"Last day, YYYY-MM-DD","examples":["2026-06-30"],"format":"date","type":"string"}},{"description":"Skip our cache and fetch from sources. Items fetched fresh cost double","explode":false,"in":"query","name":"fresh","schema":{"description":"Skip our cache and fetch from sources. Items fetched fresh cost double","type":"boolean"}},{"description":"Response format","explode":false,"in":"query","name":"format","schema":{"default":"json","description":"Response format","enum":["json","csv"],"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TaxFXSeriesBatch"}},"text/csv":{"schema":{"type":"string"}}},"description":"OK","headers":{"Batch-Errors":{"schema":{"description":"How many inputs failed. Sent with format=csv, whose body only has data rows","type":"string"}},"Content-Type":{"schema":{"description":"application/json, or text/csv with format=csv","type":"string"}},"Credits-Remaining":{"schema":{"description":"Credits left under the tightest limit on this key or organisation","type":"string"}}}},"400":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"description":"Bad Request"},"401":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"description":"Unauthorized"},"402":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"description":"Payment Required"},"403":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"description":"Forbidden"},"422":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"description":"Unprocessable Entity"},"429":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"description":"Too Many Requests"},"500":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"description":"Internal Server Error"},"503":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"description":"Service Unavailable"}},"security":[{"bearer":[]}],"summary":"Official FX rates for tax","tags":["Income and corporate actions"],"x-credits":{"freshMultiplier":2,"per":"pair","weight":1}}},"/v1/technicals/{indicator}":{"get":{"description":"An indicator per trading day, computed from our own daily bars. period defaults to 20 for sma and ema and 14 for rsi. macd always uses 12, 26 and 9, so it takes no period.","operationId":"prices.technicals","parameters":[{"in":"path","name":"indicator","required":true,"schema":{"enum":["sma","ema","rsi","macd"],"type":"string"}},{"description":"Comma separated identifiers, up to 100, like ASX:VAS, isin:AU000000VAS1 or ins_...","explode":false,"in":"query","name":"symbols","required":true,"schema":{"description":"Comma separated identifiers, up to 100, like ASX:VAS, isin:AU000000VAS1 or ins_...","examples":[["NASDAQ:AAPL","ASX:BHP"]],"items":{"type":"string"},"maxItems":100,"minItems":1,"type":"array"}},{"description":"First day, YYYY-MM-DD","explode":false,"in":"query","name":"from","schema":{"description":"First day, YYYY-MM-DD","examples":["2026-06-01"],"format":"date","type":"string"}},{"description":"Last day, YYYY-MM-DD","explode":false,"in":"query","name":"to","schema":{"description":"Last day, YYYY-MM-DD","examples":["2026-06-30"],"format":"date","type":"string"}},{"description":"Convert every price into this ISO currency","explode":false,"in":"query","name":"currency","schema":{"description":"Convert every price into this ISO currency","examples":["USD"],"pattern":"^[A-Z]{3}$","type":"string"}},{"description":"Skip our cache and fetch from sources. Items fetched fresh cost double","explode":false,"in":"query","name":"fresh","schema":{"description":"Skip our cache and fetch from sources. Items fetched fresh cost double","type":"boolean"}},{"description":"Response format","explode":false,"in":"query","name":"format","schema":{"default":"json","description":"Response format","enum":["json","csv"],"type":"string"}},{"description":"Lookback in trading days","explode":false,"in":"query","name":"period","schema":{"description":"Lookback in trading days","examples":[20],"format":"int64","maximum":200,"minimum":2,"type":"integer"}},{"description":"Which bars to compute from, like prices.daily","explode":false,"in":"query","name":"adjust","schema":{"default":"splits","description":"Which bars to compute from, like prices.daily","enum":["none","splits","total"],"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TechnicalSeriesBatch"}},"text/csv":{"schema":{"type":"string"}}},"description":"OK","headers":{"Batch-Errors":{"schema":{"description":"How many inputs failed. Sent with format=csv, whose body only has data rows","type":"string"}},"Content-Type":{"schema":{"description":"application/json, or text/csv with format=csv","type":"string"}},"Credits-Remaining":{"schema":{"description":"Credits left under the tightest limit on this key or organisation","type":"string"}}}},"400":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"description":"Bad Request"},"401":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"description":"Unauthorized"},"402":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"description":"Payment Required"},"403":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"description":"Forbidden"},"422":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"description":"Unprocessable Entity"},"429":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"description":"Too Many Requests"},"500":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"description":"Internal Server Error"},"503":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"description":"Service Unavailable"}},"security":[{"bearer":[]}],"summary":"Technical indicators","tags":["Prices"],"x-credits":{"freshMultiplier":2,"per":"instrument","weight":1}}},"/v1/tokens":{"get":{"description":"Chain, contract, decimals, supply, logo and the verified flag of tokens addressed by contract, like SOLANA:9BB6...pump.","operationId":"crypto.tokens","parameters":[{"description":"Comma separated identifiers, up to 100, like ASX:VAS, isin:AU000000VAS1 or ins_...","explode":false,"in":"query","name":"symbols","required":true,"schema":{"description":"Comma separated identifiers, up to 100, like ASX:VAS, isin:AU000000VAS1 or ins_...","examples":[["SOLANA:EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v","ETHEREUM:0xa0b86991c6218b36c1d19d4a2e9eb0ce3606eb48"]],"items":{"type":"string"},"maxItems":100,"minItems":1,"type":"array"}},{"description":"Skip our cache and fetch from sources. Items fetched fresh cost double","explode":false,"in":"query","name":"fresh","schema":{"description":"Skip our cache and fetch from sources. Items fetched fresh cost double","type":"boolean"}},{"description":"Response format","explode":false,"in":"query","name":"format","schema":{"default":"json","description":"Response format","enum":["json","csv"],"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TokenBatch"}},"text/csv":{"schema":{"type":"string"}}},"description":"OK","headers":{"Batch-Errors":{"schema":{"description":"How many inputs failed. Sent with format=csv, whose body only has data rows","type":"string"}},"Content-Type":{"schema":{"description":"application/json, or text/csv with format=csv","type":"string"}},"Credits-Remaining":{"schema":{"description":"Credits left under the tightest limit on this key or organisation","type":"string"}}}},"400":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"description":"Bad Request"},"401":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"description":"Unauthorized"},"402":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"description":"Payment Required"},"403":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"description":"Forbidden"},"422":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"description":"Unprocessable Entity"},"429":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"description":"Too Many Requests"},"500":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"description":"Internal Server Error"},"503":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"description":"Service Unavailable"}},"security":[{"bearer":[]}],"summary":"Token metadata","tags":["Crypto and on-chain"],"x-credits":{"freshMultiplier":2,"per":"instrument","weight":1}}},"/v1/tokens/risk":{"get":{"description":"Spam and scam flags on tokens, each with the reason behind it, and a score from 0 for no known risk to 100 for a certain scam. Flag codes never change meaning, so they're safe to filter on.","operationId":"crypto.risk","parameters":[{"description":"Comma separated identifiers, up to 100, like ASX:VAS, isin:AU000000VAS1 or ins_...","explode":false,"in":"query","name":"symbols","required":true,"schema":{"description":"Comma separated identifiers, up to 100, like ASX:VAS, isin:AU000000VAS1 or ins_...","examples":[["SOLANA:EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v","ETHEREUM:0xa0b86991c6218b36c1d19d4a2e9eb0ce3606eb48"]],"items":{"type":"string"},"maxItems":100,"minItems":1,"type":"array"}},{"description":"Skip our cache and fetch from sources. Items fetched fresh cost double","explode":false,"in":"query","name":"fresh","schema":{"description":"Skip our cache and fetch from sources. Items fetched fresh cost double","type":"boolean"}},{"description":"Response format","explode":false,"in":"query","name":"format","schema":{"default":"json","description":"Response format","enum":["json","csv"],"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TokenRiskBatch"}},"text/csv":{"schema":{"type":"string"}}},"description":"OK","headers":{"Batch-Errors":{"schema":{"description":"How many inputs failed. Sent with format=csv, whose body only has data rows","type":"string"}},"Content-Type":{"schema":{"description":"application/json, or text/csv with format=csv","type":"string"}},"Credits-Remaining":{"schema":{"description":"Credits left under the tightest limit on this key or organisation","type":"string"}}}},"400":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"description":"Bad Request"},"401":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"description":"Unauthorized"},"402":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"description":"Payment Required"},"403":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"description":"Forbidden"},"422":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"description":"Unprocessable Entity"},"429":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"description":"Too Many Requests"},"500":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"description":"Internal Server Error"},"503":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"description":"Service Unavailable"}},"security":[{"bearer":[]}],"summary":"Token risk flags","tags":["Crypto and on-chain"],"x-credits":{"freshMultiplier":2,"per":"instrument","weight":5}}},"/v1/usage":{"get":{"description":"Usage of the calling key's organisation over a UTC window, by key and endpoint. Defaults to the current billing period. Figures can trail live traffic by a few seconds.","operationId":"account.usage","parameters":[{"description":"Start of the window, rounded down to the hour","explode":false,"in":"query","name":"from","schema":{"description":"Start of the window, rounded down to the hour","examples":["2026-09-01T00:00:00Z"],"format":"date-time","type":"string"}},{"description":"End of the window, rounded up to the hour","explode":false,"in":"query","name":"to","schema":{"description":"End of the window, rounded up to the hour","examples":["2026-09-01T01:00:00Z"],"format":"date-time","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UsageResponse"}}},"description":"OK","headers":{"Batch-Errors":{"schema":{"description":"How many inputs failed. Sent with format=csv, whose body only has data rows","type":"string"}},"Content-Type":{"schema":{"description":"application/json, or text/csv with format=csv","type":"string"}},"Credits-Remaining":{"schema":{"description":"Credits left under the tightest limit on this key or organisation","type":"string"}}}},"400":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"description":"Bad Request"},"401":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"description":"Unauthorized"},"402":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"description":"Payment Required"},"403":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"description":"Forbidden"},"422":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"description":"Unprocessable Entity"},"429":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"description":"Too Many Requests"},"500":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"description":"Internal Server Error"},"503":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"description":"Service Unavailable"}},"security":[{"bearer":[]}],"summary":"Credits used and remaining","tags":["Account"],"x-credits":{"per":"call","weight":0}}},"/v1/wallets/balances":{"get":{"description":"Every asset held by each address or xpub on one chain, valued in currency. Amounts are raw on-chain integers as decimal strings next to their decimals. An xpub comes back as the sha256 of it and is never stored, and extended private keys are refused.","operationId":"wallets.balances","parameters":[{"description":"A chain id or alias from /v1/chains","explode":false,"in":"query","name":"chain","required":true,"schema":{"description":"A chain id or alias from /v1/chains","examples":["bitcoin"],"maxLength":32,"type":"string"}},{"description":"Comma separated addresses or xpubs, up to 100. Never send a private key or seed phrase","explode":false,"in":"query","name":"address","required":true,"schema":{"description":"Comma separated addresses or xpubs, up to 100. Never send a private key or seed phrase","examples":[["bc1qm34lsc65zpw79lxes69zkqmk6ee3ewf0j77s3h"]],"items":{"type":"string"},"maxItems":100,"minItems":1,"type":"array"}},{"description":"Convert every price into this ISO currency","explode":false,"in":"query","name":"currency","schema":{"description":"Convert every price into this ISO currency","examples":["USD"],"pattern":"^[A-Z]{3}$","type":"string"}},{"description":"Skip our cache and fetch from sources. Items fetched fresh cost double","explode":false,"in":"query","name":"fresh","schema":{"description":"Skip our cache and fetch from sources. Items fetched fresh cost double","type":"boolean"}},{"description":"Response format","explode":false,"in":"query","name":"format","schema":{"default":"json","description":"Response format","enum":["json","csv"],"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WalletBatch"}},"text/csv":{"schema":{"type":"string"}}},"description":"OK","headers":{"Batch-Errors":{"schema":{"description":"How many inputs failed. Sent with format=csv, whose body only has data rows","type":"string"}},"Content-Type":{"schema":{"description":"application/json, or text/csv with format=csv","type":"string"}},"Credits-Remaining":{"schema":{"description":"Credits left under the tightest limit on this key or organisation","type":"string"}}}},"400":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"description":"Bad Request"},"401":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"description":"Unauthorized"},"402":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"description":"Payment Required"},"403":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"description":"Forbidden"},"422":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"description":"Unprocessable Entity"},"429":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"description":"Too Many Requests"},"500":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"description":"Internal Server Error"},"503":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"description":"Service Unavailable"}},"security":[{"bearer":[]}],"summary":"Wallet balances","tags":["Crypto and on-chain"],"x-credits":{"freshMultiplier":2,"per":"address","weight":5}}},"/v1/wallets/transactions":{"get":{"description":"An address's or xpub's confirmed transactions, newest first, each with every transfer in it: native, token, internal and NFT transfers, or UTXO inputs and outputs. Amounts are raw on-chain integers as decimal strings. Fees are in the chain's native coin, whose decimals /v1/chains lists.","operationId":"wallets.transactions","parameters":[{"description":"A chain id or alias from /v1/chains","explode":false,"in":"query","name":"chain","required":true,"schema":{"description":"A chain id or alias from /v1/chains","examples":["bitcoin"],"maxLength":32,"type":"string"}},{"description":"One address or xpub. Never send a private key or seed phrase","explode":false,"in":"query","name":"address","required":true,"schema":{"description":"One address or xpub. Never send a private key or seed phrase","examples":["bc1qm34lsc65zpw79lxes69zkqmk6ee3ewf0j77s3h"],"maxLength":256,"type":"string"}},{"description":"From meta.nextCursor of the previous page","explode":false,"in":"query","name":"cursor","schema":{"description":"From meta.nextCursor of the previous page","maxLength":512,"type":"string"}},{"description":"Page size","explode":false,"in":"query","name":"limit","schema":{"default":100,"description":"Page size","examples":[5],"format":"int64","maximum":1000,"minimum":1,"type":"integer"}},{"description":"Skip our cache and fetch from sources. Items fetched fresh cost double","explode":false,"in":"query","name":"fresh","schema":{"description":"Skip our cache and fetch from sources. Items fetched fresh cost double","type":"boolean"}},{"description":"Response format","explode":false,"in":"query","name":"format","schema":{"default":"json","description":"Response format","enum":["json","csv"],"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TransactionList"}},"text/csv":{"schema":{"type":"string"}}},"description":"OK","headers":{"Batch-Errors":{"schema":{"description":"How many inputs failed. Sent with format=csv, whose body only has data rows","type":"string"}},"Content-Type":{"schema":{"description":"application/json, or text/csv with format=csv","type":"string"}},"Credits-Remaining":{"schema":{"description":"Credits left under the tightest limit on this key or organisation","type":"string"}}}},"400":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"description":"Bad Request"},"401":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"description":"Unauthorized"},"402":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"description":"Payment Required"},"403":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"description":"Forbidden"},"404":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"description":"Not Found"},"422":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"description":"Unprocessable Entity"},"429":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"description":"Too Many Requests"},"500":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"description":"Internal Server Error"},"502":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"description":"Bad Gateway"},"503":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"description":"Service Unavailable"}},"security":[{"bearer":[]}],"summary":"Wallet transactions","tags":["Crypto and on-chain"],"x-credits":{"freshMultiplier":2,"per":"page","weight":5}}},"/v1/yields":{"get":{"description":"Staking, lending and liquidity pools with their size and yield, largest first. APYs are percentages, 3.2 for 3.2%.","operationId":"yields.pools","parameters":[{"description":"A chain id or alias from /v1/chains","explode":false,"in":"query","name":"chain","schema":{"description":"A chain id or alias from /v1/chains","examples":["ethereum"],"maxLength":32,"type":"string"}},{"description":"A protocol slug","explode":false,"in":"query","name":"protocol","schema":{"description":"A protocol slug","examples":["lido"],"maxLength":64,"type":"string"}},{"description":"A token in the pool's symbol like ETH, or an underlying token contract","explode":false,"in":"query","name":"asset","schema":{"description":"A token in the pool's symbol like ETH, or an underlying token contract","maxLength":128,"type":"string"}},{"description":"From meta.nextCursor of the previous page","explode":false,"in":"query","name":"cursor","schema":{"description":"From meta.nextCursor of the previous page","maxLength":512,"type":"string"}},{"description":"Page size","explode":false,"in":"query","name":"limit","schema":{"default":100,"description":"Page size","format":"int64","maximum":1000,"minimum":1,"type":"integer"}},{"description":"Skip our cache and fetch from sources. Items fetched fresh cost double","explode":false,"in":"query","name":"fresh","schema":{"description":"Skip our cache and fetch from sources. Items fetched fresh cost double","type":"boolean"}},{"description":"Response format","explode":false,"in":"query","name":"format","schema":{"default":"json","description":"Response format","enum":["json","csv"],"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PoolList"}},"text/csv":{"schema":{"type":"string"}}},"description":"OK","headers":{"Batch-Errors":{"schema":{"description":"How many inputs failed. Sent with format=csv, whose body only has data rows","type":"string"}},"Content-Type":{"schema":{"description":"application/json, or text/csv with format=csv","type":"string"}},"Credits-Remaining":{"schema":{"description":"Credits left under the tightest limit on this key or organisation","type":"string"}}}},"400":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"description":"Bad Request"},"401":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"description":"Unauthorized"},"402":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"description":"Payment Required"},"403":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"description":"Forbidden"},"422":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"description":"Unprocessable Entity"},"429":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"description":"Too Many Requests"},"500":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"description":"Internal Server Error"},"503":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"description":"Service Unavailable"}},"security":[{"bearer":[]}],"summary":"Yield pools","tags":["Crypto and on-chain"],"x-credits":{"freshMultiplier":2,"per":"page","weight":1}}},"/v1/yields/history":{"get":{"description":"Each pool's daily size and yield, as of the end of each UTC day. History length doesn't change the price.","operationId":"yields.history","parameters":[{"description":"Comma separated pool ids from /v1/yields, up to 100","explode":false,"in":"query","name":"pool","required":true,"schema":{"description":"Comma separated pool ids from /v1/yields, up to 100","examples":[["ethereum:lido:STETH-1ab36d714f01","ethereum:sky-lending:SUSDS-6a104e20296d"]],"items":{"type":"string"},"maxItems":100,"minItems":1,"type":"array"}},{"description":"First day, YYYY-MM-DD","explode":false,"in":"query","name":"from","schema":{"description":"First day, YYYY-MM-DD","examples":["2026-06-01"],"format":"date","type":"string"}},{"description":"Last day, YYYY-MM-DD","explode":false,"in":"query","name":"to","schema":{"description":"Last day, YYYY-MM-DD","examples":["2026-06-30"],"format":"date","type":"string"}},{"description":"Skip our cache and fetch from sources. Items fetched fresh cost double","explode":false,"in":"query","name":"fresh","schema":{"description":"Skip our cache and fetch from sources. Items fetched fresh cost double","type":"boolean"}},{"description":"Response format","explode":false,"in":"query","name":"format","schema":{"default":"json","description":"Response format","enum":["json","csv"],"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PoolHistoryBatch"}},"text/csv":{"schema":{"type":"string"}}},"description":"OK","headers":{"Batch-Errors":{"schema":{"description":"How many inputs failed. Sent with format=csv, whose body only has data rows","type":"string"}},"Content-Type":{"schema":{"description":"application/json, or text/csv with format=csv","type":"string"}},"Credits-Remaining":{"schema":{"description":"Credits left under the tightest limit on this key or organisation","type":"string"}}}},"400":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"description":"Bad Request"},"401":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"description":"Unauthorized"},"402":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"description":"Payment Required"},"403":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"description":"Forbidden"},"422":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"description":"Unprocessable Entity"},"429":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"description":"Too Many Requests"},"500":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"description":"Internal Server Error"},"503":{"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Problem"}}},"description":"Service Unavailable"}},"security":[{"bearer":[]}],"summary":"Pool yield history","tags":["Crypto and on-chain"],"x-credits":{"freshMultiplier":2,"per":"pool","weight":1}}}},"servers":[{"url":"https://api.quova.io"}]}