{"openapi":"3.1.0","info":{"title":"Gloom Datasets API","version":"2026-10-21","description":"Gloom Datasets API. Authenticate with a `gds_` key. Prices and limits: https://gloom.sh/datasets/pricing. Changes: https://gloom.sh/datasets/docs/changelog.\n\nEvery response is `{data, meta}` and every error `{error: {type, code, message, param, requestId, docUrl}}`. Dataset routes sit directly under /v1; the catalog, account and reference routes under /v1/datasets. Gloom Datasets keys and Gloom Pro keys are different keys for different APIs: each is refused by the other's routes.","termsOfService":"https://gloom.sh/datasets/terms","contact":{"name":"Gloom Datasets","url":"https://gloom.sh/datasets/docs","email":"hello@gloom.sh"}},"externalDocs":{"description":"Documentation","url":"https://gloom.sh/datasets/docs"},"servers":[{"url":"https://api.gloom.sh"}],"security":[{"bearer":[]},{"apiKey":[]}],"x-plans":{"none":{"credits":0,"perMinute":0,"maxKeys":0,"monthlyPriceUsd":null,"yearlyPriceUsd":null},"basic":{"credits":150000,"perMinute":300,"maxKeys":5,"monthlyPriceUsd":200,"yearlyPriceUsd":2000},"desk":{"credits":1000000,"perMinute":1200,"maxKeys":20,"monthlyPriceUsd":800,"yearlyPriceUsd":8000},"enterprise":{"credits":null,"perMinute":null,"maxKeys":null,"monthlyPriceUsd":null,"yearlyPriceUsd":null}},"x-enterprise-default-limits":{"perMinute":6000,"maxKeys":100},"x-credit-call-types":{"lookup":1,"history":2,"search":2,"evidence":5,"bulk":25,"change":1},"x-bulk-plans":["basic","desk","enterprise"],"tags":[{"name":"Reference","description":"Public reference and estimates; no key required."},{"name":"Account","description":"Authenticated product account."},{"name":"gpu","description":"GPU rental prices"},{"name":"hiring-jobs","description":"Hiring postings"},{"name":"hiring-momentum","description":"Hiring momentum"},{"name":"app-attention","description":"App attention"},{"name":"awards","description":"Government awards"},{"name":"kpis-guidance","description":"KPIs and guidance"},{"name":"credit-documents","description":"Credit documents and covenants"},{"name":"power","description":"Power and grid"},{"name":"perps","description":"Perpetuals"},{"name":"catalysts","description":"Catalysts and litigation"},{"name":"research-attention","description":"Research attention"},{"name":"supply-chain","description":"Supply chain"},{"name":"exposure","description":"Exposure engine"},{"name":"transcripts","description":"Earnings-call transcripts"},{"name":"exec-pay","description":"Executive pay"},{"name":"risk-factors","description":"Risk factors"},{"name":"events","description":"8-K events"},{"name":"document-search","description":"Document search"},{"name":"news","description":"News"},{"name":"social-mentions","description":"Social mentions"},{"name":"cpi","description":"US consumer prices"},{"name":"energy-inventories","description":"EIA energy inventories"},{"name":"cot","description":"CFTC positioning"},{"name":"short-volume","description":"FINRA short volume"},{"name":"short-interest","description":"FINRA short interest"},{"name":"sec","description":"SEC filings, insiders and 13F holders"},{"name":"congress","description":"Congress trades"},{"name":"macro","description":"Yield curves and macro series"},{"name":"central-bank-rates","description":"Central bank rates"},{"name":"cds","description":"Credit default swaps"},{"name":"debt-maturities","description":"Debt maturities"},{"name":"revenue-breakdown","description":"Revenue breakdown"},{"name":"market-data","description":"Market prices and company fundamentals"},{"name":"futures","description":"Futures curves, archives and generics"},{"name":"rate-path","description":"Rate path"},{"name":"options","description":"Options flow, chains and implied volatility"},{"name":"earnings","description":"Earnings calendar and moves"},{"name":"ipo","description":"IPO calendar"},{"name":"mna","description":"Mergers and acquisitions"},{"name":"equity-screener","description":"Equity screener"},{"name":"crypto","description":"Digital asset markets"},{"name":"session-tape","description":"Session movers, highs/lows and tape"},{"name":"analyst-estimates","description":"Analyst estimates and revisions"}],"paths":{"/v1/datasets":{"get":{"operationId":"datasets.list","tags":["Reference"],"summary":"Available datasets, starting credit cost and plans","description":"meta.plans holds each plan's credits, limits and price in US dollars; meta.pricingUrl the pricing page.","security":[],"parameters":[{"$ref":"#/components/parameters/GloomVersion"},{"$ref":"#/components/parameters/IfNoneMatch"}],"responses":{"200":{"description":"Public catalog.","content":{"application/json":{"schema":{"type":"object","required":["data","meta"],"properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Dataset"}},"meta":{"$ref":"#/components/schemas/Meta"}}}}},"headers":{"Request-Id":{"$ref":"#/components/headers/RequestId"},"Gloom-Version":{"$ref":"#/components/headers/GloomVersion"},"ETag":{"$ref":"#/components/headers/ETag"}}},"304":{"$ref":"#/components/responses/NotModified"}}}},"/v1/datasets/cost":{"get":{"operationId":"credits.estimate","tags":["Reference"],"summary":"Estimate a described call without spending credits","description":"Validates the described endpoint parameters. A quote does not authenticate or grant dataset access.","security":[],"parameters":[{"name":"endpoint","in":"query","required":true,"description":"Catalog endpoint ID. Supply that call's path and query parameters in this query.","schema":{"type":"string","enum":["gpu.prices","gpu.history","gpu.changes","cpi.board","energy.inventories","cot.board","cot.contract","awards.list","awards.detail","kpis.company","guidance.company","credit.screen","credit.documents","credit.instrument","exec-pay.list","exec-pay.year","risk-factors.list","risk-factors.year","events.list","revenue-breakdown.get","debt-maturities.get","catalysts.list","catalysts.litigation","catalysts.event","catalysts.changes","sec.filings","sec.documents","sec.content","sec.insiders","sec.holders","jobs.list","jobs.company","jobs.postings","hiring.board","hiring.company","jobs.coverage","hiring.coverage","apps.board","apps.app","apps.company","apps.coverage","power.board","power.history","power.project","power.coverage","perps.board","perps.history","perps.rankings","perps.compare","perps.market","perps.equity","attention.board","attention.company","supply-chain.graph","supply-chain.paths","supply-chain.counterparties","exposure.scenarios","exposure.analyze","transcripts.list","transcripts.detail","document-search.search","document-search.document","news.list","news.sources","news.facets","news.detail","social.history","social.posts","short-volume.history","short-interest.history","sec.insider-signals","sec.crowding","congress.trades","congress.member","congress.ticker","macro.curves","macro.curve","macro.series","macro.calendar","central-bank-rates.board","cds.trades","cds.history","cds.indexes","cds.sovereigns","fundamentals.statements","fundamentals.statistics","fundamentals.profile","market.quotes","market.data","market.history","market.fields","futures.curve","futures.archive","futures.generic","rate-path.board","options.flow","options.iv","options.surface","options.chain","options.gamma","earnings.calendar","earnings.moves","ipo.calendar","mna.deals","mna.deal","equity-screener.query","crypto.markets","session-tape.movers","session-tape.hilo","session-tape.tape","analyst.estimates","analyst.revisions"]}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":200,"default":200}},{"name":"cursor","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":120,"pattern":"^[A-Za-z0-9_-]+$","description":"Opaque: meta.page.nextCursor of the previous page. Bound to this route and query."}},{"name":"gpuModel","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":1024,"pattern":"\\S"}},{"name":"seriesId","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":1024,"pattern":"\\S"}},{"name":"from","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":35,"pattern":"^\\d{4}-\\d{2}-\\d{2}T(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d{1,6})?(?:Z|[+-](?:[01]\\d|2[0-3]):[0-5]\\d)$","format":"date-time"}},{"name":"to","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":35,"pattern":"^\\d{4}-\\d{2}-\\d{2}T(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d{1,6})?(?:Z|[+-](?:[01]\\d|2[0-3]):[0-5]\\d)$","format":"date-time"}},{"name":"basis","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":1024,"pattern":"\\S","enum":["list","spot","ask","reserved","reference"]}},{"name":"includeFractional","in":"query","required":false,"schema":{"type":"boolean"}},{"name":"report","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":1024,"pattern":"\\S","enum":["legacy","disaggregated"],"default":"legacy"}},{"name":"traderClass","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":1024,"pattern":"\\S","enum":["noncommercial","commercial","nonreportable","producer","swap","managed-money","other-reportable"],"description":"Must belong to the selected report. Legacy: noncommercial (default), commercial, nonreportable. Disaggregated: producer, swap, managed-money (default), other-reportable, nonreportable."}},{"name":"contractCode","in":"query","required":false,"schema":{"type":"string","minLength":6,"maxLength":6,"pattern":"^[0-9A-Za-z]{5}[0-9A-Za-z+]$","description":"Six-character CFTC market code; normalized to uppercase."}},{"name":"ticker","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":32,"pattern":"^[A-Za-z0-9.:-]{1,32}$","description":"Company symbol; normalized to uppercase."}},{"name":"jurisdiction","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":3,"pattern":"^[A-Za-z]{2,3}$"}},{"name":"currency","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":3,"pattern":"^[A-Za-z]{3}$"}},{"name":"agency","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":200,"pattern":"\\S"}},{"name":"sector","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":200,"pattern":"\\S"}},{"name":"source","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":64,"pattern":"^[a-z0-9_-]{1,64}$"}},{"name":"parentId","in":"query","required":false,"schema":{"type":"string","minLength":40,"maxLength":40,"pattern":"^[a-f0-9]{40}$"}},{"name":"awardType","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":1024,"pattern":"\\S","enum":["prime","subaward","modification","notice"]}},{"name":"fiscalYear","in":"query","required":false,"schema":{"type":"integer","minimum":2000,"maximum":2100}},{"name":"query","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":200,"pattern":"\\S"}},{"name":"minAmount","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":31,"pattern":"^\\d{1,24}(?:\\.\\d{1,6})?$","description":"Nonnegative decimal amount, supplied as a string to preserve precision."}},{"name":"id","in":"query","required":false,"schema":{"type":"string","minLength":40,"maxLength":40,"pattern":"^[a-f0-9]{40}$"}},{"name":"revisionsCursor","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":1024,"pattern":"\\S"}},{"name":"symbol","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":32,"pattern":"^[A-Za-z0-9.:-]{1,32}$","description":"Company symbol; normalized to uppercase."}},{"name":"metric","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":80,"pattern":"^[a-z0-9_]{1,80}$"}},{"name":"asOf","in":"query","required":false,"schema":{"type":"string","minLength":10,"maxLength":10,"pattern":"^\\d{4}-\\d{2}-\\d{2}$","format":"date","description":"Valid calendar date (YYYY-MM-DD). from must be on or before to."}},{"name":"headroomBelow","in":"query","required":false,"schema":{"type":"number","minimum":-10000,"maximum":10000}},{"name":"springingWithinMonths","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":120}},{"name":"year","in":"query","required":false,"schema":{"type":"integer","minimum":1900,"maximum":2100}},{"name":"view","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":1024,"pattern":"\\S","enum":["product","segment","region"]}},{"name":"country","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":1024,"pattern":"\\S"}},{"name":"status","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":1024,"pattern":"\\S"}},{"name":"search","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":1024,"pattern":"\\S"}},{"name":"type","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":1024,"pattern":"\\S","enum":["regulatory","clinical","litigation","antitrust","recall","sanctions","export_control","tariff","rulemaking","approval","advisory","advisory-meeting","pdufa"]}},{"name":"dateField","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":1024,"pattern":"\\S","enum":["announced","effective","deadline","any","observed"]}},{"name":"upcoming","in":"query","required":false,"schema":{"type":"boolean"}},{"name":"changed","in":"query","required":false,"schema":{"type":"boolean"}},{"name":"litigation","in":"query","required":false,"schema":{"type":"boolean"}},{"name":"since","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":35,"pattern":"^\\d{4}-\\d{2}-\\d{2}T(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d{1,6})?(?:Z|[+-](?:[01]\\d|2[0-3]):[0-5]\\d)$","format":"date-time"}},{"name":"cik","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":10,"pattern":"^[0-9]{1,10}$"}},{"name":"accession","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":20,"pattern":"^[0-9]{10}-[0-9]{2}-[0-9]{6}$"}},{"name":"form","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":1024,"pattern":"\\S"}},{"name":"primaryDocument","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":1024,"pattern":"\\S"}},{"name":"filingUrl","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":1024,"pattern":"\\S"}},{"name":"primaryDocumentUrl","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":1024,"pattern":"\\S"}},{"name":"quarter","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":6,"pattern":"^20[0-9]{2}Q[1-4]$"}},{"name":"function","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":1024,"pattern":"\\S"}},{"name":"q","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":1024,"pattern":"\\S"}},{"name":"includeClosed","in":"query","required":false,"schema":{"type":"boolean"}},{"name":"category","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":1024,"pattern":"\\S"}},{"name":"days","in":"query","required":false,"schema":{"type":"integer","minimum":7,"maximum":730}},{"name":"chart","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":1024,"pattern":"\\S","enum":["free","paid","grossing","unranked"]}},{"name":"store","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":1024,"pattern":"\\S","enum":["app-store","google-play"]}},{"name":"appId","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":1024,"pattern":"\\S"}},{"name":"region","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":1024,"pattern":"\\S"}},{"name":"fuel","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":1024,"pattern":"\\S"}},{"name":"sourceId","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":1024,"pattern":"\\S"}},{"name":"loadClass","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":1024,"pattern":"\\S"}},{"name":"sort","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":1024,"pattern":"\\S","enum":["capacityMw","name","region","status","proposedDate","generationMwh","salesMwh","revenueUsd","summerPeakDemandMw","winterPeakDemandMw"]}},{"name":"kind","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":1024,"pattern":"\\S","enum":["queue","load","capacity","utility"]}},{"name":"direction","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":1024,"pattern":"\\S","enum":["asc","desc"]}},{"name":"historical","in":"query","required":false,"schema":{"type":"boolean"}},{"name":"assetClass","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":1024,"pattern":"\\S","enum":["stocks","indices","energy","metals","fx","crypto","other"]}},{"name":"includeDelisted","in":"query","required":false,"schema":{"type":"boolean"}},{"name":"marketId","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":1024,"pattern":"\\S"}},{"name":"resolution","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":1024,"pattern":"\\S","enum":["auto","minute","hour","day"]}},{"name":"baseAsset","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":1024,"pattern":"\\S"}},{"name":"exchange","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":1024,"pattern":"\\S"}},{"name":"identity","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":1024,"pattern":"\\S","enum":["listing"]}},{"name":"window","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":1024,"pattern":"\\S","enum":["now","today","week"]}},{"name":"roles","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":1024,"pattern":"\\S"}},{"name":"sources","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":1024,"pattern":"\\S"}},{"name":"tiers","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":1024,"pattern":"\\S"}},{"name":"depth","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":4}},{"name":"minPct","in":"query","required":false,"schema":{"type":"number","minimum":0,"maximum":100}},{"name":"minConfidence","in":"query","required":false,"schema":{"type":"number","minimum":0,"maximum":1}},{"name":"ranking","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":1024,"pattern":"\\S","enum":["score","shortest"]}},{"name":"fromSymbol","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":1024,"pattern":"\\S"}},{"name":"toSymbol","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":1024,"pattern":"\\S"}},{"name":"includeLeads","in":"query","required":false,"schema":{"type":"boolean"}},{"name":"tickers","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":1024,"pattern":"\\S"}},{"name":"docTypes","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":64,"pattern":"^(filing|transcript|news)(,(filing|transcript|news))*$"}},{"name":"count","in":"query","required":false,"schema":{"type":"boolean"}},{"name":"distinct","in":"query","required":false,"schema":{"type":"boolean"}},{"name":"docType","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":1024,"pattern":"\\S","enum":["filing","transcript","news"]}},{"name":"feed","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":1024,"pattern":"\\S","enum":["latest","top","breaking","ticker","sector","topic"]}},{"name":"tickerTier","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":1024,"pattern":"\\S","enum":["primary","related","any"]}},{"name":"tickerRelations","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":1024,"pattern":"\\S"}},{"name":"topics","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":1024,"pattern":"\\S"}},{"name":"categories","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":1024,"pattern":"\\S"}},{"name":"sectors","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":1024,"pattern":"\\S"}},{"name":"excludeSources","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":1024,"pattern":"\\S"}},{"name":"sentiment","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":1024,"pattern":"\\S","enum":["positive","neutral","negative"]}},{"name":"minImportance","in":"query","required":false,"schema":{"type":"integer","minimum":0,"maximum":100}},{"name":"minUrgency","in":"query","required":false,"schema":{"type":"integer","minimum":0,"maximum":100}},{"name":"breaking","in":"query","required":false,"schema":{"type":"boolean"}},{"name":"until","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":30,"pattern":"^\\d{4}-\\d{2}-\\d{2}(?:T[0-9:.]+Z)?$","description":"Calendar date or UTC timestamp."}},{"name":"range","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":1024,"pattern":"\\S","enum":["1y","5y","max"]}},{"name":"day","in":"query","required":false,"schema":{"type":"string","minLength":10,"maxLength":10,"pattern":"^\\d{4}-\\d{2}-\\d{2}$","format":"date","description":"Valid calendar date (YYYY-MM-DD). from must be on or before to."}},{"name":"scope","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":1024,"pattern":"\\S","enum":["nms","otc"]}},{"name":"years","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":10}},{"name":"side","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":1024,"pattern":"\\S","enum":["buy","sell"]}},{"name":"role","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":1024,"pattern":"\\S","enum":["all","officers","directors","owners"]}},{"name":"minValue","in":"query","required":false,"schema":{"type":"integer","minimum":0,"maximum":1000000000000,"description":"US dollars the insiders traded in the window."}},{"name":"cluster","in":"query","required":false,"schema":{"type":"boolean"}},{"name":"position","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":1024,"pattern":"\\S","enum":["new","exited"],"description":"new on the buy side, exited on the sell side."}},{"name":"cap","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":1024,"pattern":"\\S","enum":["micro","small","mid","large"],"description":"Market value: micro under $300M, small to $2B, mid to $10B, large above."}},{"name":"chamber","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":1024,"pattern":"\\S","enum":["all","house","senate"]}},{"name":"filingLimit","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":60}},{"name":"member","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":160,"pattern":"\\S"}},{"name":"owner","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":1024,"pattern":"\\S","enum":["self","spouse","joint","dependent","other"]}},{"name":"assetType","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":1024,"pattern":"\\S","enum":["stock","option","other"]}},{"name":"curve","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":1024,"pattern":"\\S","enum":["us","us-real","us-breakeven","eu-aaa","de","gb","jp","ca"]}},{"name":"date","in":"query","required":false,"schema":{"type":"string","minLength":10,"maxLength":10,"pattern":"^\\d{4}-\\d{2}-\\d{2}$","format":"date","description":"Valid calendar date (YYYY-MM-DD). from must be on or before to."}},{"name":"sortOrder","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":1024,"pattern":"\\S","enum":["asc","desc"]}},{"name":"issuer","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":120,"pattern":"\\S"}},{"name":"period","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":1024,"pattern":"\\S","enum":["annual","quarterly"],"description":"Statement period, annual by default."}},{"name":"fields","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":1024,"pattern":"\\S","description":"Comma-separated field names, at most 25."}},{"name":"start","in":"query","required":false,"schema":{"type":"string","minLength":10,"maxLength":10,"pattern":"^\\d{4}-\\d{2}-\\d{2}$","format":"date","description":"Valid calendar date (YYYY-MM-DD). from must be on or before to."}},{"name":"end","in":"query","required":false,"schema":{"type":"string","minLength":10,"maxLength":10,"pattern":"^\\d{4}-\\d{2}-\\d{2}$","format":"date","description":"Valid calendar date (YYYY-MM-DD). from must be on or before to."}},{"name":"root","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":1024,"pattern":"\\S"}},{"name":"before","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":1024,"pattern":"\\S"}},{"name":"expiry","in":"query","required":false,"schema":{"type":"string","minLength":10,"maxLength":10,"pattern":"^\\d{4}-\\d{2}-\\d{2}$","format":"date","description":"Valid calendar date (YYYY-MM-DD). from must be on or before to."}},{"name":"perDay","in":"query","required":false,"schema":{"type":"number"}},{"name":"symbols","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":1024,"pattern":"\\S"}},{"name":"target","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":1024,"pattern":"\\S"}},{"name":"definition","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":1024,"pattern":"\\S","description":"JSON string describing the existing screen query."}},{"$ref":"#/components/parameters/GloomVersion"}],"responses":{"200":{"description":"Credit estimate.","content":{"application/json":{"schema":{"type":"object","required":["data","meta"],"properties":{"data":{"$ref":"#/components/schemas/CreditEstimate"},"meta":{"$ref":"#/components/schemas/Meta"}}}}},"headers":{"Request-Id":{"$ref":"#/components/headers/RequestId"},"Gloom-Version":{"$ref":"#/components/headers/GloomVersion"}}},"400":{"$ref":"#/components/responses/Error400"}}}},"/v1/datasets/changelog":{"get":{"operationId":"changelog.list","tags":["Reference"],"summary":"Contract versions and what each one changed","description":"Newest first. Every response names its version in Gloom-Version. The same entries are at https://gloom.sh/datasets/docs/changelog.","security":[],"parameters":[{"$ref":"#/components/parameters/GloomVersion"},{"$ref":"#/components/parameters/IfNoneMatch"}],"responses":{"200":{"description":"Changelog entries.","content":{"application/json":{"schema":{"type":"object","required":["data","meta"],"properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/ChangelogEntry"}},"meta":{"$ref":"#/components/schemas/Meta"}}}}},"headers":{"Request-Id":{"$ref":"#/components/headers/RequestId"},"Gloom-Version":{"$ref":"#/components/headers/GloomVersion"},"ETag":{"$ref":"#/components/headers/ETag"}}},"304":{"$ref":"#/components/responses/NotModified"}}}},"/v1/datasets/openapi.json":{"get":{"operationId":"openapi.get","tags":["Reference"],"summary":"OpenAPI 3.1 document","security":[],"responses":{"200":{"description":"This API document.","content":{"application/json":{"schema":{"type":"object"}}}}}}},"/v1/datasets/account":{"get":{"operationId":"account.get","tags":["Account"],"summary":"Account plan, status, current credit period and limits","parameters":[{"$ref":"#/components/parameters/GloomVersion"},{"$ref":"#/components/parameters/IfNoneMatch"}],"x-credit-cost":0,"x-plans":["basic","desk","enterprise"],"responses":{"200":{"description":"The key's account. The balance is authoritative.","content":{"application/json":{"schema":{"type":"object","required":["data","meta"],"properties":{"data":{"$ref":"#/components/schemas/Account"},"meta":{"$ref":"#/components/schemas/Meta"}}}}},"headers":{"Request-Id":{"$ref":"#/components/headers/RequestId"},"Gloom-Version":{"$ref":"#/components/headers/GloomVersion"},"X-Credits-Cost":{"$ref":"#/components/headers/CreditsCost"},"X-Credits-Remaining":{"$ref":"#/components/headers/CreditsRemaining"},"X-Plan":{"$ref":"#/components/headers/Plan"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimitLimit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimitRemaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimitReset"},"ETag":{"$ref":"#/components/headers/ETag"}}},"304":{"$ref":"#/components/responses/NotModified"},"400":{"$ref":"#/components/responses/Error400"},"401":{"$ref":"#/components/responses/Error401"},"402":{"$ref":"#/components/responses/Error402"},"403":{"$ref":"#/components/responses/Error403"},"404":{"$ref":"#/components/responses/Error404"},"429":{"$ref":"#/components/responses/Error429"},"503":{"$ref":"#/components/responses/Error503"}}}},"/v1/datasets/usage":{"get":{"operationId":"usage.get","tags":["Account"],"summary":"Account plan, current credit period and per-dataset usage","parameters":[{"$ref":"#/components/parameters/GloomVersion"},{"$ref":"#/components/parameters/IfNoneMatch"}],"x-credit-cost":0,"x-plans":["basic","desk","enterprise"],"responses":{"200":{"description":"Account balance and period usage. Usage rows are buffered; the balance is authoritative.","content":{"application/json":{"schema":{"type":"object","required":["data","meta"],"properties":{"data":{"$ref":"#/components/schemas/Usage"},"meta":{"$ref":"#/components/schemas/Meta"}}}}},"headers":{"Request-Id":{"$ref":"#/components/headers/RequestId"},"Gloom-Version":{"$ref":"#/components/headers/GloomVersion"},"X-Credits-Cost":{"$ref":"#/components/headers/CreditsCost"},"X-Credits-Remaining":{"$ref":"#/components/headers/CreditsRemaining"},"X-Plan":{"$ref":"#/components/headers/Plan"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimitLimit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimitRemaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimitReset"},"ETag":{"$ref":"#/components/headers/ETag"}}},"304":{"$ref":"#/components/responses/NotModified"},"400":{"$ref":"#/components/responses/Error400"},"401":{"$ref":"#/components/responses/Error401"},"402":{"$ref":"#/components/responses/Error402"},"403":{"$ref":"#/components/responses/Error403"},"404":{"$ref":"#/components/responses/Error404"},"429":{"$ref":"#/components/responses/Error429"},"503":{"$ref":"#/components/responses/Error503"}}}},"/v1/datasets/gpu/sample":{"get":{"operationId":"gpu.sample","tags":["gpu"],"summary":"Static GPU rental prices sample","description":"A static, trimmed example of a real response, in the same envelope. Limited to 30 sample requests per IP per hour.","security":[],"parameters":[{"$ref":"#/components/parameters/GloomVersion"},{"$ref":"#/components/parameters/IfNoneMatch"}],"x-credit-cost":0,"responses":{"200":{"description":"Static dataset sample.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DatasetResponse"}}},"headers":{"Request-Id":{"$ref":"#/components/headers/RequestId"},"Gloom-Version":{"$ref":"#/components/headers/GloomVersion"},"ETag":{"$ref":"#/components/headers/ETag"}}},"304":{"$ref":"#/components/responses/NotModified"},"429":{"$ref":"#/components/responses/Error429"}}}},"/v1/datasets/hiring-jobs/sample":{"get":{"operationId":"hiring-jobs.sample","tags":["hiring-jobs"],"summary":"Static Hiring postings sample","description":"A static, trimmed example of a real response, in the same envelope. Limited to 30 sample requests per IP per hour.","security":[],"parameters":[{"$ref":"#/components/parameters/GloomVersion"},{"$ref":"#/components/parameters/IfNoneMatch"}],"x-credit-cost":0,"responses":{"200":{"description":"Static dataset sample.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DatasetResponse"}}},"headers":{"Request-Id":{"$ref":"#/components/headers/RequestId"},"Gloom-Version":{"$ref":"#/components/headers/GloomVersion"},"ETag":{"$ref":"#/components/headers/ETag"}}},"304":{"$ref":"#/components/responses/NotModified"},"429":{"$ref":"#/components/responses/Error429"}}}},"/v1/datasets/hiring-momentum/sample":{"get":{"operationId":"hiring-momentum.sample","tags":["hiring-momentum"],"summary":"Static Hiring momentum sample","description":"A static, trimmed example of a real response, in the same envelope. Limited to 30 sample requests per IP per hour.","security":[],"parameters":[{"$ref":"#/components/parameters/GloomVersion"},{"$ref":"#/components/parameters/IfNoneMatch"}],"x-credit-cost":0,"responses":{"200":{"description":"Static dataset sample.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DatasetResponse"}}},"headers":{"Request-Id":{"$ref":"#/components/headers/RequestId"},"Gloom-Version":{"$ref":"#/components/headers/GloomVersion"},"ETag":{"$ref":"#/components/headers/ETag"}}},"304":{"$ref":"#/components/responses/NotModified"},"429":{"$ref":"#/components/responses/Error429"}}}},"/v1/datasets/app-attention/sample":{"get":{"operationId":"app-attention.sample","tags":["app-attention"],"summary":"Static App attention sample","description":"A static, trimmed example of a real response, in the same envelope. Limited to 30 sample requests per IP per hour.","security":[],"parameters":[{"$ref":"#/components/parameters/GloomVersion"},{"$ref":"#/components/parameters/IfNoneMatch"}],"x-credit-cost":0,"responses":{"200":{"description":"Static dataset sample.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DatasetResponse"}}},"headers":{"Request-Id":{"$ref":"#/components/headers/RequestId"},"Gloom-Version":{"$ref":"#/components/headers/GloomVersion"},"ETag":{"$ref":"#/components/headers/ETag"}}},"304":{"$ref":"#/components/responses/NotModified"},"429":{"$ref":"#/components/responses/Error429"}}}},"/v1/datasets/awards/sample":{"get":{"operationId":"awards.sample","tags":["awards"],"summary":"Static Government awards sample","description":"A static, trimmed example of a real response, in the same envelope. Limited to 30 sample requests per IP per hour.","security":[],"parameters":[{"$ref":"#/components/parameters/GloomVersion"},{"$ref":"#/components/parameters/IfNoneMatch"}],"x-credit-cost":0,"responses":{"200":{"description":"Static dataset sample.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DatasetResponse"}}},"headers":{"Request-Id":{"$ref":"#/components/headers/RequestId"},"Gloom-Version":{"$ref":"#/components/headers/GloomVersion"},"ETag":{"$ref":"#/components/headers/ETag"}}},"304":{"$ref":"#/components/responses/NotModified"},"429":{"$ref":"#/components/responses/Error429"}}}},"/v1/datasets/kpis-guidance/sample":{"get":{"operationId":"kpis-guidance.sample","tags":["kpis-guidance"],"summary":"Static KPIs and guidance sample","description":"A static, trimmed example of a real response, in the same envelope. Limited to 30 sample requests per IP per hour.","security":[],"parameters":[{"$ref":"#/components/parameters/GloomVersion"},{"$ref":"#/components/parameters/IfNoneMatch"}],"x-credit-cost":0,"responses":{"200":{"description":"Static dataset sample.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DatasetResponse"}}},"headers":{"Request-Id":{"$ref":"#/components/headers/RequestId"},"Gloom-Version":{"$ref":"#/components/headers/GloomVersion"},"ETag":{"$ref":"#/components/headers/ETag"}}},"304":{"$ref":"#/components/responses/NotModified"},"429":{"$ref":"#/components/responses/Error429"}}}},"/v1/datasets/credit-documents/sample":{"get":{"operationId":"credit-documents.sample","tags":["credit-documents"],"summary":"Static Credit documents and covenants sample","description":"A static, trimmed example of a real response, in the same envelope. Limited to 30 sample requests per IP per hour.","security":[],"parameters":[{"$ref":"#/components/parameters/GloomVersion"},{"$ref":"#/components/parameters/IfNoneMatch"}],"x-credit-cost":0,"responses":{"200":{"description":"Static dataset sample.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DatasetResponse"}}},"headers":{"Request-Id":{"$ref":"#/components/headers/RequestId"},"Gloom-Version":{"$ref":"#/components/headers/GloomVersion"},"ETag":{"$ref":"#/components/headers/ETag"}}},"304":{"$ref":"#/components/responses/NotModified"},"429":{"$ref":"#/components/responses/Error429"}}}},"/v1/datasets/power/sample":{"get":{"operationId":"power.sample","tags":["power"],"summary":"Static Power and grid sample","description":"A static, trimmed example of a real response, in the same envelope. Limited to 30 sample requests per IP per hour.","security":[],"parameters":[{"$ref":"#/components/parameters/GloomVersion"},{"$ref":"#/components/parameters/IfNoneMatch"}],"x-credit-cost":0,"responses":{"200":{"description":"Static dataset sample.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DatasetResponse"}}},"headers":{"Request-Id":{"$ref":"#/components/headers/RequestId"},"Gloom-Version":{"$ref":"#/components/headers/GloomVersion"},"ETag":{"$ref":"#/components/headers/ETag"}}},"304":{"$ref":"#/components/responses/NotModified"},"429":{"$ref":"#/components/responses/Error429"}}}},"/v1/datasets/perps/sample":{"get":{"operationId":"perps.sample","tags":["perps"],"summary":"Static Perpetuals sample","description":"A static, trimmed example of a real response, in the same envelope. Limited to 30 sample requests per IP per hour.","security":[],"parameters":[{"$ref":"#/components/parameters/GloomVersion"},{"$ref":"#/components/parameters/IfNoneMatch"}],"x-credit-cost":0,"responses":{"200":{"description":"Static dataset sample.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DatasetResponse"}}},"headers":{"Request-Id":{"$ref":"#/components/headers/RequestId"},"Gloom-Version":{"$ref":"#/components/headers/GloomVersion"},"ETag":{"$ref":"#/components/headers/ETag"}}},"304":{"$ref":"#/components/responses/NotModified"},"429":{"$ref":"#/components/responses/Error429"}}}},"/v1/datasets/catalysts/sample":{"get":{"operationId":"catalysts.sample","tags":["catalysts"],"summary":"Static Catalysts and litigation sample","description":"A static, trimmed example of a real response, in the same envelope. Limited to 30 sample requests per IP per hour.","security":[],"parameters":[{"$ref":"#/components/parameters/GloomVersion"},{"$ref":"#/components/parameters/IfNoneMatch"}],"x-credit-cost":0,"responses":{"200":{"description":"Static dataset sample.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DatasetResponse"}}},"headers":{"Request-Id":{"$ref":"#/components/headers/RequestId"},"Gloom-Version":{"$ref":"#/components/headers/GloomVersion"},"ETag":{"$ref":"#/components/headers/ETag"}}},"304":{"$ref":"#/components/responses/NotModified"},"429":{"$ref":"#/components/responses/Error429"}}}},"/v1/datasets/research-attention/sample":{"get":{"operationId":"research-attention.sample","tags":["research-attention"],"summary":"Static Research attention sample","description":"A static, trimmed example of a real response, in the same envelope. Limited to 30 sample requests per IP per hour.","security":[],"parameters":[{"$ref":"#/components/parameters/GloomVersion"},{"$ref":"#/components/parameters/IfNoneMatch"}],"x-credit-cost":0,"responses":{"200":{"description":"Static dataset sample.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DatasetResponse"}}},"headers":{"Request-Id":{"$ref":"#/components/headers/RequestId"},"Gloom-Version":{"$ref":"#/components/headers/GloomVersion"},"ETag":{"$ref":"#/components/headers/ETag"}}},"304":{"$ref":"#/components/responses/NotModified"},"429":{"$ref":"#/components/responses/Error429"}}}},"/v1/datasets/supply-chain/sample":{"get":{"operationId":"supply-chain.sample","tags":["supply-chain"],"summary":"Static Supply chain sample","description":"A static, trimmed example of a real response, in the same envelope. Limited to 30 sample requests per IP per hour.","security":[],"parameters":[{"$ref":"#/components/parameters/GloomVersion"},{"$ref":"#/components/parameters/IfNoneMatch"}],"x-credit-cost":0,"responses":{"200":{"description":"Static dataset sample.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DatasetResponse"}}},"headers":{"Request-Id":{"$ref":"#/components/headers/RequestId"},"Gloom-Version":{"$ref":"#/components/headers/GloomVersion"},"ETag":{"$ref":"#/components/headers/ETag"}}},"304":{"$ref":"#/components/responses/NotModified"},"429":{"$ref":"#/components/responses/Error429"}}}},"/v1/datasets/exposure/sample":{"get":{"operationId":"exposure.sample","tags":["exposure"],"summary":"Static Exposure engine sample","description":"A static, trimmed example of a real response, in the same envelope. Limited to 30 sample requests per IP per hour.","security":[],"parameters":[{"$ref":"#/components/parameters/GloomVersion"},{"$ref":"#/components/parameters/IfNoneMatch"}],"x-credit-cost":0,"responses":{"200":{"description":"Static dataset sample.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DatasetResponse"}}},"headers":{"Request-Id":{"$ref":"#/components/headers/RequestId"},"Gloom-Version":{"$ref":"#/components/headers/GloomVersion"},"ETag":{"$ref":"#/components/headers/ETag"}}},"304":{"$ref":"#/components/responses/NotModified"},"429":{"$ref":"#/components/responses/Error429"}}}},"/v1/datasets/transcripts/sample":{"get":{"operationId":"transcripts.sample","tags":["transcripts"],"summary":"Static Earnings-call transcripts sample","description":"A static, trimmed example of a real response, in the same envelope. Limited to 30 sample requests per IP per hour.","security":[],"parameters":[{"$ref":"#/components/parameters/GloomVersion"},{"$ref":"#/components/parameters/IfNoneMatch"}],"x-credit-cost":0,"responses":{"200":{"description":"Static dataset sample.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DatasetResponse"}}},"headers":{"Request-Id":{"$ref":"#/components/headers/RequestId"},"Gloom-Version":{"$ref":"#/components/headers/GloomVersion"},"ETag":{"$ref":"#/components/headers/ETag"}}},"304":{"$ref":"#/components/responses/NotModified"},"429":{"$ref":"#/components/responses/Error429"}}}},"/v1/datasets/exec-pay/sample":{"get":{"operationId":"exec-pay.sample","tags":["exec-pay"],"summary":"Static Executive pay sample","description":"A static, trimmed example of a real response, in the same envelope. Limited to 30 sample requests per IP per hour.","security":[],"parameters":[{"$ref":"#/components/parameters/GloomVersion"},{"$ref":"#/components/parameters/IfNoneMatch"}],"x-credit-cost":0,"responses":{"200":{"description":"Static dataset sample.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DatasetResponse"}}},"headers":{"Request-Id":{"$ref":"#/components/headers/RequestId"},"Gloom-Version":{"$ref":"#/components/headers/GloomVersion"},"ETag":{"$ref":"#/components/headers/ETag"}}},"304":{"$ref":"#/components/responses/NotModified"},"429":{"$ref":"#/components/responses/Error429"}}}},"/v1/datasets/risk-factors/sample":{"get":{"operationId":"risk-factors.sample","tags":["risk-factors"],"summary":"Static Risk factors sample","description":"A static, trimmed example of a real response, in the same envelope. Limited to 30 sample requests per IP per hour.","security":[],"parameters":[{"$ref":"#/components/parameters/GloomVersion"},{"$ref":"#/components/parameters/IfNoneMatch"}],"x-credit-cost":0,"responses":{"200":{"description":"Static dataset sample.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DatasetResponse"}}},"headers":{"Request-Id":{"$ref":"#/components/headers/RequestId"},"Gloom-Version":{"$ref":"#/components/headers/GloomVersion"},"ETag":{"$ref":"#/components/headers/ETag"}}},"304":{"$ref":"#/components/responses/NotModified"},"429":{"$ref":"#/components/responses/Error429"}}}},"/v1/datasets/events/sample":{"get":{"operationId":"events.sample","tags":["events"],"summary":"Static 8-K events sample","description":"A static, trimmed example of a real response, in the same envelope. Limited to 30 sample requests per IP per hour.","security":[],"parameters":[{"$ref":"#/components/parameters/GloomVersion"},{"$ref":"#/components/parameters/IfNoneMatch"}],"x-credit-cost":0,"responses":{"200":{"description":"Static dataset sample.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DatasetResponse"}}},"headers":{"Request-Id":{"$ref":"#/components/headers/RequestId"},"Gloom-Version":{"$ref":"#/components/headers/GloomVersion"},"ETag":{"$ref":"#/components/headers/ETag"}}},"304":{"$ref":"#/components/responses/NotModified"},"429":{"$ref":"#/components/responses/Error429"}}}},"/v1/datasets/document-search/sample":{"get":{"operationId":"document-search.sample","tags":["document-search"],"summary":"Static Document search sample","description":"A static, trimmed example of a real response, in the same envelope. Limited to 30 sample requests per IP per hour.","security":[],"parameters":[{"$ref":"#/components/parameters/GloomVersion"},{"$ref":"#/components/parameters/IfNoneMatch"}],"x-credit-cost":0,"responses":{"200":{"description":"Static dataset sample.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DatasetResponse"}}},"headers":{"Request-Id":{"$ref":"#/components/headers/RequestId"},"Gloom-Version":{"$ref":"#/components/headers/GloomVersion"},"ETag":{"$ref":"#/components/headers/ETag"}}},"304":{"$ref":"#/components/responses/NotModified"},"429":{"$ref":"#/components/responses/Error429"}}}},"/v1/datasets/news/sample":{"get":{"operationId":"news.sample","tags":["news"],"summary":"Static News sample","description":"A static, trimmed example of a real response, in the same envelope. Limited to 30 sample requests per IP per hour.","security":[],"parameters":[{"$ref":"#/components/parameters/GloomVersion"},{"$ref":"#/components/parameters/IfNoneMatch"}],"x-credit-cost":0,"responses":{"200":{"description":"Static dataset sample.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DatasetResponse"}}},"headers":{"Request-Id":{"$ref":"#/components/headers/RequestId"},"Gloom-Version":{"$ref":"#/components/headers/GloomVersion"},"ETag":{"$ref":"#/components/headers/ETag"}}},"304":{"$ref":"#/components/responses/NotModified"},"429":{"$ref":"#/components/responses/Error429"}}}},"/v1/datasets/social-mentions/sample":{"get":{"operationId":"social-mentions.sample","tags":["social-mentions"],"summary":"Static Social mentions sample","description":"A static, trimmed example of a real response, in the same envelope. Limited to 30 sample requests per IP per hour.","security":[],"parameters":[{"$ref":"#/components/parameters/GloomVersion"},{"$ref":"#/components/parameters/IfNoneMatch"}],"x-credit-cost":0,"responses":{"200":{"description":"Static dataset sample.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DatasetResponse"}}},"headers":{"Request-Id":{"$ref":"#/components/headers/RequestId"},"Gloom-Version":{"$ref":"#/components/headers/GloomVersion"},"ETag":{"$ref":"#/components/headers/ETag"}}},"304":{"$ref":"#/components/responses/NotModified"},"429":{"$ref":"#/components/responses/Error429"}}}},"/v1/datasets/cpi/sample":{"get":{"operationId":"cpi.sample","tags":["cpi"],"summary":"Static US consumer prices sample","description":"A static, trimmed example of a real response, in the same envelope. Limited to 30 sample requests per IP per hour.","security":[],"parameters":[{"$ref":"#/components/parameters/GloomVersion"},{"$ref":"#/components/parameters/IfNoneMatch"}],"x-credit-cost":0,"responses":{"200":{"description":"Static dataset sample.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DatasetResponse"}}},"headers":{"Request-Id":{"$ref":"#/components/headers/RequestId"},"Gloom-Version":{"$ref":"#/components/headers/GloomVersion"},"ETag":{"$ref":"#/components/headers/ETag"}}},"304":{"$ref":"#/components/responses/NotModified"},"429":{"$ref":"#/components/responses/Error429"}}}},"/v1/datasets/energy-inventories/sample":{"get":{"operationId":"energy-inventories.sample","tags":["energy-inventories"],"summary":"Static EIA energy inventories sample","description":"A static, trimmed example of a real response, in the same envelope. Limited to 30 sample requests per IP per hour.","security":[],"parameters":[{"$ref":"#/components/parameters/GloomVersion"},{"$ref":"#/components/parameters/IfNoneMatch"}],"x-credit-cost":0,"responses":{"200":{"description":"Static dataset sample.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DatasetResponse"}}},"headers":{"Request-Id":{"$ref":"#/components/headers/RequestId"},"Gloom-Version":{"$ref":"#/components/headers/GloomVersion"},"ETag":{"$ref":"#/components/headers/ETag"}}},"304":{"$ref":"#/components/responses/NotModified"},"429":{"$ref":"#/components/responses/Error429"}}}},"/v1/datasets/cot/sample":{"get":{"operationId":"cot.sample","tags":["cot"],"summary":"Static CFTC positioning sample","description":"A static, trimmed example of a real response, in the same envelope. Limited to 30 sample requests per IP per hour.","security":[],"parameters":[{"$ref":"#/components/parameters/GloomVersion"},{"$ref":"#/components/parameters/IfNoneMatch"}],"x-credit-cost":0,"responses":{"200":{"description":"Static dataset sample.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DatasetResponse"}}},"headers":{"Request-Id":{"$ref":"#/components/headers/RequestId"},"Gloom-Version":{"$ref":"#/components/headers/GloomVersion"},"ETag":{"$ref":"#/components/headers/ETag"}}},"304":{"$ref":"#/components/responses/NotModified"},"429":{"$ref":"#/components/responses/Error429"}}}},"/v1/datasets/short-volume/sample":{"get":{"operationId":"short-volume.sample","tags":["short-volume"],"summary":"Static FINRA short volume sample","description":"A static, trimmed example of a real response, in the same envelope. Limited to 30 sample requests per IP per hour.","security":[],"parameters":[{"$ref":"#/components/parameters/GloomVersion"},{"$ref":"#/components/parameters/IfNoneMatch"}],"x-credit-cost":0,"responses":{"200":{"description":"Static dataset sample.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DatasetResponse"}}},"headers":{"Request-Id":{"$ref":"#/components/headers/RequestId"},"Gloom-Version":{"$ref":"#/components/headers/GloomVersion"},"ETag":{"$ref":"#/components/headers/ETag"}}},"304":{"$ref":"#/components/responses/NotModified"},"429":{"$ref":"#/components/responses/Error429"}}}},"/v1/datasets/short-interest/sample":{"get":{"operationId":"short-interest.sample","tags":["short-interest"],"summary":"Static FINRA short interest sample","description":"A static, trimmed example of a real response, in the same envelope. Limited to 30 sample requests per IP per hour.","security":[],"parameters":[{"$ref":"#/components/parameters/GloomVersion"},{"$ref":"#/components/parameters/IfNoneMatch"}],"x-credit-cost":0,"responses":{"200":{"description":"Static dataset sample.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DatasetResponse"}}},"headers":{"Request-Id":{"$ref":"#/components/headers/RequestId"},"Gloom-Version":{"$ref":"#/components/headers/GloomVersion"},"ETag":{"$ref":"#/components/headers/ETag"}}},"304":{"$ref":"#/components/responses/NotModified"},"429":{"$ref":"#/components/responses/Error429"}}}},"/v1/datasets/sec/sample":{"get":{"operationId":"sec.sample","tags":["sec"],"summary":"Static SEC filings, insiders and 13F holders sample","description":"A static, trimmed example of a real response, in the same envelope. Limited to 30 sample requests per IP per hour.","security":[],"parameters":[{"$ref":"#/components/parameters/GloomVersion"},{"$ref":"#/components/parameters/IfNoneMatch"}],"x-credit-cost":0,"responses":{"200":{"description":"Static dataset sample.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DatasetResponse"}}},"headers":{"Request-Id":{"$ref":"#/components/headers/RequestId"},"Gloom-Version":{"$ref":"#/components/headers/GloomVersion"},"ETag":{"$ref":"#/components/headers/ETag"}}},"304":{"$ref":"#/components/responses/NotModified"},"429":{"$ref":"#/components/responses/Error429"}}}},"/v1/datasets/congress/sample":{"get":{"operationId":"congress.sample","tags":["congress"],"summary":"Static Congress trades sample","description":"A static, trimmed example of a real response, in the same envelope. Limited to 30 sample requests per IP per hour.","security":[],"parameters":[{"$ref":"#/components/parameters/GloomVersion"},{"$ref":"#/components/parameters/IfNoneMatch"}],"x-credit-cost":0,"responses":{"200":{"description":"Static dataset sample.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DatasetResponse"}}},"headers":{"Request-Id":{"$ref":"#/components/headers/RequestId"},"Gloom-Version":{"$ref":"#/components/headers/GloomVersion"},"ETag":{"$ref":"#/components/headers/ETag"}}},"304":{"$ref":"#/components/responses/NotModified"},"429":{"$ref":"#/components/responses/Error429"}}}},"/v1/datasets/macro/sample":{"get":{"operationId":"macro.sample","tags":["macro"],"summary":"Static Yield curves and macro series sample","description":"A static, trimmed example of a real response, in the same envelope. Limited to 30 sample requests per IP per hour.","security":[],"parameters":[{"$ref":"#/components/parameters/GloomVersion"},{"$ref":"#/components/parameters/IfNoneMatch"}],"x-credit-cost":0,"responses":{"200":{"description":"Static dataset sample.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DatasetResponse"}}},"headers":{"Request-Id":{"$ref":"#/components/headers/RequestId"},"Gloom-Version":{"$ref":"#/components/headers/GloomVersion"},"ETag":{"$ref":"#/components/headers/ETag"}}},"304":{"$ref":"#/components/responses/NotModified"},"429":{"$ref":"#/components/responses/Error429"}}}},"/v1/datasets/central-bank-rates/sample":{"get":{"operationId":"central-bank-rates.sample","tags":["central-bank-rates"],"summary":"Static Central bank rates sample","description":"A static, trimmed example of a real response, in the same envelope. Limited to 30 sample requests per IP per hour.","security":[],"parameters":[{"$ref":"#/components/parameters/GloomVersion"},{"$ref":"#/components/parameters/IfNoneMatch"}],"x-credit-cost":0,"responses":{"200":{"description":"Static dataset sample.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DatasetResponse"}}},"headers":{"Request-Id":{"$ref":"#/components/headers/RequestId"},"Gloom-Version":{"$ref":"#/components/headers/GloomVersion"},"ETag":{"$ref":"#/components/headers/ETag"}}},"304":{"$ref":"#/components/responses/NotModified"},"429":{"$ref":"#/components/responses/Error429"}}}},"/v1/datasets/cds/sample":{"get":{"operationId":"cds.sample","tags":["cds"],"summary":"Static Credit default swaps sample","description":"A static, trimmed example of a real response, in the same envelope. Limited to 30 sample requests per IP per hour.","security":[],"parameters":[{"$ref":"#/components/parameters/GloomVersion"},{"$ref":"#/components/parameters/IfNoneMatch"}],"x-credit-cost":0,"responses":{"200":{"description":"Static dataset sample.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DatasetResponse"}}},"headers":{"Request-Id":{"$ref":"#/components/headers/RequestId"},"Gloom-Version":{"$ref":"#/components/headers/GloomVersion"},"ETag":{"$ref":"#/components/headers/ETag"}}},"304":{"$ref":"#/components/responses/NotModified"},"429":{"$ref":"#/components/responses/Error429"}}}},"/v1/datasets/debt-maturities/sample":{"get":{"operationId":"debt-maturities.sample","tags":["debt-maturities"],"summary":"Static Debt maturities sample","description":"A static, trimmed example of a real response, in the same envelope. Limited to 30 sample requests per IP per hour.","security":[],"parameters":[{"$ref":"#/components/parameters/GloomVersion"},{"$ref":"#/components/parameters/IfNoneMatch"}],"x-credit-cost":0,"responses":{"200":{"description":"Static dataset sample.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DatasetResponse"}}},"headers":{"Request-Id":{"$ref":"#/components/headers/RequestId"},"Gloom-Version":{"$ref":"#/components/headers/GloomVersion"},"ETag":{"$ref":"#/components/headers/ETag"}}},"304":{"$ref":"#/components/responses/NotModified"},"429":{"$ref":"#/components/responses/Error429"}}}},"/v1/datasets/revenue-breakdown/sample":{"get":{"operationId":"revenue-breakdown.sample","tags":["revenue-breakdown"],"summary":"Static Revenue breakdown sample","description":"A static, trimmed example of a real response, in the same envelope. Limited to 30 sample requests per IP per hour.","security":[],"parameters":[{"$ref":"#/components/parameters/GloomVersion"},{"$ref":"#/components/parameters/IfNoneMatch"}],"x-credit-cost":0,"responses":{"200":{"description":"Static dataset sample.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DatasetResponse"}}},"headers":{"Request-Id":{"$ref":"#/components/headers/RequestId"},"Gloom-Version":{"$ref":"#/components/headers/GloomVersion"},"ETag":{"$ref":"#/components/headers/ETag"}}},"304":{"$ref":"#/components/responses/NotModified"},"429":{"$ref":"#/components/responses/Error429"}}}},"/v1/datasets/market-data/sample":{"get":{"operationId":"market-data.sample","tags":["market-data"],"summary":"Static Market prices and company fundamentals sample","description":"A static, trimmed example of a real response, in the same envelope. Limited to 30 sample requests per IP per hour.","security":[],"parameters":[{"$ref":"#/components/parameters/GloomVersion"},{"$ref":"#/components/parameters/IfNoneMatch"}],"x-credit-cost":0,"responses":{"200":{"description":"Static dataset sample.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DatasetResponse"}}},"headers":{"Request-Id":{"$ref":"#/components/headers/RequestId"},"Gloom-Version":{"$ref":"#/components/headers/GloomVersion"},"ETag":{"$ref":"#/components/headers/ETag"}}},"304":{"$ref":"#/components/responses/NotModified"},"429":{"$ref":"#/components/responses/Error429"}}}},"/v1/datasets/futures/sample":{"get":{"operationId":"futures.sample","tags":["futures"],"summary":"Static Futures curves, archives and generics sample","description":"A static, trimmed example of a real response, in the same envelope. Limited to 30 sample requests per IP per hour.","security":[],"parameters":[{"$ref":"#/components/parameters/GloomVersion"},{"$ref":"#/components/parameters/IfNoneMatch"}],"x-credit-cost":0,"responses":{"200":{"description":"Static dataset sample.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DatasetResponse"}}},"headers":{"Request-Id":{"$ref":"#/components/headers/RequestId"},"Gloom-Version":{"$ref":"#/components/headers/GloomVersion"},"ETag":{"$ref":"#/components/headers/ETag"}}},"304":{"$ref":"#/components/responses/NotModified"},"429":{"$ref":"#/components/responses/Error429"}}}},"/v1/datasets/rate-path/sample":{"get":{"operationId":"rate-path.sample","tags":["rate-path"],"summary":"Static Rate path sample","description":"A static, trimmed example of a real response, in the same envelope. Limited to 30 sample requests per IP per hour.","security":[],"parameters":[{"$ref":"#/components/parameters/GloomVersion"},{"$ref":"#/components/parameters/IfNoneMatch"}],"x-credit-cost":0,"responses":{"200":{"description":"Static dataset sample.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DatasetResponse"}}},"headers":{"Request-Id":{"$ref":"#/components/headers/RequestId"},"Gloom-Version":{"$ref":"#/components/headers/GloomVersion"},"ETag":{"$ref":"#/components/headers/ETag"}}},"304":{"$ref":"#/components/responses/NotModified"},"429":{"$ref":"#/components/responses/Error429"}}}},"/v1/datasets/options/sample":{"get":{"operationId":"options.sample","tags":["options"],"summary":"Static Options flow, chains and implied volatility sample","description":"A static, trimmed example of a real response, in the same envelope. Limited to 30 sample requests per IP per hour.","security":[],"parameters":[{"$ref":"#/components/parameters/GloomVersion"},{"$ref":"#/components/parameters/IfNoneMatch"}],"x-credit-cost":0,"responses":{"200":{"description":"Static dataset sample.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DatasetResponse"}}},"headers":{"Request-Id":{"$ref":"#/components/headers/RequestId"},"Gloom-Version":{"$ref":"#/components/headers/GloomVersion"},"ETag":{"$ref":"#/components/headers/ETag"}}},"304":{"$ref":"#/components/responses/NotModified"},"429":{"$ref":"#/components/responses/Error429"}}}},"/v1/datasets/earnings/sample":{"get":{"operationId":"earnings.sample","tags":["earnings"],"summary":"Static Earnings calendar and moves sample","description":"A static, trimmed example of a real response, in the same envelope. Limited to 30 sample requests per IP per hour.","security":[],"parameters":[{"$ref":"#/components/parameters/GloomVersion"},{"$ref":"#/components/parameters/IfNoneMatch"}],"x-credit-cost":0,"responses":{"200":{"description":"Static dataset sample.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DatasetResponse"}}},"headers":{"Request-Id":{"$ref":"#/components/headers/RequestId"},"Gloom-Version":{"$ref":"#/components/headers/GloomVersion"},"ETag":{"$ref":"#/components/headers/ETag"}}},"304":{"$ref":"#/components/responses/NotModified"},"429":{"$ref":"#/components/responses/Error429"}}}},"/v1/datasets/ipo/sample":{"get":{"operationId":"ipo.sample","tags":["ipo"],"summary":"Static IPO calendar sample","description":"A static, trimmed example of a real response, in the same envelope. Limited to 30 sample requests per IP per hour.","security":[],"parameters":[{"$ref":"#/components/parameters/GloomVersion"},{"$ref":"#/components/parameters/IfNoneMatch"}],"x-credit-cost":0,"responses":{"200":{"description":"Static dataset sample.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DatasetResponse"}}},"headers":{"Request-Id":{"$ref":"#/components/headers/RequestId"},"Gloom-Version":{"$ref":"#/components/headers/GloomVersion"},"ETag":{"$ref":"#/components/headers/ETag"}}},"304":{"$ref":"#/components/responses/NotModified"},"429":{"$ref":"#/components/responses/Error429"}}}},"/v1/datasets/mna/sample":{"get":{"operationId":"mna.sample","tags":["mna"],"summary":"Static Mergers and acquisitions sample","description":"A static, trimmed example of a real response, in the same envelope. Limited to 30 sample requests per IP per hour.","security":[],"parameters":[{"$ref":"#/components/parameters/GloomVersion"},{"$ref":"#/components/parameters/IfNoneMatch"}],"x-credit-cost":0,"responses":{"200":{"description":"Static dataset sample.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DatasetResponse"}}},"headers":{"Request-Id":{"$ref":"#/components/headers/RequestId"},"Gloom-Version":{"$ref":"#/components/headers/GloomVersion"},"ETag":{"$ref":"#/components/headers/ETag"}}},"304":{"$ref":"#/components/responses/NotModified"},"429":{"$ref":"#/components/responses/Error429"}}}},"/v1/datasets/equity-screener/sample":{"get":{"operationId":"equity-screener.sample","tags":["equity-screener"],"summary":"Static Equity screener sample","description":"A static, trimmed example of a real response, in the same envelope. Limited to 30 sample requests per IP per hour.","security":[],"parameters":[{"$ref":"#/components/parameters/GloomVersion"},{"$ref":"#/components/parameters/IfNoneMatch"}],"x-credit-cost":0,"responses":{"200":{"description":"Static dataset sample.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DatasetResponse"}}},"headers":{"Request-Id":{"$ref":"#/components/headers/RequestId"},"Gloom-Version":{"$ref":"#/components/headers/GloomVersion"},"ETag":{"$ref":"#/components/headers/ETag"}}},"304":{"$ref":"#/components/responses/NotModified"},"429":{"$ref":"#/components/responses/Error429"}}}},"/v1/datasets/crypto/sample":{"get":{"operationId":"crypto.sample","tags":["crypto"],"summary":"Static Digital asset markets sample","description":"A static, trimmed example of a real response, in the same envelope. Limited to 30 sample requests per IP per hour.","security":[],"parameters":[{"$ref":"#/components/parameters/GloomVersion"},{"$ref":"#/components/parameters/IfNoneMatch"}],"x-credit-cost":0,"responses":{"200":{"description":"Static dataset sample.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DatasetResponse"}}},"headers":{"Request-Id":{"$ref":"#/components/headers/RequestId"},"Gloom-Version":{"$ref":"#/components/headers/GloomVersion"},"ETag":{"$ref":"#/components/headers/ETag"}}},"304":{"$ref":"#/components/responses/NotModified"},"429":{"$ref":"#/components/responses/Error429"}}}},"/v1/datasets/session-tape/sample":{"get":{"operationId":"session-tape.sample","tags":["session-tape"],"summary":"Static Session movers, highs/lows and tape sample","description":"A static, trimmed example of a real response, in the same envelope. Limited to 30 sample requests per IP per hour.","security":[],"parameters":[{"$ref":"#/components/parameters/GloomVersion"},{"$ref":"#/components/parameters/IfNoneMatch"}],"x-credit-cost":0,"responses":{"200":{"description":"Static dataset sample.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DatasetResponse"}}},"headers":{"Request-Id":{"$ref":"#/components/headers/RequestId"},"Gloom-Version":{"$ref":"#/components/headers/GloomVersion"},"ETag":{"$ref":"#/components/headers/ETag"}}},"304":{"$ref":"#/components/responses/NotModified"},"429":{"$ref":"#/components/responses/Error429"}}}},"/v1/datasets/analyst-estimates/sample":{"get":{"operationId":"analyst-estimates.sample","tags":["analyst-estimates"],"summary":"Static Analyst estimates and revisions sample","description":"A static, trimmed example of a real response, in the same envelope. Limited to 30 sample requests per IP per hour.","security":[],"parameters":[{"$ref":"#/components/parameters/GloomVersion"},{"$ref":"#/components/parameters/IfNoneMatch"}],"x-credit-cost":0,"responses":{"200":{"description":"Static dataset sample.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DatasetResponse"}}},"headers":{"Request-Id":{"$ref":"#/components/headers/RequestId"},"Gloom-Version":{"$ref":"#/components/headers/GloomVersion"},"ETag":{"$ref":"#/components/headers/ETag"}}},"304":{"$ref":"#/components/responses/NotModified"},"429":{"$ref":"#/components/responses/Error429"}}}},"/v1/gpu/prices":{"get":{"operationId":"gpu.prices","tags":["gpu"],"summary":"Published GPU rental rates across providers and marketplaces. Hyperscaler and Neocloud rows are list indexes","description":"Reads the existing dataset service and needs a key on an account with a plan; every plan reads every live dataset in full. Cached market reads can refresh their source data. Unknown, empty and repeated parameters are rejected. History and coverage metadata are null when the stored service cannot establish them.","parameters":[{"name":"limit","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":200,"default":200}},{"name":"cursor","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":120,"pattern":"^[A-Za-z0-9_-]+$","description":"Opaque: meta.page.nextCursor of the previous page. Bound to this route and query."}},{"$ref":"#/components/parameters/GloomVersion"},{"$ref":"#/components/parameters/IfNoneMatch"}],"x-dataset":"gpu","x-credit-cost":4,"x-credit-call-type":"lookup","x-credit-multiplier":4,"x-plans":["basic","desk","enterprise"],"x-sample-url":"/v1/datasets/gpu/sample","responses":{"200":{"description":"Stored dataset response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DatasetResponse"}}},"headers":{"Request-Id":{"$ref":"#/components/headers/RequestId"},"Gloom-Version":{"$ref":"#/components/headers/GloomVersion"},"X-Credits-Cost":{"$ref":"#/components/headers/CreditsCost"},"X-Credits-Remaining":{"$ref":"#/components/headers/CreditsRemaining"},"X-Plan":{"$ref":"#/components/headers/Plan"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimitLimit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimitRemaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimitReset"},"ETag":{"$ref":"#/components/headers/ETag"}}},"304":{"$ref":"#/components/responses/NotModified"},"400":{"$ref":"#/components/responses/Error400"},"401":{"$ref":"#/components/responses/Error401"},"402":{"$ref":"#/components/responses/Error402"},"403":{"$ref":"#/components/responses/Error403"},"404":{"$ref":"#/components/responses/Error404"},"429":{"$ref":"#/components/responses/Error429"},"503":{"$ref":"#/components/responses/Error503"}}}},"/v1/gpu/history":{"get":{"operationId":"gpu.history","tags":["gpu"],"summary":"Observed GPU rental rates and stored reference history","description":"Reads the existing dataset service and needs a key on an account with a plan; every plan reads every live dataset in full. Cached market reads can refresh their source data. Unknown, empty and repeated parameters are rejected. History and coverage metadata are null when the stored service cannot establish them.","parameters":[{"name":"gpuModel","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":1024,"pattern":"\\S"}},{"name":"seriesId","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":1024,"pattern":"\\S"}},{"name":"from","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":35,"pattern":"^\\d{4}-\\d{2}-\\d{2}T(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d{1,6})?(?:Z|[+-](?:[01]\\d|2[0-3]):[0-5]\\d)$","format":"date-time"}},{"name":"to","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":35,"pattern":"^\\d{4}-\\d{2}-\\d{2}T(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d{1,6})?(?:Z|[+-](?:[01]\\d|2[0-3]):[0-5]\\d)$","format":"date-time"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":200}},{"name":"basis","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":1024,"pattern":"\\S","enum":["list","spot","ask","reserved","reference"]}},{"name":"includeFractional","in":"query","required":false,"schema":{"type":"boolean"}},{"$ref":"#/components/parameters/GloomVersion"},{"$ref":"#/components/parameters/IfNoneMatch"}],"x-dataset":"gpu","x-credit-cost":8,"x-credit-call-type":"history","x-credit-multiplier":4,"x-plans":["basic","desk","enterprise"],"x-sample-url":"/v1/datasets/gpu/sample","responses":{"200":{"description":"Stored dataset response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DatasetResponse"}}},"headers":{"Request-Id":{"$ref":"#/components/headers/RequestId"},"Gloom-Version":{"$ref":"#/components/headers/GloomVersion"},"X-Credits-Cost":{"$ref":"#/components/headers/CreditsCost"},"X-Credits-Remaining":{"$ref":"#/components/headers/CreditsRemaining"},"X-Plan":{"$ref":"#/components/headers/Plan"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimitLimit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimitRemaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimitReset"},"ETag":{"$ref":"#/components/headers/ETag"}}},"304":{"$ref":"#/components/responses/NotModified"},"400":{"$ref":"#/components/responses/Error400"},"401":{"$ref":"#/components/responses/Error401"},"402":{"$ref":"#/components/responses/Error402"},"403":{"$ref":"#/components/responses/Error403"},"404":{"$ref":"#/components/responses/Error404"},"429":{"$ref":"#/components/responses/Error429"},"503":{"$ref":"#/components/responses/Error503"}}}},"/v1/gpu/changes":{"get":{"operationId":"gpu.changes","tags":["gpu"],"summary":"Observed GPU price changes","description":"Reads the existing dataset service and needs a key on an account with a plan; every plan reads every live dataset in full. Cached market reads can refresh their source data. Unknown, empty and repeated parameters are rejected. History and coverage metadata are null when the stored service cannot establish them.","parameters":[{"name":"gpuModel","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":1024,"pattern":"\\S"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":200}},{"$ref":"#/components/parameters/GloomVersion"},{"$ref":"#/components/parameters/IfNoneMatch"}],"x-dataset":"gpu","x-credit-cost":4,"x-credit-call-type":"change","x-credit-multiplier":4,"x-plans":["basic","desk","enterprise"],"x-sample-url":"/v1/datasets/gpu/sample","responses":{"200":{"description":"Stored dataset response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DatasetResponse"}}},"headers":{"Request-Id":{"$ref":"#/components/headers/RequestId"},"Gloom-Version":{"$ref":"#/components/headers/GloomVersion"},"X-Credits-Cost":{"$ref":"#/components/headers/CreditsCost"},"X-Credits-Remaining":{"$ref":"#/components/headers/CreditsRemaining"},"X-Plan":{"$ref":"#/components/headers/Plan"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimitLimit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimitRemaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimitReset"},"ETag":{"$ref":"#/components/headers/ETag"}}},"304":{"$ref":"#/components/responses/NotModified"},"400":{"$ref":"#/components/responses/Error400"},"401":{"$ref":"#/components/responses/Error401"},"402":{"$ref":"#/components/responses/Error402"},"403":{"$ref":"#/components/responses/Error403"},"404":{"$ref":"#/components/responses/Error404"},"429":{"$ref":"#/components/responses/Error429"},"503":{"$ref":"#/components/responses/Error503"}}}},"/v1/macro/cpi":{"get":{"operationId":"cpi.board","tags":["cpi"],"summary":"US CPI components, weights and contributions","description":"Reads the existing dataset service and needs a key on an account with a plan; every plan reads every live dataset in full. Cached market reads can refresh their source data. Unknown, empty and repeated parameters are rejected. History and coverage metadata are null when the stored service cannot establish them.","parameters":[{"$ref":"#/components/parameters/GloomVersion"},{"$ref":"#/components/parameters/IfNoneMatch"}],"x-dataset":"cpi","x-credit-cost":1,"x-credit-call-type":"lookup","x-credit-multiplier":1,"x-plans":["basic","desk","enterprise"],"x-sample-url":"/v1/datasets/cpi/sample","responses":{"200":{"description":"Stored dataset response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DatasetResponse"}}},"headers":{"Request-Id":{"$ref":"#/components/headers/RequestId"},"Gloom-Version":{"$ref":"#/components/headers/GloomVersion"},"X-Credits-Cost":{"$ref":"#/components/headers/CreditsCost"},"X-Credits-Remaining":{"$ref":"#/components/headers/CreditsRemaining"},"X-Plan":{"$ref":"#/components/headers/Plan"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimitLimit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimitRemaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimitReset"},"ETag":{"$ref":"#/components/headers/ETag"}}},"304":{"$ref":"#/components/responses/NotModified"},"400":{"$ref":"#/components/responses/Error400"},"401":{"$ref":"#/components/responses/Error401"},"402":{"$ref":"#/components/responses/Error402"},"403":{"$ref":"#/components/responses/Error403"},"404":{"$ref":"#/components/responses/Error404"},"429":{"$ref":"#/components/responses/Error429"},"503":{"$ref":"#/components/responses/Error503"}}}},"/v1/energy/inventories":{"get":{"operationId":"energy.inventories","tags":["energy-inventories"],"summary":"EIA petroleum and gas inventories","description":"Reads the existing dataset service and needs a key on an account with a plan; every plan reads every live dataset in full. Cached market reads can refresh their source data. Unknown, empty and repeated parameters are rejected. History and coverage metadata are null when the stored service cannot establish them.","parameters":[{"$ref":"#/components/parameters/GloomVersion"},{"$ref":"#/components/parameters/IfNoneMatch"}],"x-dataset":"energy-inventories","x-credit-cost":1,"x-credit-call-type":"lookup","x-credit-multiplier":1,"x-plans":["basic","desk","enterprise"],"x-sample-url":"/v1/datasets/energy-inventories/sample","responses":{"200":{"description":"Stored dataset response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DatasetResponse"}}},"headers":{"Request-Id":{"$ref":"#/components/headers/RequestId"},"Gloom-Version":{"$ref":"#/components/headers/GloomVersion"},"X-Credits-Cost":{"$ref":"#/components/headers/CreditsCost"},"X-Credits-Remaining":{"$ref":"#/components/headers/CreditsRemaining"},"X-Plan":{"$ref":"#/components/headers/Plan"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimitLimit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimitRemaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimitReset"},"ETag":{"$ref":"#/components/headers/ETag"}}},"304":{"$ref":"#/components/responses/NotModified"},"400":{"$ref":"#/components/responses/Error400"},"401":{"$ref":"#/components/responses/Error401"},"402":{"$ref":"#/components/responses/Error402"},"403":{"$ref":"#/components/responses/Error403"},"404":{"$ref":"#/components/responses/Error404"},"429":{"$ref":"#/components/responses/Error429"},"503":{"$ref":"#/components/responses/Error503"}}}},"/v1/cftc/cot":{"get":{"operationId":"cot.board","tags":["cot"],"summary":"CFTC positioning by contract","description":"Reads the existing dataset service and needs a key on an account with a plan; every plan reads every live dataset in full. Cached market reads can refresh their source data. Unknown, empty and repeated parameters are rejected. History and coverage metadata are null when the stored service cannot establish them.","parameters":[{"name":"report","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":1024,"pattern":"\\S","enum":["legacy","disaggregated"],"default":"legacy"}},{"name":"traderClass","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":1024,"pattern":"\\S","enum":["noncommercial","commercial","nonreportable","producer","swap","managed-money","other-reportable"],"description":"Must belong to the selected report. Legacy: noncommercial (default), commercial, nonreportable. Disaggregated: producer, swap, managed-money (default), other-reportable, nonreportable."}},{"$ref":"#/components/parameters/GloomVersion"},{"$ref":"#/components/parameters/IfNoneMatch"}],"x-dataset":"cot","x-credit-cost":1,"x-credit-call-type":"lookup","x-credit-multiplier":1,"x-plans":["basic","desk","enterprise"],"x-sample-url":"/v1/datasets/cot/sample","responses":{"200":{"description":"Stored dataset response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DatasetResponse"}}},"headers":{"Request-Id":{"$ref":"#/components/headers/RequestId"},"Gloom-Version":{"$ref":"#/components/headers/GloomVersion"},"X-Credits-Cost":{"$ref":"#/components/headers/CreditsCost"},"X-Credits-Remaining":{"$ref":"#/components/headers/CreditsRemaining"},"X-Plan":{"$ref":"#/components/headers/Plan"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimitLimit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimitRemaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimitReset"},"ETag":{"$ref":"#/components/headers/ETag"}}},"304":{"$ref":"#/components/responses/NotModified"},"400":{"$ref":"#/components/responses/Error400"},"401":{"$ref":"#/components/responses/Error401"},"402":{"$ref":"#/components/responses/Error402"},"403":{"$ref":"#/components/responses/Error403"},"404":{"$ref":"#/components/responses/Error404"},"429":{"$ref":"#/components/responses/Error429"},"503":{"$ref":"#/components/responses/Error503"}}}},"/v1/cftc/cot/contracts/{contractCode}":{"get":{"operationId":"cot.contract","tags":["cot"],"summary":"CFTC contract positioning history","description":"Reads the existing dataset service and needs a key on an account with a plan; every plan reads every live dataset in full. Cached market reads can refresh their source data. Unknown, empty and repeated parameters are rejected. History and coverage metadata are null when the stored service cannot establish them.","parameters":[{"name":"contractCode","in":"path","required":true,"schema":{"type":"string","minLength":6,"maxLength":6,"pattern":"^[0-9A-Za-z]{5}[0-9A-Za-z+]$","description":"Six-character CFTC market code; normalized to uppercase."}},{"name":"report","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":1024,"pattern":"\\S","enum":["legacy","disaggregated"],"default":"legacy"}},{"name":"traderClass","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":1024,"pattern":"\\S","enum":["noncommercial","commercial","nonreportable","producer","swap","managed-money","other-reportable"],"description":"Must belong to the selected report. Legacy: noncommercial (default), commercial, nonreportable. Disaggregated: producer, swap, managed-money (default), other-reportable, nonreportable."}},{"$ref":"#/components/parameters/GloomVersion"},{"$ref":"#/components/parameters/IfNoneMatch"}],"x-dataset":"cot","x-credit-cost":2,"x-credit-call-type":"history","x-credit-multiplier":1,"x-plans":["basic","desk","enterprise"],"x-sample-url":"/v1/datasets/cot/sample","responses":{"200":{"description":"Stored dataset response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DatasetResponse"}}},"headers":{"Request-Id":{"$ref":"#/components/headers/RequestId"},"Gloom-Version":{"$ref":"#/components/headers/GloomVersion"},"X-Credits-Cost":{"$ref":"#/components/headers/CreditsCost"},"X-Credits-Remaining":{"$ref":"#/components/headers/CreditsRemaining"},"X-Plan":{"$ref":"#/components/headers/Plan"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimitLimit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimitRemaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimitReset"},"ETag":{"$ref":"#/components/headers/ETag"}}},"304":{"$ref":"#/components/responses/NotModified"},"400":{"$ref":"#/components/responses/Error400"},"401":{"$ref":"#/components/responses/Error401"},"402":{"$ref":"#/components/responses/Error402"},"403":{"$ref":"#/components/responses/Error403"},"404":{"$ref":"#/components/responses/Error404"},"429":{"$ref":"#/components/responses/Error429"},"503":{"$ref":"#/components/responses/Error503"}}}},"/v1/awards":{"get":{"operationId":"awards.list","tags":["awards"],"summary":"Government awards with source evidence","description":"Reads the existing dataset service and needs a key on an account with a plan; every plan reads every live dataset in full. Cached market reads can refresh their source data. Unknown, empty and repeated parameters are rejected. History and coverage metadata are null when the stored service cannot establish them.","parameters":[{"name":"ticker","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":32,"pattern":"^[A-Za-z0-9.:-]{1,32}$","description":"Company symbol; normalized to uppercase."}},{"name":"jurisdiction","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":3,"pattern":"^[A-Za-z]{2,3}$"}},{"name":"currency","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":3,"pattern":"^[A-Za-z]{3}$"}},{"name":"agency","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":200,"pattern":"\\S"}},{"name":"sector","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":200,"pattern":"\\S"}},{"name":"source","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":64,"pattern":"^[a-z0-9_-]{1,64}$"}},{"name":"parentId","in":"query","required":false,"schema":{"type":"string","minLength":40,"maxLength":40,"pattern":"^[a-f0-9]{40}$"}},{"name":"awardType","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":1024,"pattern":"\\S","enum":["prime","subaward","modification","notice"]}},{"name":"from","in":"query","required":false,"schema":{"type":"string","minLength":10,"maxLength":10,"pattern":"^\\d{4}-\\d{2}-\\d{2}$","format":"date","description":"Valid calendar date (YYYY-MM-DD). from must be on or before to."}},{"name":"to","in":"query","required":false,"schema":{"type":"string","minLength":10,"maxLength":10,"pattern":"^\\d{4}-\\d{2}-\\d{2}$","format":"date","description":"Valid calendar date (YYYY-MM-DD). from must be on or before to."}},{"name":"fiscalYear","in":"query","required":false,"schema":{"type":"integer","minimum":2000,"maximum":2100}},{"name":"query","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":200,"pattern":"\\S"}},{"name":"minAmount","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":31,"pattern":"^\\d{1,24}(?:\\.\\d{1,6})?$","description":"Nonnegative decimal amount, supplied as a string to preserve precision."}},{"name":"cursor","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":1024,"pattern":"\\S"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":200}},{"$ref":"#/components/parameters/GloomVersion"},{"$ref":"#/components/parameters/IfNoneMatch"}],"x-dataset":"awards","x-credit-cost":4,"x-credit-call-type":"search","x-credit-multiplier":2,"x-plans":["basic","desk","enterprise"],"x-sample-url":"/v1/datasets/awards/sample","responses":{"200":{"description":"Stored dataset response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DatasetResponse"}}},"headers":{"Request-Id":{"$ref":"#/components/headers/RequestId"},"Gloom-Version":{"$ref":"#/components/headers/GloomVersion"},"X-Credits-Cost":{"$ref":"#/components/headers/CreditsCost"},"X-Credits-Remaining":{"$ref":"#/components/headers/CreditsRemaining"},"X-Plan":{"$ref":"#/components/headers/Plan"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimitLimit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimitRemaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimitReset"},"ETag":{"$ref":"#/components/headers/ETag"}}},"304":{"$ref":"#/components/responses/NotModified"},"400":{"$ref":"#/components/responses/Error400"},"401":{"$ref":"#/components/responses/Error401"},"402":{"$ref":"#/components/responses/Error402"},"403":{"$ref":"#/components/responses/Error403"},"404":{"$ref":"#/components/responses/Error404"},"429":{"$ref":"#/components/responses/Error429"},"503":{"$ref":"#/components/responses/Error503"}}}},"/v1/awards/{id}":{"get":{"operationId":"awards.detail","tags":["awards"],"summary":"Award evidence and revisions","description":"Reads the existing dataset service and needs a key on an account with a plan; every plan reads every live dataset in full. Cached market reads can refresh their source data. Unknown, empty and repeated parameters are rejected. History and coverage metadata are null when the stored service cannot establish them.","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","minLength":40,"maxLength":40,"pattern":"^[a-f0-9]{40}$"}},{"name":"revisionsCursor","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":1024,"pattern":"\\S"}},{"$ref":"#/components/parameters/GloomVersion"},{"$ref":"#/components/parameters/IfNoneMatch"}],"x-dataset":"awards","x-credit-cost":10,"x-credit-call-type":"evidence","x-credit-multiplier":2,"x-plans":["basic","desk","enterprise"],"x-sample-url":"/v1/datasets/awards/sample","responses":{"200":{"description":"Stored dataset response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DatasetResponse"}}},"headers":{"Request-Id":{"$ref":"#/components/headers/RequestId"},"Gloom-Version":{"$ref":"#/components/headers/GloomVersion"},"X-Credits-Cost":{"$ref":"#/components/headers/CreditsCost"},"X-Credits-Remaining":{"$ref":"#/components/headers/CreditsRemaining"},"X-Plan":{"$ref":"#/components/headers/Plan"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimitLimit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimitRemaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimitReset"},"ETag":{"$ref":"#/components/headers/ETag"}}},"304":{"$ref":"#/components/responses/NotModified"},"400":{"$ref":"#/components/responses/Error400"},"401":{"$ref":"#/components/responses/Error401"},"402":{"$ref":"#/components/responses/Error402"},"403":{"$ref":"#/components/responses/Error403"},"404":{"$ref":"#/components/responses/Error404"},"429":{"$ref":"#/components/responses/Error429"},"503":{"$ref":"#/components/responses/Error503"}}}},"/v1/kpis/{symbol}":{"get":{"operationId":"kpis.company","tags":["kpis-guidance"],"summary":"Cited company operating metrics","description":"Reads the existing dataset service and needs a key on an account with a plan; every plan reads every live dataset in full. Cached market reads can refresh their source data. A from or to parameter selects the history price; asOf requires Basic or above. Unknown, empty and repeated parameters are rejected. History and coverage metadata are null when the stored service cannot establish them.","parameters":[{"name":"symbol","in":"path","required":true,"schema":{"type":"string","minLength":1,"maxLength":32,"pattern":"^[A-Za-z0-9.:-]{1,32}$","description":"Company symbol; normalized to uppercase."}},{"name":"metric","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":80,"pattern":"^[a-z0-9_]{1,80}$"}},{"name":"basis","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":1024,"pattern":"\\S","enum":["reported","adjusted","constant_currency","organic"]}},{"name":"from","in":"query","required":false,"schema":{"type":"string","minLength":10,"maxLength":10,"pattern":"^\\d{4}-\\d{2}-\\d{2}$","format":"date","description":"Valid calendar date (YYYY-MM-DD). from must be on or before to."}},{"name":"to","in":"query","required":false,"schema":{"type":"string","minLength":10,"maxLength":10,"pattern":"^\\d{4}-\\d{2}-\\d{2}$","format":"date","description":"Valid calendar date (YYYY-MM-DD). from must be on or before to."}},{"name":"asOf","in":"query","required":false,"schema":{"type":"string","minLength":10,"maxLength":10,"pattern":"^\\d{4}-\\d{2}-\\d{2}$","format":"date","description":"Valid calendar date (YYYY-MM-DD). from must be on or before to."}},{"$ref":"#/components/parameters/GloomVersion"},{"$ref":"#/components/parameters/IfNoneMatch"}],"x-dataset":"kpis-guidance","x-credit-cost":2,"x-credit-call-type":"lookup","x-credit-multiplier":2,"x-credit-cost-history":4,"x-asof-plans":["basic","desk","enterprise"],"x-plans":["basic","desk","enterprise"],"x-sample-url":"/v1/datasets/kpis-guidance/sample","responses":{"200":{"description":"Stored dataset response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DatasetResponse"}}},"headers":{"Request-Id":{"$ref":"#/components/headers/RequestId"},"Gloom-Version":{"$ref":"#/components/headers/GloomVersion"},"X-Credits-Cost":{"$ref":"#/components/headers/CreditsCost"},"X-Credits-Remaining":{"$ref":"#/components/headers/CreditsRemaining"},"X-Plan":{"$ref":"#/components/headers/Plan"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimitLimit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimitRemaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimitReset"},"ETag":{"$ref":"#/components/headers/ETag"}}},"304":{"$ref":"#/components/responses/NotModified"},"400":{"$ref":"#/components/responses/Error400"},"401":{"$ref":"#/components/responses/Error401"},"402":{"$ref":"#/components/responses/Error402"},"403":{"$ref":"#/components/responses/Error403"},"404":{"$ref":"#/components/responses/Error404"},"429":{"$ref":"#/components/responses/Error429"},"503":{"$ref":"#/components/responses/Error503"}}}},"/v1/guidance/{symbol}":{"get":{"operationId":"guidance.company","tags":["kpis-guidance"],"summary":"Company guidance ranges and revisions","description":"Reads the existing dataset service and needs a key on an account with a plan; every plan reads every live dataset in full. Cached market reads can refresh their source data. A from or to parameter selects the history price; asOf requires Basic or above. Unknown, empty and repeated parameters are rejected. History and coverage metadata are null when the stored service cannot establish them.","parameters":[{"name":"symbol","in":"path","required":true,"schema":{"type":"string","minLength":1,"maxLength":32,"pattern":"^[A-Za-z0-9.:-]{1,32}$","description":"Company symbol; normalized to uppercase."}},{"name":"metric","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":80,"pattern":"^[a-z0-9_]{1,80}$"}},{"name":"basis","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":1024,"pattern":"\\S","enum":["reported","adjusted","constant_currency","organic"]}},{"name":"from","in":"query","required":false,"schema":{"type":"string","minLength":10,"maxLength":10,"pattern":"^\\d{4}-\\d{2}-\\d{2}$","format":"date","description":"Valid calendar date (YYYY-MM-DD). from must be on or before to."}},{"name":"to","in":"query","required":false,"schema":{"type":"string","minLength":10,"maxLength":10,"pattern":"^\\d{4}-\\d{2}-\\d{2}$","format":"date","description":"Valid calendar date (YYYY-MM-DD). from must be on or before to."}},{"name":"asOf","in":"query","required":false,"schema":{"type":"string","minLength":10,"maxLength":10,"pattern":"^\\d{4}-\\d{2}-\\d{2}$","format":"date","description":"Valid calendar date (YYYY-MM-DD). from must be on or before to."}},{"$ref":"#/components/parameters/GloomVersion"},{"$ref":"#/components/parameters/IfNoneMatch"}],"x-dataset":"kpis-guidance","x-credit-cost":2,"x-credit-call-type":"lookup","x-credit-multiplier":2,"x-credit-cost-history":4,"x-asof-plans":["basic","desk","enterprise"],"x-plans":["basic","desk","enterprise"],"x-sample-url":"/v1/datasets/kpis-guidance/sample","responses":{"200":{"description":"Stored dataset response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DatasetResponse"}}},"headers":{"Request-Id":{"$ref":"#/components/headers/RequestId"},"Gloom-Version":{"$ref":"#/components/headers/GloomVersion"},"X-Credits-Cost":{"$ref":"#/components/headers/CreditsCost"},"X-Credits-Remaining":{"$ref":"#/components/headers/CreditsRemaining"},"X-Plan":{"$ref":"#/components/headers/Plan"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimitLimit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimitRemaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimitReset"},"ETag":{"$ref":"#/components/headers/ETag"}}},"304":{"$ref":"#/components/responses/NotModified"},"400":{"$ref":"#/components/responses/Error400"},"401":{"$ref":"#/components/responses/Error401"},"402":{"$ref":"#/components/responses/Error402"},"403":{"$ref":"#/components/responses/Error403"},"404":{"$ref":"#/components/responses/Error404"},"429":{"$ref":"#/components/responses/Error429"},"503":{"$ref":"#/components/responses/Error503"}}}},"/v1/credit/screen":{"get":{"operationId":"credit.screen","tags":["credit-documents"],"summary":"Credit headroom and springing covenant screen","description":"Reads the existing dataset service and needs a key on an account with a plan; every plan reads every live dataset in full. Cached market reads can refresh their source data. Unknown, empty and repeated parameters are rejected. History and coverage metadata are null when the stored service cannot establish them.","parameters":[{"name":"headroomBelow","in":"query","required":false,"schema":{"type":"number","minimum":-10000,"maximum":10000}},{"name":"springingWithinMonths","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":120}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":500}},{"$ref":"#/components/parameters/GloomVersion"},{"$ref":"#/components/parameters/IfNoneMatch"}],"x-dataset":"credit-documents","x-credit-cost":8,"x-credit-call-type":"search","x-credit-multiplier":4,"x-plans":["basic","desk","enterprise"],"x-sample-url":"/v1/datasets/credit-documents/sample","responses":{"200":{"description":"Stored dataset response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DatasetResponse"}}},"headers":{"Request-Id":{"$ref":"#/components/headers/RequestId"},"Gloom-Version":{"$ref":"#/components/headers/GloomVersion"},"X-Credits-Cost":{"$ref":"#/components/headers/CreditsCost"},"X-Credits-Remaining":{"$ref":"#/components/headers/CreditsRemaining"},"X-Plan":{"$ref":"#/components/headers/Plan"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimitLimit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimitRemaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimitReset"},"ETag":{"$ref":"#/components/headers/ETag"}}},"304":{"$ref":"#/components/responses/NotModified"},"400":{"$ref":"#/components/responses/Error400"},"401":{"$ref":"#/components/responses/Error401"},"402":{"$ref":"#/components/responses/Error402"},"403":{"$ref":"#/components/responses/Error403"},"404":{"$ref":"#/components/responses/Error404"},"429":{"$ref":"#/components/responses/Error429"},"503":{"$ref":"#/components/responses/Error503"}}}},"/v1/credit/{symbol}":{"get":{"operationId":"credit.documents","tags":["credit-documents"],"summary":"Credit facilities, covenants and maturities","description":"Reads the existing dataset service and needs a key on an account with a plan; every plan reads every live dataset in full. Cached market reads can refresh their source data. Unknown, empty and repeated parameters are rejected. History and coverage metadata are null when the stored service cannot establish them.","parameters":[{"name":"symbol","in":"path","required":true,"schema":{"type":"string","minLength":1,"maxLength":32,"pattern":"^[A-Za-z0-9.:-]{1,32}$","description":"Company symbol; normalized to uppercase."}},{"$ref":"#/components/parameters/GloomVersion"},{"$ref":"#/components/parameters/IfNoneMatch"}],"x-dataset":"credit-documents","x-credit-cost":8,"x-credit-call-type":"history","x-credit-multiplier":4,"x-plans":["basic","desk","enterprise"],"x-sample-url":"/v1/datasets/credit-documents/sample","responses":{"200":{"description":"Stored dataset response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DatasetResponse"}}},"headers":{"Request-Id":{"$ref":"#/components/headers/RequestId"},"Gloom-Version":{"$ref":"#/components/headers/GloomVersion"},"X-Credits-Cost":{"$ref":"#/components/headers/CreditsCost"},"X-Credits-Remaining":{"$ref":"#/components/headers/CreditsRemaining"},"X-Plan":{"$ref":"#/components/headers/Plan"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimitLimit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimitRemaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimitReset"},"ETag":{"$ref":"#/components/headers/ETag"}}},"304":{"$ref":"#/components/responses/NotModified"},"400":{"$ref":"#/components/responses/Error400"},"401":{"$ref":"#/components/responses/Error401"},"402":{"$ref":"#/components/responses/Error402"},"403":{"$ref":"#/components/responses/Error403"},"404":{"$ref":"#/components/responses/Error404"},"429":{"$ref":"#/components/responses/Error429"},"503":{"$ref":"#/components/responses/Error503"}}}},"/v1/credit/{symbol}/instruments/{id}":{"get":{"operationId":"credit.instrument","tags":["credit-documents"],"summary":"Credit instrument evidence","description":"Reads the existing dataset service and needs a key on an account with a plan; every plan reads every live dataset in full. Cached market reads can refresh their source data. Unknown, empty and repeated parameters are rejected. History and coverage metadata are null when the stored service cannot establish them.","parameters":[{"name":"symbol","in":"path","required":true,"schema":{"type":"string","minLength":1,"maxLength":32,"pattern":"^[A-Za-z0-9.:-]{1,32}$","description":"Company symbol; normalized to uppercase."}},{"name":"id","in":"path","required":true,"schema":{"type":"string","minLength":36,"maxLength":36,"pattern":"^[0-9a-fA-F-]{36}$"}},{"$ref":"#/components/parameters/GloomVersion"},{"$ref":"#/components/parameters/IfNoneMatch"}],"x-dataset":"credit-documents","x-credit-cost":20,"x-credit-call-type":"evidence","x-credit-multiplier":4,"x-plans":["basic","desk","enterprise"],"x-sample-url":"/v1/datasets/credit-documents/sample","responses":{"200":{"description":"Stored dataset response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DatasetResponse"}}},"headers":{"Request-Id":{"$ref":"#/components/headers/RequestId"},"Gloom-Version":{"$ref":"#/components/headers/GloomVersion"},"X-Credits-Cost":{"$ref":"#/components/headers/CreditsCost"},"X-Credits-Remaining":{"$ref":"#/components/headers/CreditsRemaining"},"X-Plan":{"$ref":"#/components/headers/Plan"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimitLimit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimitRemaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimitReset"},"ETag":{"$ref":"#/components/headers/ETag"}}},"304":{"$ref":"#/components/responses/NotModified"},"400":{"$ref":"#/components/responses/Error400"},"401":{"$ref":"#/components/responses/Error401"},"402":{"$ref":"#/components/responses/Error402"},"403":{"$ref":"#/components/responses/Error403"},"404":{"$ref":"#/components/responses/Error404"},"429":{"$ref":"#/components/responses/Error429"},"503":{"$ref":"#/components/responses/Error503"}}}},"/v1/exec-pay/{symbol}":{"get":{"operationId":"exec-pay.list","tags":["exec-pay"],"summary":"Available executive compensation filings","description":"Reads the existing dataset service and needs a key on an account with a plan; every plan reads every live dataset in full. Cached market reads can refresh their source data. Unknown, empty and repeated parameters are rejected. History and coverage metadata are null when the stored service cannot establish them.","parameters":[{"name":"symbol","in":"path","required":true,"schema":{"type":"string","minLength":1,"maxLength":32,"pattern":"^[A-Za-z0-9.:-]{1,32}$","description":"Company symbol; normalized to uppercase."}},{"$ref":"#/components/parameters/GloomVersion"},{"$ref":"#/components/parameters/IfNoneMatch"}],"x-dataset":"exec-pay","x-credit-cost":2,"x-credit-call-type":"lookup","x-credit-multiplier":2,"x-plans":["basic","desk","enterprise"],"x-sample-url":"/v1/datasets/exec-pay/sample","responses":{"200":{"description":"Stored dataset response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DatasetResponse"}}},"headers":{"Request-Id":{"$ref":"#/components/headers/RequestId"},"Gloom-Version":{"$ref":"#/components/headers/GloomVersion"},"X-Credits-Cost":{"$ref":"#/components/headers/CreditsCost"},"X-Credits-Remaining":{"$ref":"#/components/headers/CreditsRemaining"},"X-Plan":{"$ref":"#/components/headers/Plan"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimitLimit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimitRemaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimitReset"},"ETag":{"$ref":"#/components/headers/ETag"}}},"304":{"$ref":"#/components/responses/NotModified"},"400":{"$ref":"#/components/responses/Error400"},"401":{"$ref":"#/components/responses/Error401"},"402":{"$ref":"#/components/responses/Error402"},"403":{"$ref":"#/components/responses/Error403"},"404":{"$ref":"#/components/responses/Error404"},"429":{"$ref":"#/components/responses/Error429"},"503":{"$ref":"#/components/responses/Error503"}}}},"/v1/exec-pay/{symbol}/{year}":{"get":{"operationId":"exec-pay.year","tags":["exec-pay"],"summary":"Executive compensation for a filing year","description":"Reads the existing dataset service and needs a key on an account with a plan; every plan reads every live dataset in full. Cached market reads can refresh their source data. Unknown, empty and repeated parameters are rejected. History and coverage metadata are null when the stored service cannot establish them.","parameters":[{"name":"symbol","in":"path","required":true,"schema":{"type":"string","minLength":1,"maxLength":32,"pattern":"^[A-Za-z0-9.:-]{1,32}$","description":"Company symbol; normalized to uppercase."}},{"name":"year","in":"path","required":true,"schema":{"type":"integer","minimum":1900,"maximum":2100}},{"$ref":"#/components/parameters/GloomVersion"},{"$ref":"#/components/parameters/IfNoneMatch"}],"x-dataset":"exec-pay","x-credit-cost":10,"x-credit-call-type":"evidence","x-credit-multiplier":2,"x-plans":["basic","desk","enterprise"],"x-sample-url":"/v1/datasets/exec-pay/sample","responses":{"200":{"description":"Stored dataset response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DatasetResponse"}}},"headers":{"Request-Id":{"$ref":"#/components/headers/RequestId"},"Gloom-Version":{"$ref":"#/components/headers/GloomVersion"},"X-Credits-Cost":{"$ref":"#/components/headers/CreditsCost"},"X-Credits-Remaining":{"$ref":"#/components/headers/CreditsRemaining"},"X-Plan":{"$ref":"#/components/headers/Plan"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimitLimit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimitRemaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimitReset"},"ETag":{"$ref":"#/components/headers/ETag"}}},"304":{"$ref":"#/components/responses/NotModified"},"400":{"$ref":"#/components/responses/Error400"},"401":{"$ref":"#/components/responses/Error401"},"402":{"$ref":"#/components/responses/Error402"},"403":{"$ref":"#/components/responses/Error403"},"404":{"$ref":"#/components/responses/Error404"},"429":{"$ref":"#/components/responses/Error429"},"503":{"$ref":"#/components/responses/Error503"}}}},"/v1/risk-factors/{symbol}":{"get":{"operationId":"risk-factors.list","tags":["risk-factors"],"summary":"Available annual risk-factor filings","description":"Reads the existing dataset service and needs a key on an account with a plan; every plan reads every live dataset in full. Cached market reads can refresh their source data. Unknown, empty and repeated parameters are rejected. History and coverage metadata are null when the stored service cannot establish them.","parameters":[{"name":"symbol","in":"path","required":true,"schema":{"type":"string","minLength":1,"maxLength":32,"pattern":"^[A-Za-z0-9.:-]{1,32}$","description":"Company symbol; normalized to uppercase."}},{"$ref":"#/components/parameters/GloomVersion"},{"$ref":"#/components/parameters/IfNoneMatch"}],"x-dataset":"risk-factors","x-credit-cost":2,"x-credit-call-type":"lookup","x-credit-multiplier":2,"x-plans":["basic","desk","enterprise"],"x-sample-url":"/v1/datasets/risk-factors/sample","responses":{"200":{"description":"Stored dataset response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DatasetResponse"}}},"headers":{"Request-Id":{"$ref":"#/components/headers/RequestId"},"Gloom-Version":{"$ref":"#/components/headers/GloomVersion"},"X-Credits-Cost":{"$ref":"#/components/headers/CreditsCost"},"X-Credits-Remaining":{"$ref":"#/components/headers/CreditsRemaining"},"X-Plan":{"$ref":"#/components/headers/Plan"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimitLimit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimitRemaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimitReset"},"ETag":{"$ref":"#/components/headers/ETag"}}},"304":{"$ref":"#/components/responses/NotModified"},"400":{"$ref":"#/components/responses/Error400"},"401":{"$ref":"#/components/responses/Error401"},"402":{"$ref":"#/components/responses/Error402"},"403":{"$ref":"#/components/responses/Error403"},"404":{"$ref":"#/components/responses/Error404"},"429":{"$ref":"#/components/responses/Error429"},"503":{"$ref":"#/components/responses/Error503"}}}},"/v1/risk-factors/{symbol}/{year}":{"get":{"operationId":"risk-factors.year","tags":["risk-factors"],"summary":"Risk factors and annual differences","description":"Reads the existing dataset service and needs a key on an account with a plan; every plan reads every live dataset in full. Cached market reads can refresh their source data. Unknown, empty and repeated parameters are rejected. History and coverage metadata are null when the stored service cannot establish them.","parameters":[{"name":"symbol","in":"path","required":true,"schema":{"type":"string","minLength":1,"maxLength":32,"pattern":"^[A-Za-z0-9.:-]{1,32}$","description":"Company symbol; normalized to uppercase."}},{"name":"year","in":"path","required":true,"schema":{"type":"integer","minimum":1900,"maximum":2100}},{"$ref":"#/components/parameters/GloomVersion"},{"$ref":"#/components/parameters/IfNoneMatch"}],"x-dataset":"risk-factors","x-credit-cost":10,"x-credit-call-type":"evidence","x-credit-multiplier":2,"x-plans":["basic","desk","enterprise"],"x-sample-url":"/v1/datasets/risk-factors/sample","responses":{"200":{"description":"Stored dataset response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DatasetResponse"}}},"headers":{"Request-Id":{"$ref":"#/components/headers/RequestId"},"Gloom-Version":{"$ref":"#/components/headers/GloomVersion"},"X-Credits-Cost":{"$ref":"#/components/headers/CreditsCost"},"X-Credits-Remaining":{"$ref":"#/components/headers/CreditsRemaining"},"X-Plan":{"$ref":"#/components/headers/Plan"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimitLimit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimitRemaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimitReset"},"ETag":{"$ref":"#/components/headers/ETag"}}},"304":{"$ref":"#/components/responses/NotModified"},"400":{"$ref":"#/components/responses/Error400"},"401":{"$ref":"#/components/responses/Error401"},"402":{"$ref":"#/components/responses/Error402"},"403":{"$ref":"#/components/responses/Error403"},"404":{"$ref":"#/components/responses/Error404"},"429":{"$ref":"#/components/responses/Error429"},"503":{"$ref":"#/components/responses/Error503"}}}},"/v1/events/{symbol}":{"get":{"operationId":"events.list","tags":["events"],"summary":"Item-classified SEC 8-K events","description":"Reads the existing dataset service and needs a key on an account with a plan; every plan reads every live dataset in full. Cached market reads can refresh their source data. Unknown, empty and repeated parameters are rejected. History and coverage metadata are null when the stored service cannot establish them.","parameters":[{"name":"symbol","in":"path","required":true,"schema":{"type":"string","minLength":1,"maxLength":32,"pattern":"^[A-Za-z0-9.:-]{1,32}$","description":"Company symbol; normalized to uppercase."}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":200}},{"$ref":"#/components/parameters/GloomVersion"},{"$ref":"#/components/parameters/IfNoneMatch"}],"x-dataset":"events","x-credit-cost":2,"x-credit-call-type":"search","x-credit-multiplier":1,"x-plans":["basic","desk","enterprise"],"x-sample-url":"/v1/datasets/events/sample","responses":{"200":{"description":"Stored dataset response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DatasetResponse"}}},"headers":{"Request-Id":{"$ref":"#/components/headers/RequestId"},"Gloom-Version":{"$ref":"#/components/headers/GloomVersion"},"X-Credits-Cost":{"$ref":"#/components/headers/CreditsCost"},"X-Credits-Remaining":{"$ref":"#/components/headers/CreditsRemaining"},"X-Plan":{"$ref":"#/components/headers/Plan"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimitLimit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimitRemaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimitReset"},"ETag":{"$ref":"#/components/headers/ETag"}}},"304":{"$ref":"#/components/responses/NotModified"},"400":{"$ref":"#/components/responses/Error400"},"401":{"$ref":"#/components/responses/Error401"},"402":{"$ref":"#/components/responses/Error402"},"403":{"$ref":"#/components/responses/Error403"},"404":{"$ref":"#/components/responses/Error404"},"429":{"$ref":"#/components/responses/Error429"},"503":{"$ref":"#/components/responses/Error503"}}}},"/v1/revenue-breakdown/{symbol}":{"get":{"operationId":"revenue-breakdown.get","tags":["revenue-breakdown"],"summary":"SEC product, segment and geographic revenue","description":"Reads the existing dataset service and needs a key on an account with a plan; every plan reads every live dataset in full. Cached market reads can refresh their source data. Unknown, empty and repeated parameters are rejected. History and coverage metadata are null when the stored service cannot establish them.","parameters":[{"name":"symbol","in":"path","required":true,"schema":{"type":"string","minLength":1,"maxLength":32,"pattern":"^[A-Za-z0-9.:-]{1,32}$","description":"Company symbol; normalized to uppercase."}},{"name":"view","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":1024,"pattern":"\\S","enum":["product","segment","region"]}},{"$ref":"#/components/parameters/GloomVersion"},{"$ref":"#/components/parameters/IfNoneMatch"}],"x-dataset":"revenue-breakdown","x-credit-cost":4,"x-credit-call-type":"history","x-credit-multiplier":2,"x-plans":["basic","desk","enterprise"],"x-sample-url":"/v1/datasets/revenue-breakdown/sample","responses":{"200":{"description":"Stored dataset response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DatasetResponse"}}},"headers":{"Request-Id":{"$ref":"#/components/headers/RequestId"},"Gloom-Version":{"$ref":"#/components/headers/GloomVersion"},"X-Credits-Cost":{"$ref":"#/components/headers/CreditsCost"},"X-Credits-Remaining":{"$ref":"#/components/headers/CreditsRemaining"},"X-Plan":{"$ref":"#/components/headers/Plan"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimitLimit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimitRemaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimitReset"},"ETag":{"$ref":"#/components/headers/ETag"}}},"304":{"$ref":"#/components/responses/NotModified"},"400":{"$ref":"#/components/responses/Error400"},"401":{"$ref":"#/components/responses/Error401"},"402":{"$ref":"#/components/responses/Error402"},"403":{"$ref":"#/components/responses/Error403"},"404":{"$ref":"#/components/responses/Error404"},"429":{"$ref":"#/components/responses/Error429"},"503":{"$ref":"#/components/responses/Error503"}}}},"/v1/debt-maturities/{symbol}":{"get":{"operationId":"debt-maturities.get","tags":["debt-maturities"],"summary":"SEC XBRL debt maturity schedule","description":"Reads the existing dataset service and needs a key on an account with a plan; every plan reads every live dataset in full. Cached market reads can refresh their source data. Unknown, empty and repeated parameters are rejected. History and coverage metadata are null when the stored service cannot establish them.","parameters":[{"name":"symbol","in":"path","required":true,"schema":{"type":"string","minLength":1,"maxLength":32,"pattern":"^[A-Za-z0-9.:-]{1,32}$","description":"Company symbol; normalized to uppercase."}},{"$ref":"#/components/parameters/GloomVersion"},{"$ref":"#/components/parameters/IfNoneMatch"}],"x-dataset":"debt-maturities","x-credit-cost":4,"x-credit-call-type":"history","x-credit-multiplier":2,"x-plans":["basic","desk","enterprise"],"x-sample-url":"/v1/datasets/debt-maturities/sample","responses":{"200":{"description":"Stored dataset response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DatasetResponse"}}},"headers":{"Request-Id":{"$ref":"#/components/headers/RequestId"},"Gloom-Version":{"$ref":"#/components/headers/GloomVersion"},"X-Credits-Cost":{"$ref":"#/components/headers/CreditsCost"},"X-Credits-Remaining":{"$ref":"#/components/headers/CreditsRemaining"},"X-Plan":{"$ref":"#/components/headers/Plan"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimitLimit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimitRemaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimitReset"},"ETag":{"$ref":"#/components/headers/ETag"}}},"304":{"$ref":"#/components/responses/NotModified"},"400":{"$ref":"#/components/responses/Error400"},"401":{"$ref":"#/components/responses/Error401"},"402":{"$ref":"#/components/responses/Error402"},"403":{"$ref":"#/components/responses/Error403"},"404":{"$ref":"#/components/responses/Error404"},"429":{"$ref":"#/components/responses/Error429"},"503":{"$ref":"#/components/responses/Error503"}}}},"/v1/catalysts":{"get":{"operationId":"catalysts.list","tags":["catalysts"],"summary":"Government-sourced catalysts and deadlines","description":"Reads the existing dataset service and needs a key on an account with a plan; every plan reads every live dataset in full. Cached market reads can refresh their source data. Unknown, empty and repeated parameters are rejected. History and coverage metadata are null when the stored service cannot establish them.","parameters":[{"name":"symbol","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":32,"pattern":"^[A-Za-z0-9.:-]{1,32}$","description":"Company symbol; normalized to uppercase."}},{"name":"agency","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":1024,"pattern":"\\S"}},{"name":"country","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":1024,"pattern":"\\S"}},{"name":"sector","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":1024,"pattern":"\\S"}},{"name":"status","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":1024,"pattern":"\\S"}},{"name":"source","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":1024,"pattern":"\\S"}},{"name":"search","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":1024,"pattern":"\\S"}},{"name":"from","in":"query","required":false,"schema":{"type":"string","minLength":10,"maxLength":10,"pattern":"^\\d{4}-\\d{2}-\\d{2}$","format":"date","description":"Valid calendar date (YYYY-MM-DD). from must be on or before to."}},{"name":"to","in":"query","required":false,"schema":{"type":"string","minLength":10,"maxLength":10,"pattern":"^\\d{4}-\\d{2}-\\d{2}$","format":"date","description":"Valid calendar date (YYYY-MM-DD). from must be on or before to."}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":200,"default":100}},{"name":"cursor","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":120,"pattern":"^[A-Za-z0-9_-]+$","description":"Opaque: meta.page.nextCursor of the previous page. Bound to this route and query."}},{"name":"type","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":1024,"pattern":"\\S","enum":["regulatory","clinical","litigation","antitrust","recall","sanctions","export_control","tariff","rulemaking","approval","advisory","advisory-meeting","pdufa"]}},{"name":"dateField","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":1024,"pattern":"\\S","enum":["announced","effective","deadline","any","observed"]}},{"name":"upcoming","in":"query","required":false,"schema":{"type":"boolean"}},{"name":"changed","in":"query","required":false,"schema":{"type":"boolean"}},{"name":"litigation","in":"query","required":false,"schema":{"type":"boolean"}},{"$ref":"#/components/parameters/GloomVersion"},{"$ref":"#/components/parameters/IfNoneMatch"}],"x-dataset":"catalysts","x-credit-cost":2,"x-credit-call-type":"search","x-credit-multiplier":1,"x-plans":["basic","desk","enterprise"],"x-sample-url":"/v1/datasets/catalysts/sample","responses":{"200":{"description":"Stored dataset response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DatasetResponse"}}},"headers":{"Request-Id":{"$ref":"#/components/headers/RequestId"},"Gloom-Version":{"$ref":"#/components/headers/GloomVersion"},"X-Credits-Cost":{"$ref":"#/components/headers/CreditsCost"},"X-Credits-Remaining":{"$ref":"#/components/headers/CreditsRemaining"},"X-Plan":{"$ref":"#/components/headers/Plan"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimitLimit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimitRemaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimitReset"},"ETag":{"$ref":"#/components/headers/ETag"}}},"304":{"$ref":"#/components/responses/NotModified"},"400":{"$ref":"#/components/responses/Error400"},"401":{"$ref":"#/components/responses/Error401"},"402":{"$ref":"#/components/responses/Error402"},"403":{"$ref":"#/components/responses/Error403"},"404":{"$ref":"#/components/responses/Error404"},"429":{"$ref":"#/components/responses/Error429"},"503":{"$ref":"#/components/responses/Error503"}}}},"/v1/litigation/{symbol}":{"get":{"operationId":"catalysts.litigation","tags":["catalysts"],"summary":"Company litigation and regulatory events","description":"Reads the existing dataset service and needs a key on an account with a plan; every plan reads every live dataset in full. Cached market reads can refresh their source data. Unknown, empty and repeated parameters are rejected. History and coverage metadata are null when the stored service cannot establish them.","parameters":[{"name":"symbol","in":"path","required":true,"schema":{"type":"string","minLength":1,"maxLength":32,"pattern":"^[A-Za-z0-9.:-]{1,32}$","description":"Company symbol; normalized to uppercase."}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":200,"default":100}},{"name":"cursor","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":120,"pattern":"^[A-Za-z0-9_-]+$","description":"Opaque: meta.page.nextCursor of the previous page. Bound to this route and query."}},{"$ref":"#/components/parameters/GloomVersion"},{"$ref":"#/components/parameters/IfNoneMatch"}],"x-dataset":"catalysts","x-credit-cost":2,"x-credit-call-type":"search","x-credit-multiplier":1,"x-plans":["basic","desk","enterprise"],"x-sample-url":"/v1/datasets/catalysts/sample","responses":{"200":{"description":"Stored dataset response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DatasetResponse"}}},"headers":{"Request-Id":{"$ref":"#/components/headers/RequestId"},"Gloom-Version":{"$ref":"#/components/headers/GloomVersion"},"X-Credits-Cost":{"$ref":"#/components/headers/CreditsCost"},"X-Credits-Remaining":{"$ref":"#/components/headers/CreditsRemaining"},"X-Plan":{"$ref":"#/components/headers/Plan"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimitLimit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimitRemaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimitReset"},"ETag":{"$ref":"#/components/headers/ETag"}}},"304":{"$ref":"#/components/responses/NotModified"},"400":{"$ref":"#/components/responses/Error400"},"401":{"$ref":"#/components/responses/Error401"},"402":{"$ref":"#/components/responses/Error402"},"403":{"$ref":"#/components/responses/Error403"},"404":{"$ref":"#/components/responses/Error404"},"429":{"$ref":"#/components/responses/Error429"},"503":{"$ref":"#/components/responses/Error503"}}}},"/v1/catalysts/events/{id}":{"get":{"operationId":"catalysts.event","tags":["catalysts"],"summary":"Catalyst evidence and revisions","description":"Reads the existing dataset service and needs a key on an account with a plan; every plan reads every live dataset in full. Cached market reads can refresh their source data. Unknown, empty and repeated parameters are rejected. History and coverage metadata are null when the stored service cannot establish them.","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","minLength":1,"maxLength":1024,"pattern":"\\S"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":200,"default":100}},{"name":"cursor","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":120,"pattern":"^[A-Za-z0-9_-]+$","description":"Opaque: meta.page.nextCursor of the previous page. Bound to this route and query."}},{"$ref":"#/components/parameters/GloomVersion"},{"$ref":"#/components/parameters/IfNoneMatch"}],"x-dataset":"catalysts","x-credit-cost":5,"x-credit-call-type":"evidence","x-credit-multiplier":1,"x-plans":["basic","desk","enterprise"],"x-sample-url":"/v1/datasets/catalysts/sample","responses":{"200":{"description":"Stored dataset response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DatasetResponse"}}},"headers":{"Request-Id":{"$ref":"#/components/headers/RequestId"},"Gloom-Version":{"$ref":"#/components/headers/GloomVersion"},"X-Credits-Cost":{"$ref":"#/components/headers/CreditsCost"},"X-Credits-Remaining":{"$ref":"#/components/headers/CreditsRemaining"},"X-Plan":{"$ref":"#/components/headers/Plan"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimitLimit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimitRemaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimitReset"},"ETag":{"$ref":"#/components/headers/ETag"}}},"304":{"$ref":"#/components/responses/NotModified"},"400":{"$ref":"#/components/responses/Error400"},"401":{"$ref":"#/components/responses/Error401"},"402":{"$ref":"#/components/responses/Error402"},"403":{"$ref":"#/components/responses/Error403"},"404":{"$ref":"#/components/responses/Error404"},"429":{"$ref":"#/components/responses/Error429"},"503":{"$ref":"#/components/responses/Error503"}}}},"/v1/catalysts/changes":{"get":{"operationId":"catalysts.changes","tags":["catalysts"],"summary":"Observed catalyst revisions","description":"Reads the existing dataset service and needs a key on an account with a plan; every plan reads every live dataset in full. Cached market reads can refresh their source data. Unknown, empty and repeated parameters are rejected. History and coverage metadata are null when the stored service cannot establish them.","parameters":[{"name":"cursor","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":19,"pattern":"^\\d{1,19}$"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":200}},{"name":"since","in":"query","required":true,"schema":{"type":"string","minLength":1,"maxLength":35,"pattern":"^\\d{4}-\\d{2}-\\d{2}T(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d{1,6})?(?:Z|[+-](?:[01]\\d|2[0-3]):[0-5]\\d)$","format":"date-time"}},{"$ref":"#/components/parameters/GloomVersion"},{"$ref":"#/components/parameters/IfNoneMatch"}],"x-dataset":"catalysts","x-credit-cost":1,"x-credit-call-type":"change","x-credit-multiplier":1,"x-plans":["basic","desk","enterprise"],"x-sample-url":"/v1/datasets/catalysts/sample","responses":{"200":{"description":"Stored dataset response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DatasetResponse"}}},"headers":{"Request-Id":{"$ref":"#/components/headers/RequestId"},"Gloom-Version":{"$ref":"#/components/headers/GloomVersion"},"X-Credits-Cost":{"$ref":"#/components/headers/CreditsCost"},"X-Credits-Remaining":{"$ref":"#/components/headers/CreditsRemaining"},"X-Plan":{"$ref":"#/components/headers/Plan"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimitLimit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimitRemaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimitReset"},"ETag":{"$ref":"#/components/headers/ETag"}}},"304":{"$ref":"#/components/responses/NotModified"},"400":{"$ref":"#/components/responses/Error400"},"401":{"$ref":"#/components/responses/Error401"},"402":{"$ref":"#/components/responses/Error402"},"403":{"$ref":"#/components/responses/Error403"},"404":{"$ref":"#/components/responses/Error404"},"429":{"$ref":"#/components/responses/Error429"},"503":{"$ref":"#/components/responses/Error503"}}}},"/v1/sec/filings":{"get":{"operationId":"sec.filings","tags":["sec"],"summary":"SEC filing lists","description":"Reads the existing dataset service and needs a key on an account with a plan; every plan reads every live dataset in full. Cached market reads can refresh their source data. Unknown, empty and repeated parameters are rejected. History and coverage metadata are null when the stored service cannot establish them.","parameters":[{"name":"limit","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":50,"default":50}},{"name":"cursor","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":120,"pattern":"^[A-Za-z0-9_-]+$","description":"Opaque: meta.page.nextCursor of the previous page. Bound to this route and query. Pages up to 5,000 rows deep."}},{"name":"ticker","in":"query","required":true,"schema":{"type":"string","minLength":1,"maxLength":32,"pattern":"^[A-Za-z0-9.:-]{1,32}$","description":"Company symbol; normalized to uppercase."}},{"$ref":"#/components/parameters/GloomVersion"},{"$ref":"#/components/parameters/IfNoneMatch"}],"x-dataset":"sec","x-credit-cost":1,"x-credit-call-type":"lookup","x-credit-multiplier":1,"x-plans":["basic","desk","enterprise"],"x-sample-url":"/v1/datasets/sec/sample","responses":{"200":{"description":"Stored dataset response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DatasetResponse"}}},"headers":{"Request-Id":{"$ref":"#/components/headers/RequestId"},"Gloom-Version":{"$ref":"#/components/headers/GloomVersion"},"X-Credits-Cost":{"$ref":"#/components/headers/CreditsCost"},"X-Credits-Remaining":{"$ref":"#/components/headers/CreditsRemaining"},"X-Plan":{"$ref":"#/components/headers/Plan"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimitLimit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimitRemaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimitReset"},"ETag":{"$ref":"#/components/headers/ETag"}}},"304":{"$ref":"#/components/responses/NotModified"},"400":{"$ref":"#/components/responses/Error400"},"401":{"$ref":"#/components/responses/Error401"},"402":{"$ref":"#/components/responses/Error402"},"403":{"$ref":"#/components/responses/Error403"},"404":{"$ref":"#/components/responses/Error404"},"429":{"$ref":"#/components/responses/Error429"},"503":{"$ref":"#/components/responses/Error503"}}}},"/v1/sec/filing/documents":{"get":{"operationId":"sec.documents","tags":["sec"],"summary":"Documents within a SEC filing","description":"Reads the existing dataset service and needs a key on an account with a plan; every plan reads every live dataset in full. Cached market reads can refresh their source data. Unknown, empty and repeated parameters are rejected. History and coverage metadata are null when the stored service cannot establish them.","parameters":[{"name":"cik","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":10,"pattern":"^[0-9]{1,10}$"}},{"name":"accession","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":20,"pattern":"^[0-9]{10}-[0-9]{2}-[0-9]{6}$"}},{"name":"form","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":1024,"pattern":"\\S"}},{"name":"primaryDocument","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":1024,"pattern":"\\S"}},{"name":"filingUrl","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":1024,"pattern":"\\S"}},{"$ref":"#/components/parameters/GloomVersion"},{"$ref":"#/components/parameters/IfNoneMatch"}],"x-dataset":"sec","x-credit-cost":1,"x-credit-call-type":"lookup","x-credit-multiplier":1,"x-plans":["basic","desk","enterprise"],"x-sample-url":"/v1/datasets/sec/sample","responses":{"200":{"description":"Stored dataset response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DatasetResponse"}}},"headers":{"Request-Id":{"$ref":"#/components/headers/RequestId"},"Gloom-Version":{"$ref":"#/components/headers/GloomVersion"},"X-Credits-Cost":{"$ref":"#/components/headers/CreditsCost"},"X-Credits-Remaining":{"$ref":"#/components/headers/CreditsRemaining"},"X-Plan":{"$ref":"#/components/headers/Plan"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimitLimit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimitRemaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimitReset"},"ETag":{"$ref":"#/components/headers/ETag"}}},"304":{"$ref":"#/components/responses/NotModified"},"400":{"$ref":"#/components/responses/Error400"},"401":{"$ref":"#/components/responses/Error401"},"402":{"$ref":"#/components/responses/Error402"},"403":{"$ref":"#/components/responses/Error403"},"404":{"$ref":"#/components/responses/Error404"},"429":{"$ref":"#/components/responses/Error429"},"503":{"$ref":"#/components/responses/Error503"}}}},"/v1/sec/filing/content":{"get":{"operationId":"sec.content","tags":["sec"],"summary":"SEC filing document content","description":"Reads the existing dataset service and needs a key on an account with a plan; every plan reads every live dataset in full. Cached market reads can refresh their source data. Unknown, empty and repeated parameters are rejected. History and coverage metadata are null when the stored service cannot establish them.","parameters":[{"name":"cik","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":10,"pattern":"^[0-9]{1,10}$"}},{"name":"accession","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":20,"pattern":"^[0-9]{10}-[0-9]{2}-[0-9]{6}$"}},{"name":"form","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":1024,"pattern":"\\S"}},{"name":"primaryDocument","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":1024,"pattern":"\\S"}},{"name":"primaryDocumentUrl","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":1024,"pattern":"\\S"}},{"name":"filingUrl","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":1024,"pattern":"\\S"}},{"$ref":"#/components/parameters/GloomVersion"},{"$ref":"#/components/parameters/IfNoneMatch"}],"x-dataset":"sec","x-credit-cost":5,"x-credit-call-type":"evidence","x-credit-multiplier":1,"x-plans":["basic","desk","enterprise"],"x-sample-url":"/v1/datasets/sec/sample","responses":{"200":{"description":"Stored dataset response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DatasetResponse"}}},"headers":{"Request-Id":{"$ref":"#/components/headers/RequestId"},"Gloom-Version":{"$ref":"#/components/headers/GloomVersion"},"X-Credits-Cost":{"$ref":"#/components/headers/CreditsCost"},"X-Credits-Remaining":{"$ref":"#/components/headers/CreditsRemaining"},"X-Plan":{"$ref":"#/components/headers/Plan"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimitLimit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimitRemaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimitReset"},"ETag":{"$ref":"#/components/headers/ETag"}}},"304":{"$ref":"#/components/responses/NotModified"},"400":{"$ref":"#/components/responses/Error400"},"401":{"$ref":"#/components/responses/Error401"},"402":{"$ref":"#/components/responses/Error402"},"403":{"$ref":"#/components/responses/Error403"},"404":{"$ref":"#/components/responses/Error404"},"429":{"$ref":"#/components/responses/Error429"},"503":{"$ref":"#/components/responses/Error503"}}}},"/v1/sec/insiders/{symbol}":{"get":{"operationId":"sec.insiders","tags":["sec"],"summary":"Form 4 insider transactions from filing content","description":"Reads the existing dataset service and needs a key on an account with a plan; every plan reads every live dataset in full. Cached market reads can refresh their source data. Unknown, empty and repeated parameters are rejected. History and coverage metadata are null when the stored service cannot establish them.","parameters":[{"name":"symbol","in":"path","required":true,"schema":{"type":"string","minLength":1,"maxLength":32,"pattern":"^[A-Za-z0-9.:-]{1,32}$","description":"Company symbol; normalized to uppercase."}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":50}},{"$ref":"#/components/parameters/GloomVersion"},{"$ref":"#/components/parameters/IfNoneMatch"}],"x-dataset":"sec","x-credit-cost":25,"x-credit-call-type":"bulk","x-credit-multiplier":1,"x-plans":["basic","desk","enterprise"],"x-sample-url":"/v1/datasets/sec/sample","responses":{"200":{"description":"Stored dataset response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DatasetResponse"}}},"headers":{"Request-Id":{"$ref":"#/components/headers/RequestId"},"Gloom-Version":{"$ref":"#/components/headers/GloomVersion"},"X-Credits-Cost":{"$ref":"#/components/headers/CreditsCost"},"X-Credits-Remaining":{"$ref":"#/components/headers/CreditsRemaining"},"X-Plan":{"$ref":"#/components/headers/Plan"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimitLimit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimitRemaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimitReset"},"ETag":{"$ref":"#/components/headers/ETag"}}},"304":{"$ref":"#/components/responses/NotModified"},"400":{"$ref":"#/components/responses/Error400"},"401":{"$ref":"#/components/responses/Error401"},"402":{"$ref":"#/components/responses/Error402"},"403":{"$ref":"#/components/responses/Error403"},"404":{"$ref":"#/components/responses/Error404"},"429":{"$ref":"#/components/responses/Error429"},"503":{"$ref":"#/components/responses/Error503"}}}},"/v1/sec/13f/{symbol}/holders":{"get":{"operationId":"sec.holders","tags":["sec"],"summary":"Stored institutional holders and quarter-to-quarter changes","description":"Reads the existing dataset service and needs a key on an account with a plan; every plan reads every live dataset in full. Cached market reads can refresh their source data. Unknown, empty and repeated parameters are rejected. History and coverage metadata are null when the stored service cannot establish them.","parameters":[{"name":"symbol","in":"path","required":true,"schema":{"type":"string","minLength":1,"maxLength":32,"pattern":"^[A-Za-z0-9.:-]{1,32}$","description":"Company symbol; normalized to uppercase."}},{"name":"quarter","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":6,"pattern":"^20[0-9]{2}Q[1-4]$"}},{"name":"cursor","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":120,"pattern":"^[A-Za-z0-9_-]+$","description":"Opaque: meta.page.nextCursor of the previous page. Bound to this route and query. Pages up to 5,000 rows deep."}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":25,"default":25}},{"$ref":"#/components/parameters/GloomVersion"},{"$ref":"#/components/parameters/IfNoneMatch"}],"x-dataset":"sec","x-credit-cost":2,"x-credit-call-type":"history","x-credit-multiplier":1,"x-plans":["basic","desk","enterprise"],"x-sample-url":"/v1/datasets/sec/sample","responses":{"200":{"description":"Stored dataset response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DatasetResponse"}}},"headers":{"Request-Id":{"$ref":"#/components/headers/RequestId"},"Gloom-Version":{"$ref":"#/components/headers/GloomVersion"},"X-Credits-Cost":{"$ref":"#/components/headers/CreditsCost"},"X-Credits-Remaining":{"$ref":"#/components/headers/CreditsRemaining"},"X-Plan":{"$ref":"#/components/headers/Plan"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimitLimit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimitRemaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimitReset"},"ETag":{"$ref":"#/components/headers/ETag"}}},"304":{"$ref":"#/components/responses/NotModified"},"400":{"$ref":"#/components/responses/Error400"},"401":{"$ref":"#/components/responses/Error401"},"402":{"$ref":"#/components/responses/Error402"},"403":{"$ref":"#/components/responses/Error403"},"404":{"$ref":"#/components/responses/Error404"},"429":{"$ref":"#/components/responses/Error429"},"503":{"$ref":"#/components/responses/Error503"}}}},"/v1/jobs":{"get":{"operationId":"jobs.list","tags":["hiring-jobs"],"summary":"Observed company hiring postings","description":"Reads the existing dataset service and needs a key on an account with a plan; every plan reads every live dataset in full. Cached market reads can refresh their source data. Unknown, empty and repeated parameters are rejected. History and coverage metadata are null when the stored service cannot establish them.","parameters":[{"name":"limit","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":200,"default":100}},{"name":"cursor","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":120,"pattern":"^[A-Za-z0-9_-]+$","description":"Opaque: meta.page.nextCursor of the previous page. Bound to this route and query."}},{"$ref":"#/components/parameters/GloomVersion"},{"$ref":"#/components/parameters/IfNoneMatch"}],"x-dataset":"hiring-jobs","x-credit-cost":4,"x-credit-call-type":"search","x-credit-multiplier":2,"x-plans":["basic","desk","enterprise"],"x-sample-url":"/v1/datasets/hiring-jobs/sample","responses":{"200":{"description":"Stored dataset response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DatasetResponse"}}},"headers":{"Request-Id":{"$ref":"#/components/headers/RequestId"},"Gloom-Version":{"$ref":"#/components/headers/GloomVersion"},"X-Credits-Cost":{"$ref":"#/components/headers/CreditsCost"},"X-Credits-Remaining":{"$ref":"#/components/headers/CreditsRemaining"},"X-Plan":{"$ref":"#/components/headers/Plan"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimitLimit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimitRemaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimitReset"},"ETag":{"$ref":"#/components/headers/ETag"}}},"304":{"$ref":"#/components/responses/NotModified"},"400":{"$ref":"#/components/responses/Error400"},"401":{"$ref":"#/components/responses/Error401"},"402":{"$ref":"#/components/responses/Error402"},"403":{"$ref":"#/components/responses/Error403"},"404":{"$ref":"#/components/responses/Error404"},"429":{"$ref":"#/components/responses/Error429"},"503":{"$ref":"#/components/responses/Error503"}}}},"/v1/jobs/{symbol}":{"get":{"operationId":"jobs.company","tags":["hiring-jobs"],"summary":"Stored company hiring summary and observed posting history","description":"Reads the existing dataset service and needs a key on an account with a plan; every plan reads every live dataset in full. Cached market reads can refresh their source data. Unknown, empty and repeated parameters are rejected. History and coverage metadata are null when the stored service cannot establish them.","parameters":[{"name":"symbol","in":"path","required":true,"schema":{"type":"string","minLength":1,"maxLength":32,"pattern":"^[A-Za-z0-9.:-]{1,32}$","description":"Company symbol; normalized to uppercase."}},{"$ref":"#/components/parameters/GloomVersion"},{"$ref":"#/components/parameters/IfNoneMatch"}],"x-dataset":"hiring-jobs","x-credit-cost":4,"x-credit-call-type":"history","x-credit-multiplier":2,"x-plans":["basic","desk","enterprise"],"x-sample-url":"/v1/datasets/hiring-jobs/sample","responses":{"200":{"description":"Stored dataset response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DatasetResponse"}}},"headers":{"Request-Id":{"$ref":"#/components/headers/RequestId"},"Gloom-Version":{"$ref":"#/components/headers/GloomVersion"},"X-Credits-Cost":{"$ref":"#/components/headers/CreditsCost"},"X-Credits-Remaining":{"$ref":"#/components/headers/CreditsRemaining"},"X-Plan":{"$ref":"#/components/headers/Plan"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimitLimit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimitRemaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimitReset"},"ETag":{"$ref":"#/components/headers/ETag"}}},"304":{"$ref":"#/components/responses/NotModified"},"400":{"$ref":"#/components/responses/Error400"},"401":{"$ref":"#/components/responses/Error401"},"402":{"$ref":"#/components/responses/Error402"},"403":{"$ref":"#/components/responses/Error403"},"404":{"$ref":"#/components/responses/Error404"},"429":{"$ref":"#/components/responses/Error429"},"503":{"$ref":"#/components/responses/Error503"}}}},"/v1/hiring/{symbol}/postings":{"get":{"operationId":"jobs.postings","tags":["hiring-jobs"],"summary":"Company careers postings","description":"Reads the existing dataset service and needs a key on an account with a plan; every plan reads every live dataset in full. Cached market reads can refresh their source data. Unknown, empty and repeated parameters are rejected. History and coverage metadata are null when the stored service cannot establish them.","parameters":[{"name":"symbol","in":"path","required":true,"schema":{"type":"string","minLength":1,"maxLength":32,"pattern":"^[A-Za-z0-9.:-]{1,32}$","description":"Company symbol; normalized to uppercase."}},{"name":"function","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":1024,"pattern":"\\S"}},{"name":"q","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":1024,"pattern":"\\S"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":200,"default":100}},{"name":"cursor","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":120,"pattern":"^[A-Za-z0-9_-]+$","description":"Opaque: meta.page.nextCursor of the previous page. Bound to this route and query."}},{"name":"includeClosed","in":"query","required":false,"schema":{"type":"boolean"}},{"$ref":"#/components/parameters/GloomVersion"},{"$ref":"#/components/parameters/IfNoneMatch"}],"x-dataset":"hiring-jobs","x-credit-cost":4,"x-credit-call-type":"search","x-credit-multiplier":2,"x-plans":["basic","desk","enterprise"],"x-sample-url":"/v1/datasets/hiring-jobs/sample","responses":{"200":{"description":"Stored dataset response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DatasetResponse"}}},"headers":{"Request-Id":{"$ref":"#/components/headers/RequestId"},"Gloom-Version":{"$ref":"#/components/headers/GloomVersion"},"X-Credits-Cost":{"$ref":"#/components/headers/CreditsCost"},"X-Credits-Remaining":{"$ref":"#/components/headers/CreditsRemaining"},"X-Plan":{"$ref":"#/components/headers/Plan"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimitLimit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimitRemaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimitReset"},"ETag":{"$ref":"#/components/headers/ETag"}}},"304":{"$ref":"#/components/responses/NotModified"},"400":{"$ref":"#/components/responses/Error400"},"401":{"$ref":"#/components/responses/Error401"},"402":{"$ref":"#/components/responses/Error402"},"403":{"$ref":"#/components/responses/Error403"},"404":{"$ref":"#/components/responses/Error404"},"429":{"$ref":"#/components/responses/Error429"},"503":{"$ref":"#/components/responses/Error503"}}}},"/v1/hiring":{"get":{"operationId":"hiring.board","tags":["hiring-momentum"],"summary":"Weekly observed hiring momentum","description":"Reads the existing dataset service and needs a key on an account with a plan; every plan reads every live dataset in full. Cached market reads can refresh their source data. Unknown, empty and repeated parameters are rejected. History and coverage metadata are null when the stored service cannot establish them.","parameters":[{"name":"limit","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":200,"default":100}},{"name":"cursor","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":120,"pattern":"^[A-Za-z0-9_-]+$","description":"Opaque: meta.page.nextCursor of the previous page. Bound to this route and query."}},{"$ref":"#/components/parameters/GloomVersion"},{"$ref":"#/components/parameters/IfNoneMatch"}],"x-dataset":"hiring-momentum","x-credit-cost":2,"x-credit-call-type":"lookup","x-credit-multiplier":2,"x-plans":["basic","desk","enterprise"],"x-sample-url":"/v1/datasets/hiring-momentum/sample","responses":{"200":{"description":"Stored dataset response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DatasetResponse"}}},"headers":{"Request-Id":{"$ref":"#/components/headers/RequestId"},"Gloom-Version":{"$ref":"#/components/headers/GloomVersion"},"X-Credits-Cost":{"$ref":"#/components/headers/CreditsCost"},"X-Credits-Remaining":{"$ref":"#/components/headers/CreditsRemaining"},"X-Plan":{"$ref":"#/components/headers/Plan"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimitLimit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimitRemaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimitReset"},"ETag":{"$ref":"#/components/headers/ETag"}}},"304":{"$ref":"#/components/responses/NotModified"},"400":{"$ref":"#/components/responses/Error400"},"401":{"$ref":"#/components/responses/Error401"},"402":{"$ref":"#/components/responses/Error402"},"403":{"$ref":"#/components/responses/Error403"},"404":{"$ref":"#/components/responses/Error404"},"429":{"$ref":"#/components/responses/Error429"},"503":{"$ref":"#/components/responses/Error503"}}}},"/v1/hiring/{symbol}":{"get":{"operationId":"hiring.company","tags":["hiring-momentum"],"summary":"Company weekly hiring evidence","description":"Reads the existing dataset service and needs a key on an account with a plan; every plan reads every live dataset in full. Cached market reads can refresh their source data. Unknown, empty and repeated parameters are rejected. History and coverage metadata are null when the stored service cannot establish them.","parameters":[{"name":"symbol","in":"path","required":true,"schema":{"type":"string","minLength":1,"maxLength":32,"pattern":"^[A-Za-z0-9.:-]{1,32}$","description":"Company symbol; normalized to uppercase."}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":200,"default":100}},{"name":"cursor","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":120,"pattern":"^[A-Za-z0-9_-]+$","description":"Opaque: meta.page.nextCursor of the previous page. Bound to this route and query."}},{"$ref":"#/components/parameters/GloomVersion"},{"$ref":"#/components/parameters/IfNoneMatch"}],"x-dataset":"hiring-momentum","x-credit-cost":4,"x-credit-call-type":"history","x-credit-multiplier":2,"x-plans":["basic","desk","enterprise"],"x-sample-url":"/v1/datasets/hiring-momentum/sample","responses":{"200":{"description":"Stored dataset response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DatasetResponse"}}},"headers":{"Request-Id":{"$ref":"#/components/headers/RequestId"},"Gloom-Version":{"$ref":"#/components/headers/GloomVersion"},"X-Credits-Cost":{"$ref":"#/components/headers/CreditsCost"},"X-Credits-Remaining":{"$ref":"#/components/headers/CreditsRemaining"},"X-Plan":{"$ref":"#/components/headers/Plan"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimitLimit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimitRemaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimitReset"},"ETag":{"$ref":"#/components/headers/ETag"}}},"304":{"$ref":"#/components/responses/NotModified"},"400":{"$ref":"#/components/responses/Error400"},"401":{"$ref":"#/components/responses/Error401"},"402":{"$ref":"#/components/responses/Error402"},"403":{"$ref":"#/components/responses/Error403"},"404":{"$ref":"#/components/responses/Error404"},"429":{"$ref":"#/components/responses/Error429"},"503":{"$ref":"#/components/responses/Error503"}}}},"/v1/jobs/coverage":{"get":{"operationId":"jobs.coverage","tags":["hiring-jobs"],"summary":"Company careers coverage and posting counts","description":"Reads the existing dataset service and needs a key on an account with a plan; every plan reads every live dataset in full. Cached market reads can refresh their source data. Unknown, empty and repeated parameters are rejected. History and coverage metadata are null when the stored service cannot establish them.","parameters":[{"$ref":"#/components/parameters/GloomVersion"},{"$ref":"#/components/parameters/IfNoneMatch"}],"x-dataset":"hiring-jobs","x-credit-cost":2,"x-credit-call-type":"lookup","x-credit-multiplier":2,"x-plans":["basic","desk","enterprise"],"x-sample-url":"/v1/datasets/hiring-jobs/sample","responses":{"200":{"description":"Stored dataset response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DatasetResponse"}}},"headers":{"Request-Id":{"$ref":"#/components/headers/RequestId"},"Gloom-Version":{"$ref":"#/components/headers/GloomVersion"},"X-Credits-Cost":{"$ref":"#/components/headers/CreditsCost"},"X-Credits-Remaining":{"$ref":"#/components/headers/CreditsRemaining"},"X-Plan":{"$ref":"#/components/headers/Plan"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimitLimit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimitRemaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimitReset"},"ETag":{"$ref":"#/components/headers/ETag"}}},"304":{"$ref":"#/components/responses/NotModified"},"400":{"$ref":"#/components/responses/Error400"},"401":{"$ref":"#/components/responses/Error401"},"402":{"$ref":"#/components/responses/Error402"},"403":{"$ref":"#/components/responses/Error403"},"404":{"$ref":"#/components/responses/Error404"},"429":{"$ref":"#/components/responses/Error429"},"503":{"$ref":"#/components/responses/Error503"}}}},"/v1/hiring/coverage":{"get":{"operationId":"hiring.coverage","tags":["hiring-momentum"],"summary":"Weekly hiring coverage and retained observation counts","description":"Reads the existing dataset service and needs a key on an account with a plan; every plan reads every live dataset in full. Cached market reads can refresh their source data. Unknown, empty and repeated parameters are rejected. History and coverage metadata are null when the stored service cannot establish them.","parameters":[{"$ref":"#/components/parameters/GloomVersion"},{"$ref":"#/components/parameters/IfNoneMatch"}],"x-dataset":"hiring-momentum","x-credit-cost":2,"x-credit-call-type":"lookup","x-credit-multiplier":2,"x-plans":["basic","desk","enterprise"],"x-sample-url":"/v1/datasets/hiring-momentum/sample","responses":{"200":{"description":"Stored dataset response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DatasetResponse"}}},"headers":{"Request-Id":{"$ref":"#/components/headers/RequestId"},"Gloom-Version":{"$ref":"#/components/headers/GloomVersion"},"X-Credits-Cost":{"$ref":"#/components/headers/CreditsCost"},"X-Credits-Remaining":{"$ref":"#/components/headers/CreditsRemaining"},"X-Plan":{"$ref":"#/components/headers/Plan"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimitLimit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimitRemaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimitReset"},"ETag":{"$ref":"#/components/headers/ETag"}}},"304":{"$ref":"#/components/responses/NotModified"},"400":{"$ref":"#/components/responses/Error400"},"401":{"$ref":"#/components/responses/Error401"},"402":{"$ref":"#/components/responses/Error402"},"403":{"$ref":"#/components/responses/Error403"},"404":{"$ref":"#/components/responses/Error404"},"429":{"$ref":"#/components/responses/Error429"},"503":{"$ref":"#/components/responses/Error503"}}}},"/v1/apps/board":{"get":{"operationId":"apps.board","tags":["app-attention"],"summary":"App store ranks, ratings and company attention","description":"Reads the existing dataset service and needs a key on an account with a plan; every plan reads every live dataset in full. Cached market reads can refresh their source data. Unknown, empty and repeated parameters are rejected. History and coverage metadata are null when the stored service cannot establish them.","parameters":[{"name":"country","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":1024,"pattern":"\\S"}},{"name":"category","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":1024,"pattern":"\\S"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":200,"default":100}},{"name":"cursor","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":120,"pattern":"^[A-Za-z0-9_-]+$","description":"Opaque: meta.page.nextCursor of the previous page. Bound to this route and query."}},{"name":"days","in":"query","required":false,"schema":{"type":"integer","minimum":7,"maximum":730}},{"name":"chart","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":1024,"pattern":"\\S","enum":["free","paid","grossing","unranked"]}},{"$ref":"#/components/parameters/GloomVersion"},{"$ref":"#/components/parameters/IfNoneMatch"}],"x-dataset":"app-attention","x-credit-cost":2,"x-credit-call-type":"history","x-credit-multiplier":1,"x-plans":["basic","desk","enterprise"],"x-sample-url":"/v1/datasets/app-attention/sample","responses":{"200":{"description":"Stored dataset response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DatasetResponse"}}},"headers":{"Request-Id":{"$ref":"#/components/headers/RequestId"},"Gloom-Version":{"$ref":"#/components/headers/GloomVersion"},"X-Credits-Cost":{"$ref":"#/components/headers/CreditsCost"},"X-Credits-Remaining":{"$ref":"#/components/headers/CreditsRemaining"},"X-Plan":{"$ref":"#/components/headers/Plan"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimitLimit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimitRemaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimitReset"},"ETag":{"$ref":"#/components/headers/ETag"}}},"304":{"$ref":"#/components/responses/NotModified"},"400":{"$ref":"#/components/responses/Error400"},"401":{"$ref":"#/components/responses/Error401"},"402":{"$ref":"#/components/responses/Error402"},"403":{"$ref":"#/components/responses/Error403"},"404":{"$ref":"#/components/responses/Error404"},"429":{"$ref":"#/components/responses/Error429"},"503":{"$ref":"#/components/responses/Error503"}}}},"/v1/apps/app/{store}/{appId}":{"get":{"operationId":"apps.app","tags":["app-attention"],"summary":"Daily chart and rating history for an app","description":"Reads the existing dataset service and needs a key on an account with a plan; every plan reads every live dataset in full. Cached market reads can refresh their source data. Unknown, empty and repeated parameters are rejected. History and coverage metadata are null when the stored service cannot establish them.","parameters":[{"name":"store","in":"path","required":true,"schema":{"type":"string","minLength":1,"maxLength":1024,"pattern":"\\S","enum":["app-store","google-play"]}},{"name":"appId","in":"path","required":true,"schema":{"type":"string","minLength":1,"maxLength":1024,"pattern":"\\S"}},{"name":"country","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":1024,"pattern":"\\S"}},{"name":"category","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":1024,"pattern":"\\S"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":200,"default":100}},{"name":"cursor","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":120,"pattern":"^[A-Za-z0-9_-]+$","description":"Opaque: meta.page.nextCursor of the previous page. Bound to this route and query."}},{"name":"days","in":"query","required":false,"schema":{"type":"integer","minimum":7,"maximum":730}},{"name":"chart","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":1024,"pattern":"\\S","enum":["free","paid","grossing","unranked"]}},{"$ref":"#/components/parameters/GloomVersion"},{"$ref":"#/components/parameters/IfNoneMatch"}],"x-dataset":"app-attention","x-credit-cost":2,"x-credit-call-type":"history","x-credit-multiplier":1,"x-plans":["basic","desk","enterprise"],"x-sample-url":"/v1/datasets/app-attention/sample","responses":{"200":{"description":"Stored dataset response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DatasetResponse"}}},"headers":{"Request-Id":{"$ref":"#/components/headers/RequestId"},"Gloom-Version":{"$ref":"#/components/headers/GloomVersion"},"X-Credits-Cost":{"$ref":"#/components/headers/CreditsCost"},"X-Credits-Remaining":{"$ref":"#/components/headers/CreditsRemaining"},"X-Plan":{"$ref":"#/components/headers/Plan"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimitLimit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimitRemaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimitReset"},"ETag":{"$ref":"#/components/headers/ETag"}}},"304":{"$ref":"#/components/responses/NotModified"},"400":{"$ref":"#/components/responses/Error400"},"401":{"$ref":"#/components/responses/Error401"},"402":{"$ref":"#/components/responses/Error402"},"403":{"$ref":"#/components/responses/Error403"},"404":{"$ref":"#/components/responses/Error404"},"429":{"$ref":"#/components/responses/Error429"},"503":{"$ref":"#/components/responses/Error503"}}}},"/v1/apps/company/{symbol}":{"get":{"operationId":"apps.company","tags":["app-attention"],"summary":"App attention and history for a listed company","description":"Reads the existing dataset service and needs a key on an account with a plan; every plan reads every live dataset in full. Cached market reads can refresh their source data. Unknown, empty and repeated parameters are rejected. History and coverage metadata are null when the stored service cannot establish them.","parameters":[{"name":"symbol","in":"path","required":true,"schema":{"type":"string","minLength":1,"maxLength":32,"pattern":"^[A-Za-z0-9.:-]{1,32}$","description":"Company symbol; normalized to uppercase."}},{"name":"country","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":1024,"pattern":"\\S"}},{"name":"category","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":1024,"pattern":"\\S"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":200,"default":100}},{"name":"cursor","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":120,"pattern":"^[A-Za-z0-9_-]+$","description":"Opaque: meta.page.nextCursor of the previous page. Bound to this route and query."}},{"name":"days","in":"query","required":false,"schema":{"type":"integer","minimum":7,"maximum":730}},{"name":"chart","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":1024,"pattern":"\\S","enum":["free","paid","grossing","unranked"]}},{"$ref":"#/components/parameters/GloomVersion"},{"$ref":"#/components/parameters/IfNoneMatch"}],"x-dataset":"app-attention","x-credit-cost":2,"x-credit-call-type":"history","x-credit-multiplier":1,"x-plans":["basic","desk","enterprise"],"x-sample-url":"/v1/datasets/app-attention/sample","responses":{"200":{"description":"Stored dataset response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DatasetResponse"}}},"headers":{"Request-Id":{"$ref":"#/components/headers/RequestId"},"Gloom-Version":{"$ref":"#/components/headers/GloomVersion"},"X-Credits-Cost":{"$ref":"#/components/headers/CreditsCost"},"X-Credits-Remaining":{"$ref":"#/components/headers/CreditsRemaining"},"X-Plan":{"$ref":"#/components/headers/Plan"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimitLimit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimitRemaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimitReset"},"ETag":{"$ref":"#/components/headers/ETag"}}},"304":{"$ref":"#/components/responses/NotModified"},"400":{"$ref":"#/components/responses/Error400"},"401":{"$ref":"#/components/responses/Error401"},"402":{"$ref":"#/components/responses/Error402"},"403":{"$ref":"#/components/responses/Error403"},"404":{"$ref":"#/components/responses/Error404"},"429":{"$ref":"#/components/responses/Error429"},"503":{"$ref":"#/components/responses/Error503"}}}},"/v1/apps/coverage":{"get":{"operationId":"apps.coverage","tags":["app-attention"],"summary":"App chart coverage and collection freshness","description":"Reads the existing dataset service and needs a key on an account with a plan; every plan reads every live dataset in full. Cached market reads can refresh their source data. Unknown, empty and repeated parameters are rejected. History and coverage metadata are null when the stored service cannot establish them.","parameters":[{"$ref":"#/components/parameters/GloomVersion"},{"$ref":"#/components/parameters/IfNoneMatch"}],"x-dataset":"app-attention","x-credit-cost":1,"x-credit-call-type":"lookup","x-credit-multiplier":1,"x-plans":["basic","desk","enterprise"],"x-sample-url":"/v1/datasets/app-attention/sample","responses":{"200":{"description":"Stored dataset response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DatasetResponse"}}},"headers":{"Request-Id":{"$ref":"#/components/headers/RequestId"},"Gloom-Version":{"$ref":"#/components/headers/GloomVersion"},"X-Credits-Cost":{"$ref":"#/components/headers/CreditsCost"},"X-Credits-Remaining":{"$ref":"#/components/headers/CreditsRemaining"},"X-Plan":{"$ref":"#/components/headers/Plan"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimitLimit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimitRemaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimitReset"},"ETag":{"$ref":"#/components/headers/ETag"}}},"304":{"$ref":"#/components/responses/NotModified"},"400":{"$ref":"#/components/responses/Error400"},"401":{"$ref":"#/components/responses/Error401"},"402":{"$ref":"#/components/responses/Error402"},"403":{"$ref":"#/components/responses/Error403"},"404":{"$ref":"#/components/responses/Error404"},"429":{"$ref":"#/components/responses/Error429"},"503":{"$ref":"#/components/responses/Error503"}}}},"/v1/power/board":{"get":{"operationId":"power.board","tags":["power"],"summary":"Electricity projects, capacity, queue rates and utility exposure","description":"Reads the existing dataset service and needs a key on an account with a plan; every plan reads every live dataset in full. Cached market reads can refresh their source data. Unknown, empty and repeated parameters are rejected. History and coverage metadata are null when the stored service cannot establish them.","parameters":[{"name":"country","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":1024,"pattern":"\\S"}},{"name":"region","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":1024,"pattern":"\\S"}},{"name":"fuel","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":1024,"pattern":"\\S"}},{"name":"status","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":1024,"pattern":"\\S"}},{"name":"symbol","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":32,"pattern":"^[A-Za-z0-9.:-]{1,32}$","description":"Company symbol; normalized to uppercase."}},{"name":"search","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":1024,"pattern":"\\S"}},{"name":"sourceId","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":1024,"pattern":"\\S"}},{"name":"loadClass","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":1024,"pattern":"\\S"}},{"name":"cursor","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":120,"pattern":"^[A-Za-z0-9_-]+$","description":"Opaque: meta.page.nextCursor of the previous page. Bound to this route and query."}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":200,"default":100}},{"name":"sort","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":1024,"pattern":"\\S","enum":["capacityMw","name","region","status","proposedDate","generationMwh","salesMwh","revenueUsd","summerPeakDemandMw","winterPeakDemandMw"]}},{"name":"from","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":35,"pattern":"^\\d{4}-\\d{2}-\\d{2}T(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d{1,6})?(?:Z|[+-](?:[01]\\d|2[0-3]):[0-5]\\d)$","format":"date-time"}},{"name":"to","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":35,"pattern":"^\\d{4}-\\d{2}-\\d{2}T(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d{1,6})?(?:Z|[+-](?:[01]\\d|2[0-3]):[0-5]\\d)$","format":"date-time"}},{"name":"kind","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":1024,"pattern":"\\S","enum":["queue","load","capacity","utility"]}},{"name":"direction","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":1024,"pattern":"\\S","enum":["asc","desc"]}},{"name":"historical","in":"query","required":false,"schema":{"type":"boolean"}},{"$ref":"#/components/parameters/GloomVersion"},{"$ref":"#/components/parameters/IfNoneMatch"}],"x-dataset":"power","x-credit-cost":25,"x-credit-call-type":"bulk","x-credit-multiplier":1,"x-plans":["basic","desk","enterprise"],"x-sample-url":"/v1/datasets/power/sample","responses":{"200":{"description":"Stored dataset response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DatasetResponse"}}},"headers":{"Request-Id":{"$ref":"#/components/headers/RequestId"},"Gloom-Version":{"$ref":"#/components/headers/GloomVersion"},"X-Credits-Cost":{"$ref":"#/components/headers/CreditsCost"},"X-Credits-Remaining":{"$ref":"#/components/headers/CreditsRemaining"},"X-Plan":{"$ref":"#/components/headers/Plan"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimitLimit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimitRemaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimitReset"},"ETag":{"$ref":"#/components/headers/ETag"}}},"304":{"$ref":"#/components/responses/NotModified"},"400":{"$ref":"#/components/responses/Error400"},"401":{"$ref":"#/components/responses/Error401"},"402":{"$ref":"#/components/responses/Error402"},"403":{"$ref":"#/components/responses/Error403"},"404":{"$ref":"#/components/responses/Error404"},"429":{"$ref":"#/components/responses/Error429"},"503":{"$ref":"#/components/responses/Error503"}}}},"/v1/power/history":{"get":{"operationId":"power.history","tags":["power"],"summary":"Observed and published electricity grid history","description":"Reads the existing dataset service and needs a key on an account with a plan; every plan reads every live dataset in full. Cached market reads can refresh their source data. Unknown, empty and repeated parameters are rejected. History and coverage metadata are null when the stored service cannot establish them.","parameters":[{"name":"country","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":1024,"pattern":"\\S"}},{"name":"region","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":1024,"pattern":"\\S"}},{"name":"fuel","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":1024,"pattern":"\\S"}},{"name":"status","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":1024,"pattern":"\\S"}},{"name":"symbol","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":32,"pattern":"^[A-Za-z0-9.:-]{1,32}$","description":"Company symbol; normalized to uppercase."}},{"name":"search","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":1024,"pattern":"\\S"}},{"name":"sourceId","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":1024,"pattern":"\\S"}},{"name":"loadClass","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":1024,"pattern":"\\S"}},{"name":"cursor","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":120,"pattern":"^[A-Za-z0-9_-]+$","description":"Opaque: meta.page.nextCursor of the previous page. Bound to this route and query."}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":200,"default":200}},{"name":"sort","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":1024,"pattern":"\\S","enum":["capacityMw","name","region","status","proposedDate","generationMwh","salesMwh","revenueUsd","summerPeakDemandMw","winterPeakDemandMw"]}},{"name":"from","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":35,"pattern":"^\\d{4}-\\d{2}-\\d{2}T(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d{1,6})?(?:Z|[+-](?:[01]\\d|2[0-3]):[0-5]\\d)$","format":"date-time"}},{"name":"to","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":35,"pattern":"^\\d{4}-\\d{2}-\\d{2}T(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d{1,6})?(?:Z|[+-](?:[01]\\d|2[0-3]):[0-5]\\d)$","format":"date-time"}},{"name":"kind","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":1024,"pattern":"\\S","enum":["queue","load","capacity","utility"]}},{"name":"direction","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":1024,"pattern":"\\S","enum":["asc","desc"]}},{"name":"historical","in":"query","required":false,"schema":{"type":"boolean"}},{"$ref":"#/components/parameters/GloomVersion"},{"$ref":"#/components/parameters/IfNoneMatch"}],"x-dataset":"power","x-credit-cost":2,"x-credit-call-type":"history","x-credit-multiplier":1,"x-plans":["basic","desk","enterprise"],"x-sample-url":"/v1/datasets/power/sample","responses":{"200":{"description":"Stored dataset response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DatasetResponse"}}},"headers":{"Request-Id":{"$ref":"#/components/headers/RequestId"},"Gloom-Version":{"$ref":"#/components/headers/GloomVersion"},"X-Credits-Cost":{"$ref":"#/components/headers/CreditsCost"},"X-Credits-Remaining":{"$ref":"#/components/headers/CreditsRemaining"},"X-Plan":{"$ref":"#/components/headers/Plan"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimitLimit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimitRemaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimitReset"},"ETag":{"$ref":"#/components/headers/ETag"}}},"304":{"$ref":"#/components/responses/NotModified"},"400":{"$ref":"#/components/responses/Error400"},"401":{"$ref":"#/components/responses/Error401"},"402":{"$ref":"#/components/responses/Error402"},"403":{"$ref":"#/components/responses/Error403"},"404":{"$ref":"#/components/responses/Error404"},"429":{"$ref":"#/components/responses/Error429"},"503":{"$ref":"#/components/responses/Error503"}}}},"/v1/power/projects/{id}":{"get":{"operationId":"power.project","tags":["power"],"summary":"Electricity project details and retained revisions","description":"Reads the existing dataset service and needs a key on an account with a plan; every plan reads every live dataset in full. Cached market reads can refresh their source data. Unknown, empty and repeated parameters are rejected. History and coverage metadata are null when the stored service cannot establish them.","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","minLength":1,"maxLength":1024,"pattern":"\\S"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":200,"default":100}},{"name":"cursor","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":120,"pattern":"^[A-Za-z0-9_-]+$","description":"Opaque: meta.page.nextCursor of the previous page. Bound to this route and query."}},{"$ref":"#/components/parameters/GloomVersion"},{"$ref":"#/components/parameters/IfNoneMatch"}],"x-dataset":"power","x-credit-cost":5,"x-credit-call-type":"evidence","x-credit-multiplier":1,"x-plans":["basic","desk","enterprise"],"x-sample-url":"/v1/datasets/power/sample","responses":{"200":{"description":"Stored dataset response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DatasetResponse"}}},"headers":{"Request-Id":{"$ref":"#/components/headers/RequestId"},"Gloom-Version":{"$ref":"#/components/headers/GloomVersion"},"X-Credits-Cost":{"$ref":"#/components/headers/CreditsCost"},"X-Credits-Remaining":{"$ref":"#/components/headers/CreditsRemaining"},"X-Plan":{"$ref":"#/components/headers/Plan"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimitLimit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimitRemaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimitReset"},"ETag":{"$ref":"#/components/headers/ETag"}}},"304":{"$ref":"#/components/responses/NotModified"},"400":{"$ref":"#/components/responses/Error400"},"401":{"$ref":"#/components/responses/Error401"},"402":{"$ref":"#/components/responses/Error402"},"403":{"$ref":"#/components/responses/Error403"},"404":{"$ref":"#/components/responses/Error404"},"429":{"$ref":"#/components/responses/Error429"},"503":{"$ref":"#/components/responses/Error503"}}}},"/v1/power/coverage":{"get":{"operationId":"power.coverage","tags":["power"],"summary":"Grid register coverage and collection freshness","description":"Reads the existing dataset service and needs a key on an account with a plan; every plan reads every live dataset in full. Cached market reads can refresh their source data. Unknown, empty and repeated parameters are rejected. History and coverage metadata are null when the stored service cannot establish them.","parameters":[{"$ref":"#/components/parameters/GloomVersion"},{"$ref":"#/components/parameters/IfNoneMatch"}],"x-dataset":"power","x-credit-cost":1,"x-credit-call-type":"lookup","x-credit-multiplier":1,"x-plans":["basic","desk","enterprise"],"x-sample-url":"/v1/datasets/power/sample","responses":{"200":{"description":"Stored dataset response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DatasetResponse"}}},"headers":{"Request-Id":{"$ref":"#/components/headers/RequestId"},"Gloom-Version":{"$ref":"#/components/headers/GloomVersion"},"X-Credits-Cost":{"$ref":"#/components/headers/CreditsCost"},"X-Credits-Remaining":{"$ref":"#/components/headers/CreditsRemaining"},"X-Plan":{"$ref":"#/components/headers/Plan"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimitLimit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimitRemaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimitReset"},"ETag":{"$ref":"#/components/headers/ETag"}}},"304":{"$ref":"#/components/responses/NotModified"},"400":{"$ref":"#/components/responses/Error400"},"401":{"$ref":"#/components/responses/Error401"},"402":{"$ref":"#/components/responses/Error402"},"403":{"$ref":"#/components/responses/Error403"},"404":{"$ref":"#/components/responses/Error404"},"429":{"$ref":"#/components/responses/Error429"},"503":{"$ref":"#/components/responses/Error503"}}}},"/v1/perps/board":{"get":{"operationId":"perps.board","tags":["perps"],"summary":"Perpetual contract prices, funding and open interest","description":"Reads the existing dataset service and needs a key on an account with a plan; every plan reads every live dataset in full. Cached market reads can refresh their source data. Unknown, empty and repeated parameters are rejected. History and coverage metadata are null when the stored service cannot establish them.","parameters":[{"name":"search","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":1024,"pattern":"\\S"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":200,"default":100}},{"name":"cursor","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":120,"pattern":"^[A-Za-z0-9_-]+$","description":"Opaque: meta.page.nextCursor of the previous page. Bound to this route and query."}},{"name":"assetClass","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":1024,"pattern":"\\S","enum":["stocks","indices","energy","metals","fx","crypto","other"]}},{"name":"sort","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":1024,"pattern":"\\S","enum":["oi","funding","oi-change","premium"]}},{"name":"includeDelisted","in":"query","required":false,"schema":{"type":"boolean"}},{"$ref":"#/components/parameters/GloomVersion"},{"$ref":"#/components/parameters/IfNoneMatch"}],"x-dataset":"perps","x-credit-cost":1,"x-credit-call-type":"lookup","x-credit-multiplier":1,"x-plans":["basic","desk","enterprise"],"x-sample-url":"/v1/datasets/perps/sample","responses":{"200":{"description":"Stored dataset response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DatasetResponse"}}},"headers":{"Request-Id":{"$ref":"#/components/headers/RequestId"},"Gloom-Version":{"$ref":"#/components/headers/GloomVersion"},"X-Credits-Cost":{"$ref":"#/components/headers/CreditsCost"},"X-Credits-Remaining":{"$ref":"#/components/headers/CreditsRemaining"},"X-Plan":{"$ref":"#/components/headers/Plan"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimitLimit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimitRemaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimitReset"},"ETag":{"$ref":"#/components/headers/ETag"}}},"304":{"$ref":"#/components/responses/NotModified"},"400":{"$ref":"#/components/responses/Error400"},"401":{"$ref":"#/components/responses/Error401"},"402":{"$ref":"#/components/responses/Error402"},"403":{"$ref":"#/components/responses/Error403"},"404":{"$ref":"#/components/responses/Error404"},"429":{"$ref":"#/components/responses/Error429"},"503":{"$ref":"#/components/responses/Error503"}}}},"/v1/perps/history":{"get":{"operationId":"perps.history","tags":["perps"],"summary":"Stored perpetual prices, funding and candle history","description":"Reads the existing dataset service and needs a key on an account with a plan; every plan reads every live dataset in full. Cached market reads can refresh their source data. Unknown, empty and repeated parameters are rejected. History and coverage metadata are null when the stored service cannot establish them.","parameters":[{"name":"from","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":35,"pattern":"^\\d{4}-\\d{2}-\\d{2}T(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d{1,6})?(?:Z|[+-](?:[01]\\d|2[0-3]):[0-5]\\d)$","format":"date-time"}},{"name":"to","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":35,"pattern":"^\\d{4}-\\d{2}-\\d{2}T(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d{1,6})?(?:Z|[+-](?:[01]\\d|2[0-3]):[0-5]\\d)$","format":"date-time"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":200}},{"name":"marketId","in":"query","required":true,"schema":{"type":"string","minLength":1,"maxLength":1024,"pattern":"\\S"}},{"name":"resolution","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":1024,"pattern":"\\S","enum":["auto","minute","hour","day"]}},{"$ref":"#/components/parameters/GloomVersion"},{"$ref":"#/components/parameters/IfNoneMatch"}],"x-dataset":"perps","x-credit-cost":2,"x-credit-call-type":"history","x-credit-multiplier":1,"x-plans":["basic","desk","enterprise"],"x-sample-url":"/v1/datasets/perps/sample","responses":{"200":{"description":"Stored dataset response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DatasetResponse"}}},"headers":{"Request-Id":{"$ref":"#/components/headers/RequestId"},"Gloom-Version":{"$ref":"#/components/headers/GloomVersion"},"X-Credits-Cost":{"$ref":"#/components/headers/CreditsCost"},"X-Credits-Remaining":{"$ref":"#/components/headers/CreditsRemaining"},"X-Plan":{"$ref":"#/components/headers/Plan"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimitLimit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimitRemaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimitReset"},"ETag":{"$ref":"#/components/headers/ETag"}}},"304":{"$ref":"#/components/responses/NotModified"},"400":{"$ref":"#/components/responses/Error400"},"401":{"$ref":"#/components/responses/Error401"},"402":{"$ref":"#/components/responses/Error402"},"403":{"$ref":"#/components/responses/Error403"},"404":{"$ref":"#/components/responses/Error404"},"429":{"$ref":"#/components/responses/Error429"},"503":{"$ref":"#/components/responses/Error503"}}}},"/v1/perps/rankings":{"get":{"operationId":"perps.rankings","tags":["perps"],"summary":"Funding, open-interest and premium dislocations","description":"Reads the existing dataset service and needs a key on an account with a plan; every plan reads every live dataset in full. Cached market reads can refresh their source data. Unknown, empty and repeated parameters are rejected. History and coverage metadata are null when the stored service cannot establish them.","parameters":[{"$ref":"#/components/parameters/GloomVersion"},{"$ref":"#/components/parameters/IfNoneMatch"}],"x-dataset":"perps","x-credit-cost":1,"x-credit-call-type":"lookup","x-credit-multiplier":1,"x-plans":["basic","desk","enterprise"],"x-sample-url":"/v1/datasets/perps/sample","responses":{"200":{"description":"Stored dataset response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DatasetResponse"}}},"headers":{"Request-Id":{"$ref":"#/components/headers/RequestId"},"Gloom-Version":{"$ref":"#/components/headers/GloomVersion"},"X-Credits-Cost":{"$ref":"#/components/headers/CreditsCost"},"X-Credits-Remaining":{"$ref":"#/components/headers/CreditsRemaining"},"X-Plan":{"$ref":"#/components/headers/Plan"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimitLimit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimitRemaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimitReset"},"ETag":{"$ref":"#/components/headers/ETag"}}},"304":{"$ref":"#/components/responses/NotModified"},"400":{"$ref":"#/components/responses/Error400"},"401":{"$ref":"#/components/responses/Error401"},"402":{"$ref":"#/components/responses/Error402"},"403":{"$ref":"#/components/responses/Error403"},"404":{"$ref":"#/components/responses/Error404"},"429":{"$ref":"#/components/responses/Error429"},"503":{"$ref":"#/components/responses/Error503"}}}},"/v1/perps/compare":{"get":{"operationId":"perps.compare","tags":["perps"],"summary":"Compare perpetual venues for one underlying asset","description":"Reads the existing dataset service and needs a key on an account with a plan; every plan reads every live dataset in full. Cached market reads can refresh their source data. Unknown, empty and repeated parameters are rejected. History and coverage metadata are null when the stored service cannot establish them.","parameters":[{"name":"limit","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":200,"default":100}},{"name":"cursor","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":120,"pattern":"^[A-Za-z0-9_-]+$","description":"Opaque: meta.page.nextCursor of the previous page. Bound to this route and query."}},{"name":"baseAsset","in":"query","required":true,"schema":{"type":"string","minLength":1,"maxLength":1024,"pattern":"\\S"}},{"$ref":"#/components/parameters/GloomVersion"},{"$ref":"#/components/parameters/IfNoneMatch"}],"x-dataset":"perps","x-credit-cost":1,"x-credit-call-type":"lookup","x-credit-multiplier":1,"x-plans":["basic","desk","enterprise"],"x-sample-url":"/v1/datasets/perps/sample","responses":{"200":{"description":"Stored dataset response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DatasetResponse"}}},"headers":{"Request-Id":{"$ref":"#/components/headers/RequestId"},"Gloom-Version":{"$ref":"#/components/headers/GloomVersion"},"X-Credits-Cost":{"$ref":"#/components/headers/CreditsCost"},"X-Credits-Remaining":{"$ref":"#/components/headers/CreditsRemaining"},"X-Plan":{"$ref":"#/components/headers/Plan"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimitLimit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimitRemaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimitReset"},"ETag":{"$ref":"#/components/headers/ETag"}}},"304":{"$ref":"#/components/responses/NotModified"},"400":{"$ref":"#/components/responses/Error400"},"401":{"$ref":"#/components/responses/Error401"},"402":{"$ref":"#/components/responses/Error402"},"403":{"$ref":"#/components/responses/Error403"},"404":{"$ref":"#/components/responses/Error404"},"429":{"$ref":"#/components/responses/Error429"},"503":{"$ref":"#/components/responses/Error503"}}}},"/v1/perps/market":{"get":{"operationId":"perps.market","tags":["perps"],"summary":"One perpetual market with retained source evidence","description":"Reads the existing dataset service and needs a key on an account with a plan; every plan reads every live dataset in full. Cached market reads can refresh their source data. Unknown, empty and repeated parameters are rejected. History and coverage metadata are null when the stored service cannot establish them.","parameters":[{"name":"marketId","in":"query","required":true,"schema":{"type":"string","minLength":1,"maxLength":1024,"pattern":"\\S"}},{"$ref":"#/components/parameters/GloomVersion"},{"$ref":"#/components/parameters/IfNoneMatch"}],"x-dataset":"perps","x-credit-cost":5,"x-credit-call-type":"evidence","x-credit-multiplier":1,"x-plans":["basic","desk","enterprise"],"x-sample-url":"/v1/datasets/perps/sample","responses":{"200":{"description":"Stored dataset response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DatasetResponse"}}},"headers":{"Request-Id":{"$ref":"#/components/headers/RequestId"},"Gloom-Version":{"$ref":"#/components/headers/GloomVersion"},"X-Credits-Cost":{"$ref":"#/components/headers/CreditsCost"},"X-Credits-Remaining":{"$ref":"#/components/headers/CreditsRemaining"},"X-Plan":{"$ref":"#/components/headers/Plan"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimitLimit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimitRemaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimitReset"},"ETag":{"$ref":"#/components/headers/ETag"}}},"304":{"$ref":"#/components/responses/NotModified"},"400":{"$ref":"#/components/responses/Error400"},"401":{"$ref":"#/components/responses/Error401"},"402":{"$ref":"#/components/responses/Error402"},"403":{"$ref":"#/components/responses/Error403"},"404":{"$ref":"#/components/responses/Error404"},"429":{"$ref":"#/components/responses/Error429"},"503":{"$ref":"#/components/responses/Error503"}}}},"/v1/perps/equity/{symbol}":{"get":{"operationId":"perps.equity","tags":["perps"],"summary":"Equity-linked perpetuals and stored underlying references","description":"Reads the existing dataset service and needs a key on an account with a plan; every plan reads every live dataset in full. Cached market reads can refresh their source data. Unknown, empty and repeated parameters are rejected. History and coverage metadata are null when the stored service cannot establish them.","parameters":[{"name":"symbol","in":"path","required":true,"schema":{"type":"string","minLength":1,"maxLength":32,"pattern":"^[A-Za-z0-9.:-]{1,32}$","description":"Company symbol; normalized to uppercase."}},{"name":"exchange","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":1024,"pattern":"\\S"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":200,"default":100}},{"name":"cursor","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":120,"pattern":"^[A-Za-z0-9_-]+$","description":"Opaque: meta.page.nextCursor of the previous page. Bound to this route and query."}},{"name":"identity","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":1024,"pattern":"\\S","enum":["listing"]}},{"$ref":"#/components/parameters/GloomVersion"},{"$ref":"#/components/parameters/IfNoneMatch"}],"x-dataset":"perps","x-credit-cost":1,"x-credit-call-type":"lookup","x-credit-multiplier":1,"x-plans":["basic","desk","enterprise"],"x-sample-url":"/v1/datasets/perps/sample","responses":{"200":{"description":"Stored dataset response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DatasetResponse"}}},"headers":{"Request-Id":{"$ref":"#/components/headers/RequestId"},"Gloom-Version":{"$ref":"#/components/headers/GloomVersion"},"X-Credits-Cost":{"$ref":"#/components/headers/CreditsCost"},"X-Credits-Remaining":{"$ref":"#/components/headers/CreditsRemaining"},"X-Plan":{"$ref":"#/components/headers/Plan"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimitLimit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimitRemaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimitReset"},"ETag":{"$ref":"#/components/headers/ETag"}}},"304":{"$ref":"#/components/responses/NotModified"},"400":{"$ref":"#/components/responses/Error400"},"401":{"$ref":"#/components/responses/Error401"},"402":{"$ref":"#/components/responses/Error402"},"403":{"$ref":"#/components/responses/Error403"},"404":{"$ref":"#/components/responses/Error404"},"429":{"$ref":"#/components/responses/Error429"},"503":{"$ref":"#/components/responses/Error503"}}}},"/v1/attention":{"get":{"operationId":"attention.board","tags":["research-attention"],"summary":"Privacy-thresholded company research activity","description":"Reads the existing dataset service and needs a key on an account with a plan; every plan reads every live dataset in full. Cached market reads can refresh their source data. Unknown, empty and repeated parameters are rejected. History and coverage metadata are null when the stored service cannot establish them.","parameters":[{"name":"limit","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":200,"default":100}},{"name":"cursor","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":120,"pattern":"^[A-Za-z0-9_-]+$","description":"Opaque: meta.page.nextCursor of the previous page. Bound to this route and query."}},{"name":"window","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":1024,"pattern":"\\S","enum":["now","today","week"]}},{"$ref":"#/components/parameters/GloomVersion"},{"$ref":"#/components/parameters/IfNoneMatch"}],"x-dataset":"research-attention","x-credit-cost":1,"x-credit-call-type":"lookup","x-credit-multiplier":1,"x-plans":["basic","desk","enterprise"],"x-sample-url":"/v1/datasets/research-attention/sample","responses":{"200":{"description":"Stored dataset response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DatasetResponse"}}},"headers":{"Request-Id":{"$ref":"#/components/headers/RequestId"},"Gloom-Version":{"$ref":"#/components/headers/GloomVersion"},"X-Credits-Cost":{"$ref":"#/components/headers/CreditsCost"},"X-Credits-Remaining":{"$ref":"#/components/headers/CreditsRemaining"},"X-Plan":{"$ref":"#/components/headers/Plan"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimitLimit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimitRemaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimitReset"},"ETag":{"$ref":"#/components/headers/ETag"}}},"304":{"$ref":"#/components/responses/NotModified"},"400":{"$ref":"#/components/responses/Error400"},"401":{"$ref":"#/components/responses/Error401"},"402":{"$ref":"#/components/responses/Error402"},"403":{"$ref":"#/components/responses/Error403"},"404":{"$ref":"#/components/responses/Error404"},"429":{"$ref":"#/components/responses/Error429"},"503":{"$ref":"#/components/responses/Error503"}}}},"/v1/attention/{symbol}":{"get":{"operationId":"attention.company","tags":["research-attention"],"summary":"Released company research counts and aggregate history","description":"Reads the existing dataset service and needs a key on an account with a plan; every plan reads every live dataset in full. Cached market reads can refresh their source data. Unknown, empty and repeated parameters are rejected. History and coverage metadata are null when the stored service cannot establish them.","parameters":[{"name":"symbol","in":"path","required":true,"schema":{"type":"string","minLength":1,"maxLength":32,"pattern":"^[A-Za-z0-9.:-]{1,32}$","description":"Company symbol; normalized to uppercase."}},{"name":"window","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":1024,"pattern":"\\S","enum":["now","today","week"]}},{"$ref":"#/components/parameters/GloomVersion"},{"$ref":"#/components/parameters/IfNoneMatch"}],"x-dataset":"research-attention","x-credit-cost":2,"x-credit-call-type":"history","x-credit-multiplier":1,"x-plans":["basic","desk","enterprise"],"x-sample-url":"/v1/datasets/research-attention/sample","responses":{"200":{"description":"Stored dataset response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DatasetResponse"}}},"headers":{"Request-Id":{"$ref":"#/components/headers/RequestId"},"Gloom-Version":{"$ref":"#/components/headers/GloomVersion"},"X-Credits-Cost":{"$ref":"#/components/headers/CreditsCost"},"X-Credits-Remaining":{"$ref":"#/components/headers/CreditsRemaining"},"X-Plan":{"$ref":"#/components/headers/Plan"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimitLimit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimitRemaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimitReset"},"ETag":{"$ref":"#/components/headers/ETag"}}},"304":{"$ref":"#/components/responses/NotModified"},"400":{"$ref":"#/components/responses/Error400"},"401":{"$ref":"#/components/responses/Error401"},"402":{"$ref":"#/components/responses/Error402"},"403":{"$ref":"#/components/responses/Error403"},"404":{"$ref":"#/components/responses/Error404"},"429":{"$ref":"#/components/responses/Error429"},"503":{"$ref":"#/components/responses/Error503"}}}},"/v1/supply-chain/{symbol}/graph":{"get":{"operationId":"supply-chain.graph","tags":["supply-chain"],"summary":"Multi-hop company relationships with source evidence","description":"Reads the existing dataset service and needs a key on an account with a plan; every plan reads every live dataset in full. Cached market reads can refresh their source data. Each disclosure's periodMonths is how many months all of its figures cover: 0 a balance at the period end, 3 a quarter, 6 a half, 12 a year. It is null when the source does not establish one length, including a row whose share and amount cover different lengths; match it before comparing shares. Unknown, empty and repeated parameters are rejected. History and coverage metadata are null when the stored service cannot establish them.","parameters":[{"name":"symbol","in":"path","required":true,"schema":{"type":"string","minLength":1,"maxLength":32,"pattern":"^[A-Za-z0-9.:-]{1,32}$","description":"Company symbol; normalized to uppercase."}},{"name":"roles","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":1024,"pattern":"\\S"}},{"name":"sources","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":1024,"pattern":"\\S"}},{"name":"tiers","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":1024,"pattern":"\\S"}},{"name":"asOf","in":"query","required":false,"schema":{"type":"string","minLength":10,"maxLength":10,"pattern":"^\\d{4}-\\d{2}-\\d{2}$","format":"date","description":"Valid calendar date (YYYY-MM-DD). from must be on or before to."}},{"name":"depth","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":4}},{"name":"direction","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":1024,"pattern":"\\S","enum":["upstream","downstream","both"]}},{"name":"minPct","in":"query","required":false,"schema":{"type":"number","minimum":0,"maximum":100}},{"name":"minConfidence","in":"query","required":false,"schema":{"type":"number","minimum":0,"maximum":1}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":50}},{"name":"ranking","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":1024,"pattern":"\\S","enum":["score","shortest"]}},{"$ref":"#/components/parameters/GloomVersion"},{"$ref":"#/components/parameters/IfNoneMatch"}],"x-dataset":"supply-chain","x-credit-cost":50,"x-credit-call-type":"bulk","x-credit-multiplier":2,"x-plans":["basic","desk","enterprise"],"x-sample-url":"/v1/datasets/supply-chain/sample","responses":{"200":{"description":"Stored dataset response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DatasetResponse"}}},"headers":{"Request-Id":{"$ref":"#/components/headers/RequestId"},"Gloom-Version":{"$ref":"#/components/headers/GloomVersion"},"X-Credits-Cost":{"$ref":"#/components/headers/CreditsCost"},"X-Credits-Remaining":{"$ref":"#/components/headers/CreditsRemaining"},"X-Plan":{"$ref":"#/components/headers/Plan"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimitLimit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimitRemaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimitReset"},"ETag":{"$ref":"#/components/headers/ETag"}}},"304":{"$ref":"#/components/responses/NotModified"},"400":{"$ref":"#/components/responses/Error400"},"401":{"$ref":"#/components/responses/Error401"},"402":{"$ref":"#/components/responses/Error402"},"403":{"$ref":"#/components/responses/Error403"},"404":{"$ref":"#/components/responses/Error404"},"429":{"$ref":"#/components/responses/Error429"},"503":{"$ref":"#/components/responses/Error503"}}}},"/v1/supply-chain/paths":{"get":{"operationId":"supply-chain.paths","tags":["supply-chain"],"summary":"Evidence-backed paths between two companies","description":"Reads the existing dataset service and needs a key on an account with a plan; every plan reads every live dataset in full. Cached market reads can refresh their source data. Each disclosure's periodMonths is how many months all of its figures cover: 0 a balance at the period end, 3 a quarter, 6 a half, 12 a year. It is null when the source does not establish one length, including a row whose share and amount cover different lengths; match it before comparing shares. Unknown, empty and repeated parameters are rejected. History and coverage metadata are null when the stored service cannot establish them.","parameters":[{"name":"roles","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":1024,"pattern":"\\S"}},{"name":"sources","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":1024,"pattern":"\\S"}},{"name":"tiers","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":1024,"pattern":"\\S"}},{"name":"asOf","in":"query","required":false,"schema":{"type":"string","minLength":10,"maxLength":10,"pattern":"^\\d{4}-\\d{2}-\\d{2}$","format":"date","description":"Valid calendar date (YYYY-MM-DD). from must be on or before to."}},{"name":"depth","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":4}},{"name":"direction","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":1024,"pattern":"\\S","enum":["upstream","downstream","both"]}},{"name":"minPct","in":"query","required":false,"schema":{"type":"number","minimum":0,"maximum":100}},{"name":"minConfidence","in":"query","required":false,"schema":{"type":"number","minimum":0,"maximum":1}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":50}},{"name":"ranking","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":1024,"pattern":"\\S","enum":["score","shortest"]}},{"name":"fromSymbol","in":"query","required":true,"schema":{"type":"string","minLength":1,"maxLength":1024,"pattern":"\\S"}},{"name":"toSymbol","in":"query","required":true,"schema":{"type":"string","minLength":1,"maxLength":1024,"pattern":"\\S"}},{"$ref":"#/components/parameters/GloomVersion"},{"$ref":"#/components/parameters/IfNoneMatch"}],"x-dataset":"supply-chain","x-credit-cost":50,"x-credit-call-type":"bulk","x-credit-multiplier":2,"x-plans":["basic","desk","enterprise"],"x-sample-url":"/v1/datasets/supply-chain/sample","responses":{"200":{"description":"Stored dataset response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DatasetResponse"}}},"headers":{"Request-Id":{"$ref":"#/components/headers/RequestId"},"Gloom-Version":{"$ref":"#/components/headers/GloomVersion"},"X-Credits-Cost":{"$ref":"#/components/headers/CreditsCost"},"X-Credits-Remaining":{"$ref":"#/components/headers/CreditsRemaining"},"X-Plan":{"$ref":"#/components/headers/Plan"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimitLimit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimitRemaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimitReset"},"ETag":{"$ref":"#/components/headers/ETag"}}},"304":{"$ref":"#/components/responses/NotModified"},"400":{"$ref":"#/components/responses/Error400"},"401":{"$ref":"#/components/responses/Error401"},"402":{"$ref":"#/components/responses/Error402"},"403":{"$ref":"#/components/responses/Error403"},"404":{"$ref":"#/components/responses/Error404"},"429":{"$ref":"#/components/responses/Error429"},"503":{"$ref":"#/components/responses/Error503"}}}},"/v1/supply-chain/{symbol}/counterparties":{"get":{"operationId":"supply-chain.counterparties","tags":["supply-chain"],"summary":"Disclosed suppliers, customers and other company relationships","description":"Reads the existing dataset service and needs a key on an account with a plan; every plan reads every live dataset in full. Cached market reads can refresh their source data. Each disclosure's periodMonths is how many months all of its figures cover: 0 a balance at the period end, 3 a quarter, 6 a half, 12 a year. It is null when the source does not establish one length, including a row whose share and amount cover different lengths; match it before comparing shares. says and names hold each share for its reporter's latest period on the same basis (revenue, receivables, cost or purchases) and every relationship stated without a share. A share from an earlier period of the same reporter and basis is in earlier.says or earlier.names instead, with its own period, paged by the same offset and limit; earlierCounts and meta.coverage.earlier count those rows by role, and meta.coverage.says and meta.coverage.names count says and names. Unknown, empty and repeated parameters are rejected. History and coverage metadata are null when the stored service cannot establish them.","parameters":[{"name":"symbol","in":"path","required":true,"schema":{"type":"string","minLength":1,"maxLength":32,"pattern":"^[A-Za-z0-9.:-]{1,32}$","description":"Company symbol; normalized to uppercase."}},{"name":"tiers","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":1024,"pattern":"\\S"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":50,"default":50}},{"name":"cursor","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":120,"pattern":"^[A-Za-z0-9_-]+$","description":"Opaque: meta.page.nextCursor of the previous page. Bound to this route and query."}},{"name":"includeLeads","in":"query","required":false,"schema":{"type":"boolean"}},{"$ref":"#/components/parameters/GloomVersion"},{"$ref":"#/components/parameters/IfNoneMatch"}],"x-dataset":"supply-chain","x-credit-cost":4,"x-credit-call-type":"search","x-credit-multiplier":2,"x-plans":["basic","desk","enterprise"],"x-sample-url":"/v1/datasets/supply-chain/sample","responses":{"200":{"description":"Stored dataset response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DatasetResponse"}}},"headers":{"Request-Id":{"$ref":"#/components/headers/RequestId"},"Gloom-Version":{"$ref":"#/components/headers/GloomVersion"},"X-Credits-Cost":{"$ref":"#/components/headers/CreditsCost"},"X-Credits-Remaining":{"$ref":"#/components/headers/CreditsRemaining"},"X-Plan":{"$ref":"#/components/headers/Plan"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimitLimit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimitRemaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimitReset"},"ETag":{"$ref":"#/components/headers/ETag"}}},"304":{"$ref":"#/components/responses/NotModified"},"400":{"$ref":"#/components/responses/Error400"},"401":{"$ref":"#/components/responses/Error401"},"402":{"$ref":"#/components/responses/Error402"},"403":{"$ref":"#/components/responses/Error403"},"404":{"$ref":"#/components/responses/Error404"},"429":{"$ref":"#/components/responses/Error429"},"503":{"$ref":"#/components/responses/Error503"}}}},"/v1/exposure/scenarios":{"get":{"operationId":"exposure.scenarios","tags":["exposure"],"summary":"Operating exposure scenario catalogue","description":"Reads the existing dataset service and needs a key on an account with a plan; every plan reads every live dataset in full. Cached market reads can refresh their source data. Unknown, empty and repeated parameters are rejected. History and coverage metadata are null when the stored service cannot establish them.","parameters":[{"$ref":"#/components/parameters/GloomVersion"},{"$ref":"#/components/parameters/IfNoneMatch"}],"x-dataset":"exposure","x-credit-cost":2,"x-credit-call-type":"lookup","x-credit-multiplier":2,"x-plans":["basic","desk","enterprise"],"x-sample-url":"/v1/datasets/exposure/sample","responses":{"200":{"description":"Stored dataset response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DatasetResponse"}}},"headers":{"Request-Id":{"$ref":"#/components/headers/RequestId"},"Gloom-Version":{"$ref":"#/components/headers/GloomVersion"},"X-Credits-Cost":{"$ref":"#/components/headers/CreditsCost"},"X-Credits-Remaining":{"$ref":"#/components/headers/CreditsRemaining"},"X-Plan":{"$ref":"#/components/headers/Plan"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimitLimit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimitRemaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimitReset"},"ETag":{"$ref":"#/components/headers/ETag"}}},"304":{"$ref":"#/components/responses/NotModified"},"400":{"$ref":"#/components/responses/Error400"},"401":{"$ref":"#/components/responses/Error401"},"402":{"$ref":"#/components/responses/Error402"},"403":{"$ref":"#/components/responses/Error403"},"404":{"$ref":"#/components/responses/Error404"},"429":{"$ref":"#/components/responses/Error429"},"503":{"$ref":"#/components/responses/Error503"}}}},"/v1/exposure/analyze":{"post":{"operationId":"exposure.analyze","tags":["exposure"],"summary":"Stateless operating exposure analysis using stored public evidence","description":"Reads the existing dataset service and needs a key on an account with a plan; every plan reads every live dataset in full. Cached market reads can refresh their source data. Unknown, empty and repeated parameters are rejected. History and coverage metadata are null when the stored service cannot establish them.","parameters":[{"$ref":"#/components/parameters/GloomVersion"}],"requestBody":{"required":true,"description":"Stateless JSON request, at most 16384 bytes. Holdings are not stored.","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"holdings":{"minItems":1,"maxItems":100,"type":"array","items":{"type":"object","properties":{"symbol":{"type":"string","minLength":1,"maxLength":40,"pattern":"^[A-Za-z0-9.:-]+$"},"weight":{"type":"number","minimum":-10,"maximum":10,"description":"Signed fraction of portfolio NAV; 0.25 means 25%, -0.1 means 10% short. Never normalized."}},"required":["symbol","weight"],"additionalProperties":false}},"scenarioId":{"type":"string","enum":["taiwan-disruption","china-demand","europe-demand","china-semiconductor-ban","china-tariff","oil-up","rates-up","usd-up","tsmc-outage","microsoft-capex"]}},"required":["holdings","scenarioId"],"additionalProperties":false}}}},"x-dataset":"exposure","x-credit-cost":50,"x-credit-call-type":"bulk","x-credit-multiplier":2,"x-plans":["basic","desk","enterprise"],"x-sample-url":"/v1/datasets/exposure/sample","responses":{"200":{"description":"Stored dataset response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DatasetResponse"}}},"headers":{"Request-Id":{"$ref":"#/components/headers/RequestId"},"Gloom-Version":{"$ref":"#/components/headers/GloomVersion"},"X-Credits-Cost":{"$ref":"#/components/headers/CreditsCost"},"X-Credits-Remaining":{"$ref":"#/components/headers/CreditsRemaining"},"X-Plan":{"$ref":"#/components/headers/Plan"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimitLimit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimitRemaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimitReset"},"ETag":{"$ref":"#/components/headers/ETag"}}},"400":{"$ref":"#/components/responses/Error400"},"401":{"$ref":"#/components/responses/Error401"},"402":{"$ref":"#/components/responses/Error402"},"403":{"$ref":"#/components/responses/Error403"},"404":{"$ref":"#/components/responses/Error404"},"429":{"$ref":"#/components/responses/Error429"},"503":{"$ref":"#/components/responses/Error503"}}}},"/v1/transcripts":{"get":{"operationId":"transcripts.list","tags":["transcripts"],"summary":"Published earnings calls by company","description":"Reads the existing dataset service and needs a key on an account with a plan; every plan reads every live dataset in full. Cached market reads can refresh their source data. Unknown, empty and repeated parameters are rejected. History and coverage metadata are null when the stored service cannot establish them.","parameters":[{"name":"ticker","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":32,"pattern":"^[A-Za-z0-9.:-]{1,32}$","description":"Company symbol; normalized to uppercase."}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":200,"default":25}},{"name":"cursor","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":120,"pattern":"^[A-Za-z0-9_-]+$","description":"Opaque: meta.page.nextCursor of the previous page. Bound to this route and query."}},{"$ref":"#/components/parameters/GloomVersion"},{"$ref":"#/components/parameters/IfNoneMatch"}],"x-dataset":"transcripts","x-credit-cost":4,"x-credit-call-type":"search","x-credit-multiplier":2,"x-plans":["basic","desk","enterprise"],"x-sample-url":"/v1/datasets/transcripts/sample","responses":{"200":{"description":"Stored dataset response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DatasetResponse"}}},"headers":{"Request-Id":{"$ref":"#/components/headers/RequestId"},"Gloom-Version":{"$ref":"#/components/headers/GloomVersion"},"X-Credits-Cost":{"$ref":"#/components/headers/CreditsCost"},"X-Credits-Remaining":{"$ref":"#/components/headers/CreditsRemaining"},"X-Plan":{"$ref":"#/components/headers/Plan"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimitLimit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimitRemaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimitReset"},"ETag":{"$ref":"#/components/headers/ETag"}}},"304":{"$ref":"#/components/responses/NotModified"},"400":{"$ref":"#/components/responses/Error400"},"401":{"$ref":"#/components/responses/Error401"},"402":{"$ref":"#/components/responses/Error402"},"403":{"$ref":"#/components/responses/Error403"},"404":{"$ref":"#/components/responses/Error404"},"429":{"$ref":"#/components/responses/Error429"},"503":{"$ref":"#/components/responses/Error503"}}}},"/v1/transcripts/{id}":{"get":{"operationId":"transcripts.detail","tags":["transcripts"],"summary":"Earnings transcript, speakers, summary and guidance","description":"Reads the existing dataset service and needs a key on an account with a plan; every plan reads every live dataset in full. Cached market reads can refresh their source data. Unknown, empty and repeated parameters are rejected. History and coverage metadata are null when the stored service cannot establish them.","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","minLength":1,"maxLength":1024,"pattern":"\\S"}},{"$ref":"#/components/parameters/GloomVersion"},{"$ref":"#/components/parameters/IfNoneMatch"}],"x-dataset":"transcripts","x-credit-cost":10,"x-credit-call-type":"evidence","x-credit-multiplier":2,"x-plans":["basic","desk","enterprise"],"x-sample-url":"/v1/datasets/transcripts/sample","responses":{"200":{"description":"Stored dataset response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DatasetResponse"}}},"headers":{"Request-Id":{"$ref":"#/components/headers/RequestId"},"Gloom-Version":{"$ref":"#/components/headers/GloomVersion"},"X-Credits-Cost":{"$ref":"#/components/headers/CreditsCost"},"X-Credits-Remaining":{"$ref":"#/components/headers/CreditsRemaining"},"X-Plan":{"$ref":"#/components/headers/Plan"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimitLimit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimitRemaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimitReset"},"ETag":{"$ref":"#/components/headers/ETag"}}},"304":{"$ref":"#/components/responses/NotModified"},"400":{"$ref":"#/components/responses/Error400"},"401":{"$ref":"#/components/responses/Error401"},"402":{"$ref":"#/components/responses/Error402"},"403":{"$ref":"#/components/responses/Error403"},"404":{"$ref":"#/components/responses/Error404"},"429":{"$ref":"#/components/responses/Error429"},"503":{"$ref":"#/components/responses/Error503"}}}},"/v1/document-search":{"get":{"operationId":"document-search.search","tags":["document-search"],"summary":"Search filings, transcripts and news","description":"Reads the existing dataset service and needs a key on an account with a plan; every plan reads every live dataset in full. Cached market reads can refresh their source data. Unknown, empty and repeated parameters are rejected. History and coverage metadata are null when the stored service cannot establish them.","parameters":[{"name":"tickers","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":1024,"pattern":"\\S"}},{"name":"docTypes","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":64,"pattern":"^(filing|transcript|news)(,(filing|transcript|news))*$"}},{"name":"sources","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":1024,"pattern":"\\S"}},{"name":"from","in":"query","required":false,"schema":{"type":"string","minLength":10,"maxLength":10,"pattern":"^\\d{4}-\\d{2}-\\d{2}$","format":"date","description":"Valid calendar date (YYYY-MM-DD). from must be on or before to."}},{"name":"to","in":"query","required":false,"schema":{"type":"string","minLength":10,"maxLength":10,"pattern":"^\\d{4}-\\d{2}-\\d{2}$","format":"date","description":"Valid calendar date (YYYY-MM-DD). from must be on or before to."}},{"name":"sort","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":1024,"pattern":"\\S","enum":["relevance","newest","oldest"]}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":100,"default":50}},{"name":"cursor","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":120,"pattern":"^[A-Za-z0-9_-]+$","description":"Opaque: meta.page.nextCursor of the previous page. Bound to this route and query. Pages up to 5,000 rows deep."}},{"name":"count","in":"query","required":false,"schema":{"type":"boolean"}},{"name":"distinct","in":"query","required":false,"schema":{"type":"boolean"}},{"name":"q","in":"query","required":true,"schema":{"type":"string","minLength":1,"maxLength":500,"pattern":"\\S"}},{"$ref":"#/components/parameters/GloomVersion"},{"$ref":"#/components/parameters/IfNoneMatch"}],"x-dataset":"document-search","x-credit-cost":4,"x-credit-call-type":"search","x-credit-multiplier":2,"x-plans":["basic","desk","enterprise"],"x-sample-url":"/v1/datasets/document-search/sample","responses":{"200":{"description":"Stored dataset response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DatasetResponse"}}},"headers":{"Request-Id":{"$ref":"#/components/headers/RequestId"},"Gloom-Version":{"$ref":"#/components/headers/GloomVersion"},"X-Credits-Cost":{"$ref":"#/components/headers/CreditsCost"},"X-Credits-Remaining":{"$ref":"#/components/headers/CreditsRemaining"},"X-Plan":{"$ref":"#/components/headers/Plan"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimitLimit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimitRemaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimitReset"},"ETag":{"$ref":"#/components/headers/ETag"}}},"304":{"$ref":"#/components/responses/NotModified"},"400":{"$ref":"#/components/responses/Error400"},"401":{"$ref":"#/components/responses/Error401"},"402":{"$ref":"#/components/responses/Error402"},"403":{"$ref":"#/components/responses/Error403"},"404":{"$ref":"#/components/responses/Error404"},"429":{"$ref":"#/components/responses/Error429"},"503":{"$ref":"#/components/responses/Error503"}}}},"/v1/document-search/documents/{docType}/{sourceId}":{"get":{"operationId":"document-search.document","tags":["document-search"],"summary":"Indexed document text and chunk metadata","description":"Reads the existing dataset service and needs a key on an account with a plan; every plan reads every live dataset in full. Cached market reads can refresh their source data. Unknown, empty and repeated parameters are rejected. History and coverage metadata are null when the stored service cannot establish them.","parameters":[{"name":"docType","in":"path","required":true,"schema":{"type":"string","minLength":1,"maxLength":1024,"pattern":"\\S","enum":["filing","transcript","news"]}},{"name":"sourceId","in":"path","required":true,"schema":{"type":"string","minLength":1,"maxLength":1024,"pattern":"\\S"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":1000,"default":200}},{"name":"cursor","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":120,"pattern":"^[A-Za-z0-9_-]+$","description":"Opaque: meta.page.nextCursor of the previous page. Bound to this route and query. Pages up to 5,000 rows deep."}},{"$ref":"#/components/parameters/GloomVersion"},{"$ref":"#/components/parameters/IfNoneMatch"}],"x-dataset":"document-search","x-credit-cost":10,"x-credit-call-type":"evidence","x-credit-multiplier":2,"x-plans":["basic","desk","enterprise"],"x-sample-url":"/v1/datasets/document-search/sample","responses":{"200":{"description":"Stored dataset response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DatasetResponse"}}},"headers":{"Request-Id":{"$ref":"#/components/headers/RequestId"},"Gloom-Version":{"$ref":"#/components/headers/GloomVersion"},"X-Credits-Cost":{"$ref":"#/components/headers/CreditsCost"},"X-Credits-Remaining":{"$ref":"#/components/headers/CreditsRemaining"},"X-Plan":{"$ref":"#/components/headers/Plan"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimitLimit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimitRemaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimitReset"},"ETag":{"$ref":"#/components/headers/ETag"}}},"304":{"$ref":"#/components/responses/NotModified"},"400":{"$ref":"#/components/responses/Error400"},"401":{"$ref":"#/components/responses/Error401"},"402":{"$ref":"#/components/responses/Error402"},"403":{"$ref":"#/components/responses/Error403"},"404":{"$ref":"#/components/responses/Error404"},"429":{"$ref":"#/components/responses/Error429"},"503":{"$ref":"#/components/responses/Error503"}}}},"/v1/stories":{"get":{"operationId":"news.list","tags":["news"],"summary":"Publisher stories with ticker and topic filters","description":"Reads the existing dataset service and needs a key on an account with a plan; every plan reads every live dataset in full. Cached market reads can refresh their source data. Unknown, empty and repeated parameters are rejected. History and coverage metadata are null when the stored service cannot establish them.","parameters":[{"name":"feed","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":1024,"pattern":"\\S","enum":["latest","top","breaking","ticker","sector","topic"]}},{"name":"tickers","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":1024,"pattern":"\\S"}},{"name":"tickerTier","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":1024,"pattern":"\\S","enum":["primary","related","any"]}},{"name":"tickerRelations","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":1024,"pattern":"\\S"}},{"name":"topics","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":1024,"pattern":"\\S"}},{"name":"categories","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":1024,"pattern":"\\S"}},{"name":"sectors","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":1024,"pattern":"\\S"}},{"name":"sources","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":1024,"pattern":"\\S"}},{"name":"excludeSources","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":1024,"pattern":"\\S"}},{"name":"sentiment","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":1024,"pattern":"\\S","enum":["positive","neutral","negative"]}},{"name":"minImportance","in":"query","required":false,"schema":{"type":"integer","minimum":0,"maximum":100}},{"name":"minUrgency","in":"query","required":false,"schema":{"type":"integer","minimum":0,"maximum":100}},{"name":"breaking","in":"query","required":false,"schema":{"type":"boolean"}},{"name":"since","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":30,"pattern":"^\\d{4}-\\d{2}-\\d{2}(?:T[0-9:.]+Z)?$","description":"Calendar date or UTC timestamp."}},{"name":"until","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":30,"pattern":"^\\d{4}-\\d{2}-\\d{2}(?:T[0-9:.]+Z)?$","description":"Calendar date or UTC timestamp."}},{"name":"query","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":1024,"pattern":"\\S"}},{"name":"cursor","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":1024,"pattern":"\\S"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":100}},{"$ref":"#/components/parameters/GloomVersion"},{"$ref":"#/components/parameters/IfNoneMatch"}],"x-dataset":"news","x-credit-cost":4,"x-credit-call-type":"search","x-credit-multiplier":2,"x-plans":["basic","desk","enterprise"],"x-sample-url":"/v1/datasets/news/sample","responses":{"200":{"description":"Stored dataset response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DatasetResponse"}}},"headers":{"Request-Id":{"$ref":"#/components/headers/RequestId"},"Gloom-Version":{"$ref":"#/components/headers/GloomVersion"},"X-Credits-Cost":{"$ref":"#/components/headers/CreditsCost"},"X-Credits-Remaining":{"$ref":"#/components/headers/CreditsRemaining"},"X-Plan":{"$ref":"#/components/headers/Plan"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimitLimit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimitRemaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimitReset"},"ETag":{"$ref":"#/components/headers/ETag"}}},"304":{"$ref":"#/components/responses/NotModified"},"400":{"$ref":"#/components/responses/Error400"},"401":{"$ref":"#/components/responses/Error401"},"402":{"$ref":"#/components/responses/Error402"},"403":{"$ref":"#/components/responses/Error403"},"404":{"$ref":"#/components/responses/Error404"},"429":{"$ref":"#/components/responses/Error429"},"503":{"$ref":"#/components/responses/Error503"}}}},"/v1/stories/sources":{"get":{"operationId":"news.sources","tags":["news"],"summary":"News source directory","description":"Reads the existing dataset service and needs a key on an account with a plan; every plan reads every live dataset in full. Cached market reads can refresh their source data. Unknown, empty and repeated parameters are rejected. History and coverage metadata are null when the stored service cannot establish them.","parameters":[{"$ref":"#/components/parameters/GloomVersion"},{"$ref":"#/components/parameters/IfNoneMatch"}],"x-dataset":"news","x-credit-cost":2,"x-credit-call-type":"lookup","x-credit-multiplier":2,"x-plans":["basic","desk","enterprise"],"x-sample-url":"/v1/datasets/news/sample","responses":{"200":{"description":"Stored dataset response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DatasetResponse"}}},"headers":{"Request-Id":{"$ref":"#/components/headers/RequestId"},"Gloom-Version":{"$ref":"#/components/headers/GloomVersion"},"X-Credits-Cost":{"$ref":"#/components/headers/CreditsCost"},"X-Credits-Remaining":{"$ref":"#/components/headers/CreditsRemaining"},"X-Plan":{"$ref":"#/components/headers/Plan"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimitLimit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimitRemaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimitReset"},"ETag":{"$ref":"#/components/headers/ETag"}}},"304":{"$ref":"#/components/responses/NotModified"},"400":{"$ref":"#/components/responses/Error400"},"401":{"$ref":"#/components/responses/Error401"},"402":{"$ref":"#/components/responses/Error402"},"403":{"$ref":"#/components/responses/Error403"},"404":{"$ref":"#/components/responses/Error404"},"429":{"$ref":"#/components/responses/Error429"},"503":{"$ref":"#/components/responses/Error503"}}}},"/v1/stories/facets":{"get":{"operationId":"news.facets","tags":["news"],"summary":"Story topic, sector and source counts","description":"Reads the existing dataset service and needs a key on an account with a plan; every plan reads every live dataset in full. Cached market reads can refresh their source data. Unknown, empty and repeated parameters are rejected. History and coverage metadata are null when the stored service cannot establish them.","parameters":[{"$ref":"#/components/parameters/GloomVersion"},{"$ref":"#/components/parameters/IfNoneMatch"}],"x-dataset":"news","x-credit-cost":2,"x-credit-call-type":"lookup","x-credit-multiplier":2,"x-plans":["basic","desk","enterprise"],"x-sample-url":"/v1/datasets/news/sample","responses":{"200":{"description":"Stored dataset response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DatasetResponse"}}},"headers":{"Request-Id":{"$ref":"#/components/headers/RequestId"},"Gloom-Version":{"$ref":"#/components/headers/GloomVersion"},"X-Credits-Cost":{"$ref":"#/components/headers/CreditsCost"},"X-Credits-Remaining":{"$ref":"#/components/headers/CreditsRemaining"},"X-Plan":{"$ref":"#/components/headers/Plan"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimitLimit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimitRemaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimitReset"},"ETag":{"$ref":"#/components/headers/ETag"}}},"304":{"$ref":"#/components/responses/NotModified"},"400":{"$ref":"#/components/responses/Error400"},"401":{"$ref":"#/components/responses/Error401"},"402":{"$ref":"#/components/responses/Error402"},"403":{"$ref":"#/components/responses/Error403"},"404":{"$ref":"#/components/responses/Error404"},"429":{"$ref":"#/components/responses/Error429"},"503":{"$ref":"#/components/responses/Error503"}}}},"/v1/stories/{id}":{"get":{"operationId":"news.detail","tags":["news"],"summary":"Story and its publisher variants","description":"Reads the existing dataset service and needs a key on an account with a plan; every plan reads every live dataset in full. Cached market reads can refresh their source data. Unknown, empty and repeated parameters are rejected. History and coverage metadata are null when the stored service cannot establish them.","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","minLength":1,"maxLength":1024,"pattern":"\\S"}},{"$ref":"#/components/parameters/GloomVersion"},{"$ref":"#/components/parameters/IfNoneMatch"}],"x-dataset":"news","x-credit-cost":10,"x-credit-call-type":"evidence","x-credit-multiplier":2,"x-plans":["basic","desk","enterprise"],"x-sample-url":"/v1/datasets/news/sample","responses":{"200":{"description":"Stored dataset response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DatasetResponse"}}},"headers":{"Request-Id":{"$ref":"#/components/headers/RequestId"},"Gloom-Version":{"$ref":"#/components/headers/GloomVersion"},"X-Credits-Cost":{"$ref":"#/components/headers/CreditsCost"},"X-Credits-Remaining":{"$ref":"#/components/headers/CreditsRemaining"},"X-Plan":{"$ref":"#/components/headers/Plan"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimitLimit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimitRemaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimitReset"},"ETag":{"$ref":"#/components/headers/ETag"}}},"304":{"$ref":"#/components/responses/NotModified"},"400":{"$ref":"#/components/responses/Error400"},"401":{"$ref":"#/components/responses/Error401"},"402":{"$ref":"#/components/responses/Error402"},"403":{"$ref":"#/components/responses/Error403"},"404":{"$ref":"#/components/responses/Error404"},"429":{"$ref":"#/components/responses/Error429"},"503":{"$ref":"#/components/responses/Error503"}}}},"/v1/social-mentions/{symbol}/history":{"get":{"operationId":"social.history","tags":["social-mentions"],"summary":"Stored daily social mentions and public article views","description":"Reads the existing dataset service and needs a key on an account with a plan; every plan reads every live dataset in full. Cached market reads can refresh their source data. Unknown, empty and repeated parameters are rejected. History and coverage metadata are null when the stored service cannot establish them.","parameters":[{"name":"symbol","in":"path","required":true,"schema":{"type":"string","minLength":1,"maxLength":32,"pattern":"^[A-Za-z0-9.:-]{1,32}$","description":"Company symbol; normalized to uppercase."}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":200,"default":200}},{"name":"cursor","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":120,"pattern":"^[A-Za-z0-9_-]+$","description":"Opaque: meta.page.nextCursor of the previous page. Bound to this route and query."}},{"name":"range","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":1024,"pattern":"\\S","enum":["1y","5y","max"]}},{"$ref":"#/components/parameters/GloomVersion"},{"$ref":"#/components/parameters/IfNoneMatch"}],"x-dataset":"social-mentions","x-credit-cost":2,"x-credit-call-type":"history","x-credit-multiplier":1,"x-plans":["basic","desk","enterprise"],"x-sample-url":"/v1/datasets/social-mentions/sample","responses":{"200":{"description":"Stored dataset response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DatasetResponse"}}},"headers":{"Request-Id":{"$ref":"#/components/headers/RequestId"},"Gloom-Version":{"$ref":"#/components/headers/GloomVersion"},"X-Credits-Cost":{"$ref":"#/components/headers/CreditsCost"},"X-Credits-Remaining":{"$ref":"#/components/headers/CreditsRemaining"},"X-Plan":{"$ref":"#/components/headers/Plan"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimitLimit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimitRemaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimitReset"},"ETag":{"$ref":"#/components/headers/ETag"}}},"304":{"$ref":"#/components/responses/NotModified"},"400":{"$ref":"#/components/responses/Error400"},"401":{"$ref":"#/components/responses/Error401"},"402":{"$ref":"#/components/responses/Error402"},"403":{"$ref":"#/components/responses/Error403"},"404":{"$ref":"#/components/responses/Error404"},"429":{"$ref":"#/components/responses/Error429"},"503":{"$ref":"#/components/responses/Error503"}}}},"/v1/social-mentions/{symbol}/posts":{"get":{"operationId":"social.posts","tags":["social-mentions"],"summary":"Stored public posts mentioning a company ticker","description":"Reads the existing dataset service and needs a key on an account with a plan; every plan reads every live dataset in full. Cached market reads can refresh their source data. Unknown, empty and repeated parameters are rejected. History and coverage metadata are null when the stored service cannot establish them.","parameters":[{"name":"symbol","in":"path","required":true,"schema":{"type":"string","minLength":1,"maxLength":32,"pattern":"^[A-Za-z0-9.:-]{1,32}$","description":"Company symbol; normalized to uppercase."}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":200,"default":100}},{"name":"cursor","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":120,"pattern":"^[A-Za-z0-9_-]+$","description":"Opaque: meta.page.nextCursor of the previous page. Bound to this route and query."}},{"name":"day","in":"query","required":true,"schema":{"type":"string","minLength":10,"maxLength":10,"pattern":"^\\d{4}-\\d{2}-\\d{2}$","format":"date","description":"Valid calendar date (YYYY-MM-DD). from must be on or before to."}},{"$ref":"#/components/parameters/GloomVersion"},{"$ref":"#/components/parameters/IfNoneMatch"}],"x-dataset":"social-mentions","x-credit-cost":2,"x-credit-call-type":"search","x-credit-multiplier":1,"x-plans":["basic","desk","enterprise"],"x-sample-url":"/v1/datasets/social-mentions/sample","responses":{"200":{"description":"Stored dataset response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DatasetResponse"}}},"headers":{"Request-Id":{"$ref":"#/components/headers/RequestId"},"Gloom-Version":{"$ref":"#/components/headers/GloomVersion"},"X-Credits-Cost":{"$ref":"#/components/headers/CreditsCost"},"X-Credits-Remaining":{"$ref":"#/components/headers/CreditsRemaining"},"X-Plan":{"$ref":"#/components/headers/Plan"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimitLimit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimitRemaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimitReset"},"ETag":{"$ref":"#/components/headers/ETag"}}},"304":{"$ref":"#/components/responses/NotModified"},"400":{"$ref":"#/components/responses/Error400"},"401":{"$ref":"#/components/responses/Error401"},"402":{"$ref":"#/components/responses/Error402"},"403":{"$ref":"#/components/responses/Error403"},"404":{"$ref":"#/components/responses/Error404"},"429":{"$ref":"#/components/responses/Error429"},"503":{"$ref":"#/components/responses/Error503"}}}},"/v1/short-volume/{symbol}":{"get":{"operationId":"short-volume.history","tags":["short-volume"],"summary":"Daily off-exchange short-sale volume and ratios","description":"Reads the existing dataset service and needs a key on an account with a plan; every plan reads every live dataset in full. Cached market reads can refresh their source data. Unknown, empty and repeated parameters are rejected. History and coverage metadata are null when the stored service cannot establish them.","parameters":[{"name":"symbol","in":"path","required":true,"schema":{"type":"string","minLength":1,"maxLength":32,"pattern":"^[A-Za-z0-9.:-]{1,32}$","description":"Company symbol; normalized to uppercase."}},{"name":"scope","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":1024,"pattern":"\\S","enum":["nms","otc"]}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":1000}},{"$ref":"#/components/parameters/GloomVersion"},{"$ref":"#/components/parameters/IfNoneMatch"}],"x-dataset":"short-volume","x-credit-cost":2,"x-credit-call-type":"history","x-credit-multiplier":1,"x-plans":["basic","desk","enterprise"],"x-sample-url":"/v1/datasets/short-volume/sample","responses":{"200":{"description":"Stored dataset response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DatasetResponse"}}},"headers":{"Request-Id":{"$ref":"#/components/headers/RequestId"},"Gloom-Version":{"$ref":"#/components/headers/GloomVersion"},"X-Credits-Cost":{"$ref":"#/components/headers/CreditsCost"},"X-Credits-Remaining":{"$ref":"#/components/headers/CreditsRemaining"},"X-Plan":{"$ref":"#/components/headers/Plan"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimitLimit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimitRemaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimitReset"},"ETag":{"$ref":"#/components/headers/ETag"}}},"304":{"$ref":"#/components/responses/NotModified"},"400":{"$ref":"#/components/responses/Error400"},"401":{"$ref":"#/components/responses/Error401"},"402":{"$ref":"#/components/responses/Error402"},"403":{"$ref":"#/components/responses/Error403"},"404":{"$ref":"#/components/responses/Error404"},"429":{"$ref":"#/components/responses/Error429"},"503":{"$ref":"#/components/responses/Error503"}}}},"/v1/short-interest/{symbol}":{"get":{"operationId":"short-interest.history","tags":["short-interest"],"summary":"Settlement-date short interest and days to cover","description":"Reads the existing dataset service and needs a key on an account with a plan; every plan reads every live dataset in full. Cached market reads can refresh their source data. Unknown, empty and repeated parameters are rejected. History and coverage metadata are null when the stored service cannot establish them.","parameters":[{"name":"symbol","in":"path","required":true,"schema":{"type":"string","minLength":1,"maxLength":32,"pattern":"^[A-Za-z0-9.:-]{1,32}$","description":"Company symbol; normalized to uppercase."}},{"name":"years","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":10}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":1000}},{"$ref":"#/components/parameters/GloomVersion"},{"$ref":"#/components/parameters/IfNoneMatch"}],"x-dataset":"short-interest","x-credit-cost":2,"x-credit-call-type":"history","x-credit-multiplier":1,"x-plans":["basic","desk","enterprise"],"x-sample-url":"/v1/datasets/short-interest/sample","responses":{"200":{"description":"Stored dataset response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DatasetResponse"}}},"headers":{"Request-Id":{"$ref":"#/components/headers/RequestId"},"Gloom-Version":{"$ref":"#/components/headers/GloomVersion"},"X-Credits-Cost":{"$ref":"#/components/headers/CreditsCost"},"X-Credits-Remaining":{"$ref":"#/components/headers/CreditsRemaining"},"X-Plan":{"$ref":"#/components/headers/Plan"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimitLimit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimitRemaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimitReset"},"ETag":{"$ref":"#/components/headers/ETag"}}},"304":{"$ref":"#/components/responses/NotModified"},"400":{"$ref":"#/components/responses/Error400"},"401":{"$ref":"#/components/responses/Error401"},"402":{"$ref":"#/components/responses/Error402"},"403":{"$ref":"#/components/responses/Error403"},"404":{"$ref":"#/components/responses/Error404"},"429":{"$ref":"#/components/responses/Error429"},"503":{"$ref":"#/components/responses/Error503"}}}},"/v1/sec/insider-signals":{"get":{"operationId":"sec.insider-signals","tags":["sec"],"summary":"Companies ranked by recent open-market insider buying or selling, with the reasons and filters","description":"Reads the existing dataset service and needs a key on an account with a plan; every plan reads every live dataset in full. Cached market reads can refresh their source data. Unknown, empty and repeated parameters are rejected. History and coverage metadata are null when the stored service cannot establish them.","parameters":[{"name":"side","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":1024,"pattern":"\\S","enum":["buy","sell"]}},{"name":"window","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":1024,"pattern":"\\S"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":50}},{"name":"role","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":1024,"pattern":"\\S","enum":["all","officers","directors","owners"]}},{"name":"minValue","in":"query","required":false,"schema":{"type":"integer","minimum":0,"maximum":1000000000000,"description":"US dollars the insiders traded in the window."}},{"name":"cluster","in":"query","required":false,"schema":{"type":"boolean"}},{"name":"position","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":1024,"pattern":"\\S","enum":["new","exited"],"description":"new on the buy side, exited on the sell side."}},{"name":"cap","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":1024,"pattern":"\\S","enum":["micro","small","mid","large"],"description":"Market value: micro under $300M, small to $2B, mid to $10B, large above."}},{"$ref":"#/components/parameters/GloomVersion"},{"$ref":"#/components/parameters/IfNoneMatch"}],"x-dataset":"sec","x-credit-cost":25,"x-credit-call-type":"bulk","x-credit-multiplier":1,"x-plans":["basic","desk","enterprise"],"x-sample-url":"/v1/datasets/sec/sample","responses":{"200":{"description":"Stored dataset response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DatasetResponse"}}},"headers":{"Request-Id":{"$ref":"#/components/headers/RequestId"},"Gloom-Version":{"$ref":"#/components/headers/GloomVersion"},"X-Credits-Cost":{"$ref":"#/components/headers/CreditsCost"},"X-Credits-Remaining":{"$ref":"#/components/headers/CreditsRemaining"},"X-Plan":{"$ref":"#/components/headers/Plan"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimitLimit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimitRemaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimitReset"},"ETag":{"$ref":"#/components/headers/ETag"}}},"304":{"$ref":"#/components/responses/NotModified"},"400":{"$ref":"#/components/responses/Error400"},"401":{"$ref":"#/components/responses/Error401"},"402":{"$ref":"#/components/responses/Error402"},"403":{"$ref":"#/components/responses/Error403"},"404":{"$ref":"#/components/responses/Error404"},"429":{"$ref":"#/components/responses/Error429"},"503":{"$ref":"#/components/responses/Error503"}}}},"/v1/sec/13f/crowding":{"get":{"operationId":"sec.crowding","tags":["sec"],"summary":"Institutional ownership concentration and fund flows","description":"Reads the existing dataset service and needs a key on an account with a plan; every plan reads every live dataset in full. Cached market reads can refresh their source data. Unknown, empty and repeated parameters are rejected. History and coverage metadata are null when the stored service cannot establish them.","parameters":[{"name":"quarter","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":6,"pattern":"^20[0-9]{2}Q[1-4]$"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":50}},{"$ref":"#/components/parameters/GloomVersion"},{"$ref":"#/components/parameters/IfNoneMatch"}],"x-dataset":"sec","x-credit-cost":25,"x-credit-call-type":"bulk","x-credit-multiplier":1,"x-plans":["basic","desk","enterprise"],"x-sample-url":"/v1/datasets/sec/sample","responses":{"200":{"description":"Stored dataset response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DatasetResponse"}}},"headers":{"Request-Id":{"$ref":"#/components/headers/RequestId"},"Gloom-Version":{"$ref":"#/components/headers/GloomVersion"},"X-Credits-Cost":{"$ref":"#/components/headers/CreditsCost"},"X-Credits-Remaining":{"$ref":"#/components/headers/CreditsRemaining"},"X-Plan":{"$ref":"#/components/headers/Plan"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimitLimit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimitRemaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimitReset"},"ETag":{"$ref":"#/components/headers/ETag"}}},"304":{"$ref":"#/components/responses/NotModified"},"400":{"$ref":"#/components/responses/Error400"},"401":{"$ref":"#/components/responses/Error401"},"402":{"$ref":"#/components/responses/Error402"},"403":{"$ref":"#/components/responses/Error403"},"404":{"$ref":"#/components/responses/Error404"},"429":{"$ref":"#/components/responses/Error429"},"503":{"$ref":"#/components/responses/Error503"}}}},"/v1/congress/trades":{"get":{"operationId":"congress.trades","tags":["congress"],"summary":"Stored congressional transactions with disclosure evidence","description":"Reads the existing dataset service and needs a key on an account with a plan; every plan reads every live dataset in full. Cached market reads can refresh their source data. Unknown, empty and repeated parameters are rejected. History and coverage metadata are null when the stored service cannot establish them.","parameters":[{"name":"chamber","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":1024,"pattern":"\\S","enum":["all","house","senate"]}},{"name":"year","in":"query","required":false,"schema":{"type":"integer","minimum":2008,"maximum":2100,"description":"Disclosure year from 2008 through the current UTC year."}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":500,"default":150}},{"name":"cursor","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":120,"pattern":"^[A-Za-z0-9_-]+$","description":"Opaque: meta.page.nextCursor of the previous page. Bound to this route and query."}},{"name":"filingLimit","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":60}},{"name":"member","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":160,"pattern":"\\S"}},{"name":"ticker","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":32,"pattern":"^[A-Za-z0-9.:-]{1,32}$","description":"Company symbol; normalized to uppercase."}},{"name":"side","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":1024,"pattern":"\\S","enum":["BUY","SELL","EXCHANGE","OTHER"]}},{"name":"owner","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":1024,"pattern":"\\S","enum":["self","spouse","joint","dependent","other"]}},{"name":"assetType","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":1024,"pattern":"\\S","enum":["stock","option","other"]}},{"name":"minAmount","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":31,"pattern":"^\\d{1,24}(?:\\.\\d{1,6})?$"}},{"$ref":"#/components/parameters/GloomVersion"},{"$ref":"#/components/parameters/IfNoneMatch"}],"x-dataset":"congress","x-credit-cost":2,"x-credit-call-type":"search","x-credit-multiplier":1,"x-plans":["basic","desk","enterprise"],"x-sample-url":"/v1/datasets/congress/sample","responses":{"200":{"description":"Stored dataset response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DatasetResponse"}}},"headers":{"Request-Id":{"$ref":"#/components/headers/RequestId"},"Gloom-Version":{"$ref":"#/components/headers/GloomVersion"},"X-Credits-Cost":{"$ref":"#/components/headers/CreditsCost"},"X-Credits-Remaining":{"$ref":"#/components/headers/CreditsRemaining"},"X-Plan":{"$ref":"#/components/headers/Plan"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimitLimit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimitRemaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimitReset"},"ETag":{"$ref":"#/components/headers/ETag"}}},"304":{"$ref":"#/components/responses/NotModified"},"400":{"$ref":"#/components/responses/Error400"},"401":{"$ref":"#/components/responses/Error401"},"402":{"$ref":"#/components/responses/Error402"},"403":{"$ref":"#/components/responses/Error403"},"404":{"$ref":"#/components/responses/Error404"},"429":{"$ref":"#/components/responses/Error429"},"503":{"$ref":"#/components/responses/Error503"}}}},"/v1/congress/members/{member}":{"get":{"operationId":"congress.member","tags":["congress"],"summary":"Stored transactions for a congressional member","description":"Reads the existing dataset service and needs a key on an account with a plan; every plan reads every live dataset in full. Cached market reads can refresh their source data. Unknown, empty and repeated parameters are rejected. History and coverage metadata are null when the stored service cannot establish them.","parameters":[{"name":"member","in":"path","required":true,"schema":{"type":"string","minLength":1,"maxLength":160,"pattern":"\\S"}},{"name":"chamber","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":1024,"pattern":"\\S","enum":["all","house","senate"]}},{"name":"year","in":"query","required":false,"schema":{"type":"integer","minimum":2008,"maximum":2100,"description":"Disclosure year from 2008 through the current UTC year."}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":500,"default":150}},{"name":"cursor","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":120,"pattern":"^[A-Za-z0-9_-]+$","description":"Opaque: meta.page.nextCursor of the previous page. Bound to this route and query."}},{"name":"filingLimit","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":60}},{"name":"ticker","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":32,"pattern":"^[A-Za-z0-9.:-]{1,32}$","description":"Company symbol; normalized to uppercase."}},{"name":"side","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":1024,"pattern":"\\S","enum":["BUY","SELL","EXCHANGE","OTHER"]}},{"name":"owner","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":1024,"pattern":"\\S","enum":["self","spouse","joint","dependent","other"]}},{"name":"assetType","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":1024,"pattern":"\\S","enum":["stock","option","other"]}},{"name":"minAmount","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":31,"pattern":"^\\d{1,24}(?:\\.\\d{1,6})?$"}},{"$ref":"#/components/parameters/GloomVersion"},{"$ref":"#/components/parameters/IfNoneMatch"}],"x-dataset":"congress","x-credit-cost":2,"x-credit-call-type":"search","x-credit-multiplier":1,"x-plans":["basic","desk","enterprise"],"x-sample-url":"/v1/datasets/congress/sample","responses":{"200":{"description":"Stored dataset response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DatasetResponse"}}},"headers":{"Request-Id":{"$ref":"#/components/headers/RequestId"},"Gloom-Version":{"$ref":"#/components/headers/GloomVersion"},"X-Credits-Cost":{"$ref":"#/components/headers/CreditsCost"},"X-Credits-Remaining":{"$ref":"#/components/headers/CreditsRemaining"},"X-Plan":{"$ref":"#/components/headers/Plan"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimitLimit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimitRemaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimitReset"},"ETag":{"$ref":"#/components/headers/ETag"}}},"304":{"$ref":"#/components/responses/NotModified"},"400":{"$ref":"#/components/responses/Error400"},"401":{"$ref":"#/components/responses/Error401"},"402":{"$ref":"#/components/responses/Error402"},"403":{"$ref":"#/components/responses/Error403"},"404":{"$ref":"#/components/responses/Error404"},"429":{"$ref":"#/components/responses/Error429"},"503":{"$ref":"#/components/responses/Error503"}}}},"/v1/congress/tickers/{symbol}":{"get":{"operationId":"congress.ticker","tags":["congress"],"summary":"Stored congressional transactions for a company ticker","description":"Reads the existing dataset service and needs a key on an account with a plan; every plan reads every live dataset in full. Cached market reads can refresh their source data. Unknown, empty and repeated parameters are rejected. History and coverage metadata are null when the stored service cannot establish them.","parameters":[{"name":"symbol","in":"path","required":true,"schema":{"type":"string","minLength":1,"maxLength":32,"pattern":"^[A-Za-z0-9.:-]{1,32}$","description":"Company symbol; normalized to uppercase."}},{"name":"chamber","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":1024,"pattern":"\\S","enum":["all","house","senate"]}},{"name":"year","in":"query","required":false,"schema":{"type":"integer","minimum":2008,"maximum":2100,"description":"Disclosure year from 2008 through the current UTC year."}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":500,"default":150}},{"name":"cursor","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":120,"pattern":"^[A-Za-z0-9_-]+$","description":"Opaque: meta.page.nextCursor of the previous page. Bound to this route and query."}},{"name":"filingLimit","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":60}},{"name":"member","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":160,"pattern":"\\S"}},{"name":"side","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":1024,"pattern":"\\S","enum":["BUY","SELL","EXCHANGE","OTHER"]}},{"name":"owner","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":1024,"pattern":"\\S","enum":["self","spouse","joint","dependent","other"]}},{"name":"assetType","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":1024,"pattern":"\\S","enum":["stock","option","other"]}},{"name":"minAmount","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":31,"pattern":"^\\d{1,24}(?:\\.\\d{1,6})?$"}},{"$ref":"#/components/parameters/GloomVersion"},{"$ref":"#/components/parameters/IfNoneMatch"}],"x-dataset":"congress","x-credit-cost":2,"x-credit-call-type":"search","x-credit-multiplier":1,"x-plans":["basic","desk","enterprise"],"x-sample-url":"/v1/datasets/congress/sample","responses":{"200":{"description":"Stored dataset response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DatasetResponse"}}},"headers":{"Request-Id":{"$ref":"#/components/headers/RequestId"},"Gloom-Version":{"$ref":"#/components/headers/GloomVersion"},"X-Credits-Cost":{"$ref":"#/components/headers/CreditsCost"},"X-Credits-Remaining":{"$ref":"#/components/headers/CreditsRemaining"},"X-Plan":{"$ref":"#/components/headers/Plan"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimitLimit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimitRemaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimitReset"},"ETag":{"$ref":"#/components/headers/ETag"}}},"304":{"$ref":"#/components/responses/NotModified"},"400":{"$ref":"#/components/responses/Error400"},"401":{"$ref":"#/components/responses/Error401"},"402":{"$ref":"#/components/responses/Error402"},"403":{"$ref":"#/components/responses/Error403"},"404":{"$ref":"#/components/responses/Error404"},"429":{"$ref":"#/components/responses/Error429"},"503":{"$ref":"#/components/responses/Error503"}}}},"/v1/macro/curves":{"get":{"operationId":"macro.curves","tags":["macro"],"summary":"Government yield curves by country","description":"Reads the existing dataset service and needs a key on an account with a plan; every plan reads every live dataset in full. Cached market reads can refresh their source data. Unknown, empty and repeated parameters are rejected. History and coverage metadata are null when the stored service cannot establish them.","parameters":[{"$ref":"#/components/parameters/GloomVersion"},{"$ref":"#/components/parameters/IfNoneMatch"}],"x-dataset":"macro","x-credit-cost":1,"x-credit-call-type":"lookup","x-credit-multiplier":1,"x-plans":["basic","desk","enterprise"],"x-sample-url":"/v1/datasets/macro/sample","responses":{"200":{"description":"Stored dataset response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DatasetResponse"}}},"headers":{"Request-Id":{"$ref":"#/components/headers/RequestId"},"Gloom-Version":{"$ref":"#/components/headers/GloomVersion"},"X-Credits-Cost":{"$ref":"#/components/headers/CreditsCost"},"X-Credits-Remaining":{"$ref":"#/components/headers/CreditsRemaining"},"X-Plan":{"$ref":"#/components/headers/Plan"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimitLimit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimitRemaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimitReset"},"ETag":{"$ref":"#/components/headers/ETag"}}},"304":{"$ref":"#/components/responses/NotModified"},"400":{"$ref":"#/components/responses/Error400"},"401":{"$ref":"#/components/responses/Error401"},"402":{"$ref":"#/components/responses/Error402"},"403":{"$ref":"#/components/responses/Error403"},"404":{"$ref":"#/components/responses/Error404"},"429":{"$ref":"#/components/responses/Error429"},"503":{"$ref":"#/components/responses/Error503"}}}},"/v1/macro/curves/{curve}":{"get":{"operationId":"macro.curve","tags":["macro"],"summary":"Yield curve with dated lookbacks, spreads and ranked moves","description":"Reads the existing dataset service and needs a key on an account with a plan; every plan reads every live dataset in full. Cached market reads can refresh their source data. Unknown, empty and repeated parameters are rejected. History and coverage metadata are null when the stored service cannot establish them.","parameters":[{"name":"curve","in":"path","required":true,"schema":{"type":"string","minLength":1,"maxLength":1024,"pattern":"\\S","enum":["us","us-real","us-breakeven","eu-aaa","de","gb","jp","ca"]}},{"name":"date","in":"query","required":false,"schema":{"type":"string","minLength":10,"maxLength":10,"pattern":"^\\d{4}-\\d{2}-\\d{2}$","format":"date","description":"Valid calendar date (YYYY-MM-DD). from must be on or before to."}},{"$ref":"#/components/parameters/GloomVersion"},{"$ref":"#/components/parameters/IfNoneMatch"}],"x-dataset":"macro","x-credit-cost":2,"x-credit-call-type":"history","x-credit-multiplier":1,"x-plans":["basic","desk","enterprise"],"x-sample-url":"/v1/datasets/macro/sample","responses":{"200":{"description":"Stored dataset response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DatasetResponse"}}},"headers":{"Request-Id":{"$ref":"#/components/headers/RequestId"},"Gloom-Version":{"$ref":"#/components/headers/GloomVersion"},"X-Credits-Cost":{"$ref":"#/components/headers/CreditsCost"},"X-Credits-Remaining":{"$ref":"#/components/headers/CreditsRemaining"},"X-Plan":{"$ref":"#/components/headers/Plan"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimitLimit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimitRemaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimitReset"},"ETag":{"$ref":"#/components/headers/ETag"}}},"304":{"$ref":"#/components/responses/NotModified"},"400":{"$ref":"#/components/responses/Error400"},"401":{"$ref":"#/components/responses/Error401"},"402":{"$ref":"#/components/responses/Error402"},"403":{"$ref":"#/components/responses/Error403"},"404":{"$ref":"#/components/responses/Error404"},"429":{"$ref":"#/components/responses/Error429"},"503":{"$ref":"#/components/responses/Error503"}}}},"/v1/macro/series/{seriesId}":{"get":{"operationId":"macro.series","tags":["macro"],"summary":"Stored economic series observations and metadata","description":"Reads the existing dataset service and needs a key on an account with a plan; every plan reads every live dataset in full. Cached market reads can refresh their source data. Unknown, empty and repeated parameters are rejected. History and coverage metadata are null when the stored service cannot establish them.","parameters":[{"name":"seriesId","in":"path","required":true,"schema":{"type":"string","minLength":1,"maxLength":40,"pattern":"^[A-Za-z0-9]{1,40}$"}},{"name":"from","in":"query","required":false,"schema":{"type":"string","minLength":10,"maxLength":10,"pattern":"^\\d{4}-\\d{2}-\\d{2}$","format":"date","description":"Valid calendar date (YYYY-MM-DD). from must be on or before to."}},{"name":"to","in":"query","required":false,"schema":{"type":"string","minLength":10,"maxLength":10,"pattern":"^\\d{4}-\\d{2}-\\d{2}$","format":"date","description":"Valid calendar date (YYYY-MM-DD). from must be on or before to."}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":1000}},{"name":"sortOrder","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":1024,"pattern":"\\S","enum":["asc","desc"]}},{"$ref":"#/components/parameters/GloomVersion"},{"$ref":"#/components/parameters/IfNoneMatch"}],"x-dataset":"macro","x-credit-cost":2,"x-credit-call-type":"history","x-credit-multiplier":1,"x-plans":["basic","desk","enterprise"],"x-sample-url":"/v1/datasets/macro/sample","responses":{"200":{"description":"Stored dataset response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DatasetResponse"}}},"headers":{"Request-Id":{"$ref":"#/components/headers/RequestId"},"Gloom-Version":{"$ref":"#/components/headers/GloomVersion"},"X-Credits-Cost":{"$ref":"#/components/headers/CreditsCost"},"X-Credits-Remaining":{"$ref":"#/components/headers/CreditsRemaining"},"X-Plan":{"$ref":"#/components/headers/Plan"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimitLimit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimitRemaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimitReset"},"ETag":{"$ref":"#/components/headers/ETag"}}},"304":{"$ref":"#/components/responses/NotModified"},"400":{"$ref":"#/components/responses/Error400"},"401":{"$ref":"#/components/responses/Error401"},"402":{"$ref":"#/components/responses/Error402"},"403":{"$ref":"#/components/responses/Error403"},"404":{"$ref":"#/components/responses/Error404"},"429":{"$ref":"#/components/responses/Error429"},"503":{"$ref":"#/components/responses/Error503"}}}},"/v1/macro/calendar":{"get":{"operationId":"macro.calendar","tags":["macro"],"summary":"Economic releases, forecasts and reported actuals","description":"Reads the existing dataset service and needs a key on an account with a plan; every plan reads every live dataset in full. Cached market reads can refresh their source data. Unknown, empty and repeated parameters are rejected. History and coverage metadata are null when the stored service cannot establish them.","parameters":[{"$ref":"#/components/parameters/GloomVersion"},{"$ref":"#/components/parameters/IfNoneMatch"}],"x-dataset":"macro","x-credit-cost":1,"x-credit-call-type":"lookup","x-credit-multiplier":1,"x-plans":["basic","desk","enterprise"],"x-sample-url":"/v1/datasets/macro/sample","responses":{"200":{"description":"Stored dataset response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DatasetResponse"}}},"headers":{"Request-Id":{"$ref":"#/components/headers/RequestId"},"Gloom-Version":{"$ref":"#/components/headers/GloomVersion"},"X-Credits-Cost":{"$ref":"#/components/headers/CreditsCost"},"X-Credits-Remaining":{"$ref":"#/components/headers/CreditsRemaining"},"X-Plan":{"$ref":"#/components/headers/Plan"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimitLimit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimitRemaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimitReset"},"ETag":{"$ref":"#/components/headers/ETag"}}},"304":{"$ref":"#/components/responses/NotModified"},"400":{"$ref":"#/components/responses/Error400"},"401":{"$ref":"#/components/responses/Error401"},"402":{"$ref":"#/components/responses/Error402"},"403":{"$ref":"#/components/responses/Error403"},"404":{"$ref":"#/components/responses/Error404"},"429":{"$ref":"#/components/responses/Error429"},"503":{"$ref":"#/components/responses/Error503"}}}},"/v1/central-bank-rates":{"get":{"operationId":"central-bank-rates.board","tags":["central-bank-rates"],"summary":"Policy rates, changes and meeting dates","description":"Reads the existing dataset service and needs a key on an account with a plan; every plan reads every live dataset in full. Cached market reads can refresh their source data. Unknown, empty and repeated parameters are rejected. History and coverage metadata are null when the stored service cannot establish them.","parameters":[{"$ref":"#/components/parameters/GloomVersion"},{"$ref":"#/components/parameters/IfNoneMatch"}],"x-dataset":"central-bank-rates","x-credit-cost":2,"x-credit-call-type":"history","x-credit-multiplier":1,"x-plans":["basic","desk","enterprise"],"x-sample-url":"/v1/datasets/central-bank-rates/sample","responses":{"200":{"description":"Stored dataset response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DatasetResponse"}}},"headers":{"Request-Id":{"$ref":"#/components/headers/RequestId"},"Gloom-Version":{"$ref":"#/components/headers/GloomVersion"},"X-Credits-Cost":{"$ref":"#/components/headers/CreditsCost"},"X-Credits-Remaining":{"$ref":"#/components/headers/CreditsRemaining"},"X-Plan":{"$ref":"#/components/headers/Plan"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimitLimit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimitRemaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimitReset"},"ETag":{"$ref":"#/components/headers/ETag"}}},"304":{"$ref":"#/components/responses/NotModified"},"400":{"$ref":"#/components/responses/Error400"},"401":{"$ref":"#/components/responses/Error401"},"402":{"$ref":"#/components/responses/Error402"},"403":{"$ref":"#/components/responses/Error403"},"404":{"$ref":"#/components/responses/Error404"},"429":{"$ref":"#/components/responses/Error429"},"503":{"$ref":"#/components/responses/Error503"}}}},"/v1/cds":{"get":{"operationId":"cds.trades","tags":["cds"],"summary":"Reported corporate credit derivatives trades","description":"Reads the existing dataset service and needs a key on an account with a plan; every plan reads every live dataset in full. Cached market reads can refresh their source data. Unknown, empty and repeated parameters are rejected. History and coverage metadata are null when the stored service cannot establish them.","parameters":[{"name":"issuer","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":120,"pattern":"\\S"}},{"name":"days","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":90}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":1000}},{"$ref":"#/components/parameters/GloomVersion"},{"$ref":"#/components/parameters/IfNoneMatch"}],"x-dataset":"cds","x-credit-cost":4,"x-credit-call-type":"search","x-credit-multiplier":2,"x-plans":["basic","desk","enterprise"],"x-sample-url":"/v1/datasets/cds/sample","responses":{"200":{"description":"Stored dataset response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DatasetResponse"}}},"headers":{"Request-Id":{"$ref":"#/components/headers/RequestId"},"Gloom-Version":{"$ref":"#/components/headers/GloomVersion"},"X-Credits-Cost":{"$ref":"#/components/headers/CreditsCost"},"X-Credits-Remaining":{"$ref":"#/components/headers/CreditsRemaining"},"X-Plan":{"$ref":"#/components/headers/Plan"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimitLimit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimitRemaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimitReset"},"ETag":{"$ref":"#/components/headers/ETag"}}},"304":{"$ref":"#/components/responses/NotModified"},"400":{"$ref":"#/components/responses/Error400"},"401":{"$ref":"#/components/responses/Error401"},"402":{"$ref":"#/components/responses/Error402"},"403":{"$ref":"#/components/responses/Error403"},"404":{"$ref":"#/components/responses/Error404"},"429":{"$ref":"#/components/responses/Error429"},"503":{"$ref":"#/components/responses/Error503"}}}},"/v1/cds/history":{"get":{"operationId":"cds.history","tags":["cds"],"summary":"Daily five-year corporate credit spreads","description":"Reads the existing dataset service and needs a key on an account with a plan; every plan reads every live dataset in full. Cached market reads can refresh their source data. Unknown, empty and repeated parameters are rejected. History and coverage metadata are null when the stored service cannot establish them.","parameters":[{"name":"days","in":"query","required":false,"schema":{"type":"integer","minimum":30,"maximum":1000}},{"name":"issuer","in":"query","required":true,"schema":{"type":"string","minLength":1,"maxLength":120,"pattern":"\\S"}},{"$ref":"#/components/parameters/GloomVersion"},{"$ref":"#/components/parameters/IfNoneMatch"}],"x-dataset":"cds","x-credit-cost":4,"x-credit-call-type":"history","x-credit-multiplier":2,"x-plans":["basic","desk","enterprise"],"x-sample-url":"/v1/datasets/cds/sample","responses":{"200":{"description":"Stored dataset response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DatasetResponse"}}},"headers":{"Request-Id":{"$ref":"#/components/headers/RequestId"},"Gloom-Version":{"$ref":"#/components/headers/GloomVersion"},"X-Credits-Cost":{"$ref":"#/components/headers/CreditsCost"},"X-Credits-Remaining":{"$ref":"#/components/headers/CreditsRemaining"},"X-Plan":{"$ref":"#/components/headers/Plan"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimitLimit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimitRemaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimitReset"},"ETag":{"$ref":"#/components/headers/ETag"}}},"304":{"$ref":"#/components/responses/NotModified"},"400":{"$ref":"#/components/responses/Error400"},"401":{"$ref":"#/components/responses/Error401"},"402":{"$ref":"#/components/responses/Error402"},"403":{"$ref":"#/components/responses/Error403"},"404":{"$ref":"#/components/responses/Error404"},"429":{"$ref":"#/components/responses/Error429"},"503":{"$ref":"#/components/responses/Error503"}}}},"/v1/cds/indexes":{"get":{"operationId":"cds.indexes","tags":["cds"],"summary":"Credit index levels and daily history","description":"Reads the existing dataset service and needs a key on an account with a plan; every plan reads every live dataset in full. Cached market reads can refresh their source data. Unknown, empty and repeated parameters are rejected. History and coverage metadata are null when the stored service cannot establish them.","parameters":[{"name":"days","in":"query","required":false,"schema":{"type":"integer","minimum":30,"maximum":1000}},{"$ref":"#/components/parameters/GloomVersion"},{"$ref":"#/components/parameters/IfNoneMatch"}],"x-dataset":"cds","x-credit-cost":50,"x-credit-call-type":"bulk","x-credit-multiplier":2,"x-plans":["basic","desk","enterprise"],"x-sample-url":"/v1/datasets/cds/sample","responses":{"200":{"description":"Stored dataset response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DatasetResponse"}}},"headers":{"Request-Id":{"$ref":"#/components/headers/RequestId"},"Gloom-Version":{"$ref":"#/components/headers/GloomVersion"},"X-Credits-Cost":{"$ref":"#/components/headers/CreditsCost"},"X-Credits-Remaining":{"$ref":"#/components/headers/CreditsRemaining"},"X-Plan":{"$ref":"#/components/headers/Plan"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimitLimit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimitRemaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimitReset"},"ETag":{"$ref":"#/components/headers/ETag"}}},"304":{"$ref":"#/components/responses/NotModified"},"400":{"$ref":"#/components/responses/Error400"},"401":{"$ref":"#/components/responses/Error401"},"402":{"$ref":"#/components/responses/Error402"},"403":{"$ref":"#/components/responses/Error403"},"404":{"$ref":"#/components/responses/Error404"},"429":{"$ref":"#/components/responses/Error429"},"503":{"$ref":"#/components/responses/Error503"}}}},"/v1/cds/sovereigns":{"get":{"operationId":"cds.sovereigns","tags":["cds"],"summary":"Sovereign credit spreads and daily history","description":"Reads the existing dataset service and needs a key on an account with a plan; every plan reads every live dataset in full. Cached market reads can refresh their source data. Unknown, empty and repeated parameters are rejected. History and coverage metadata are null when the stored service cannot establish them.","parameters":[{"name":"days","in":"query","required":false,"schema":{"type":"integer","minimum":30,"maximum":1000}},{"$ref":"#/components/parameters/GloomVersion"},{"$ref":"#/components/parameters/IfNoneMatch"}],"x-dataset":"cds","x-credit-cost":50,"x-credit-call-type":"bulk","x-credit-multiplier":2,"x-plans":["basic","desk","enterprise"],"x-sample-url":"/v1/datasets/cds/sample","responses":{"200":{"description":"Stored dataset response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DatasetResponse"}}},"headers":{"Request-Id":{"$ref":"#/components/headers/RequestId"},"Gloom-Version":{"$ref":"#/components/headers/GloomVersion"},"X-Credits-Cost":{"$ref":"#/components/headers/CreditsCost"},"X-Credits-Remaining":{"$ref":"#/components/headers/CreditsRemaining"},"X-Plan":{"$ref":"#/components/headers/Plan"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimitLimit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimitRemaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimitReset"},"ETag":{"$ref":"#/components/headers/ETag"}}},"304":{"$ref":"#/components/responses/NotModified"},"400":{"$ref":"#/components/responses/Error400"},"401":{"$ref":"#/components/responses/Error401"},"402":{"$ref":"#/components/responses/Error402"},"403":{"$ref":"#/components/responses/Error403"},"404":{"$ref":"#/components/responses/Error404"},"429":{"$ref":"#/components/responses/Error429"},"503":{"$ref":"#/components/responses/Error503"}}}},"/v1/fundamentals/{symbol}/statements":{"get":{"operationId":"fundamentals.statements","tags":["market-data"],"summary":"Annual or quarterly income, balance sheet and cash flow statements","description":"Reads the existing dataset service and needs a key on an account with a plan; every plan reads every live dataset in full. Cached market reads can refresh their source data. Unknown, empty and repeated parameters are rejected. History and coverage metadata are null when the stored service cannot establish them.","parameters":[{"name":"symbol","in":"path","required":true,"schema":{"type":"string","minLength":1,"maxLength":32,"pattern":"^[A-Za-z0-9.:-]{1,32}$","description":"Company symbol; normalized to uppercase."}},{"name":"exchange","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":1024,"pattern":"\\S"}},{"name":"period","in":"query","required":false,"description":"Statement period, annual by default.","schema":{"type":"string","minLength":1,"maxLength":1024,"pattern":"\\S","enum":["annual","quarterly"],"description":"Statement period, annual by default."}},{"$ref":"#/components/parameters/GloomVersion"},{"$ref":"#/components/parameters/IfNoneMatch"}],"x-dataset":"market-data","x-credit-cost":20,"x-credit-call-type":"evidence","x-credit-multiplier":4,"x-plans":["basic","desk","enterprise"],"x-sample-url":"/v1/datasets/market-data/sample","responses":{"200":{"description":"Stored dataset response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DatasetResponse"}}},"headers":{"Request-Id":{"$ref":"#/components/headers/RequestId"},"Gloom-Version":{"$ref":"#/components/headers/GloomVersion"},"X-Credits-Cost":{"$ref":"#/components/headers/CreditsCost"},"X-Credits-Remaining":{"$ref":"#/components/headers/CreditsRemaining"},"X-Plan":{"$ref":"#/components/headers/Plan"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimitLimit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimitRemaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimitReset"},"ETag":{"$ref":"#/components/headers/ETag"}}},"304":{"$ref":"#/components/responses/NotModified"},"400":{"$ref":"#/components/responses/Error400"},"401":{"$ref":"#/components/responses/Error401"},"402":{"$ref":"#/components/responses/Error402"},"403":{"$ref":"#/components/responses/Error403"},"404":{"$ref":"#/components/responses/Error404"},"429":{"$ref":"#/components/responses/Error429"},"503":{"$ref":"#/components/responses/Error503"}}}},"/v1/fundamentals/{symbol}/statistics":{"get":{"operationId":"fundamentals.statistics","tags":["market-data"],"summary":"Company valuation ratios and key financial statistics","description":"Reads the existing dataset service and needs a key on an account with a plan; every plan reads every live dataset in full. Cached market reads can refresh their source data. Unknown, empty and repeated parameters are rejected. History and coverage metadata are null when the stored service cannot establish them.","parameters":[{"name":"symbol","in":"path","required":true,"schema":{"type":"string","minLength":1,"maxLength":32,"pattern":"^[A-Za-z0-9.:-]{1,32}$","description":"Company symbol; normalized to uppercase."}},{"name":"exchange","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":1024,"pattern":"\\S"}},{"$ref":"#/components/parameters/GloomVersion"},{"$ref":"#/components/parameters/IfNoneMatch"}],"x-dataset":"market-data","x-credit-cost":20,"x-credit-call-type":"evidence","x-credit-multiplier":4,"x-plans":["basic","desk","enterprise"],"x-sample-url":"/v1/datasets/market-data/sample","responses":{"200":{"description":"Stored dataset response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DatasetResponse"}}},"headers":{"Request-Id":{"$ref":"#/components/headers/RequestId"},"Gloom-Version":{"$ref":"#/components/headers/GloomVersion"},"X-Credits-Cost":{"$ref":"#/components/headers/CreditsCost"},"X-Credits-Remaining":{"$ref":"#/components/headers/CreditsRemaining"},"X-Plan":{"$ref":"#/components/headers/Plan"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimitLimit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimitRemaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimitReset"},"ETag":{"$ref":"#/components/headers/ETag"}}},"304":{"$ref":"#/components/responses/NotModified"},"400":{"$ref":"#/components/responses/Error400"},"401":{"$ref":"#/components/responses/Error401"},"402":{"$ref":"#/components/responses/Error402"},"403":{"$ref":"#/components/responses/Error403"},"404":{"$ref":"#/components/responses/Error404"},"429":{"$ref":"#/components/responses/Error429"},"503":{"$ref":"#/components/responses/Error503"}}}},"/v1/fundamentals/{symbol}/profile":{"get":{"operationId":"fundamentals.profile","tags":["market-data"],"summary":"Company business description and profile","description":"Reads the existing dataset service and needs a key on an account with a plan; every plan reads every live dataset in full. Cached market reads can refresh their source data. Unknown, empty and repeated parameters are rejected. History and coverage metadata are null when the stored service cannot establish them.","parameters":[{"name":"symbol","in":"path","required":true,"schema":{"type":"string","minLength":1,"maxLength":32,"pattern":"^[A-Za-z0-9.:-]{1,32}$","description":"Company symbol; normalized to uppercase."}},{"name":"exchange","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":1024,"pattern":"\\S"}},{"$ref":"#/components/parameters/GloomVersion"},{"$ref":"#/components/parameters/IfNoneMatch"}],"x-dataset":"market-data","x-credit-cost":10,"x-credit-call-type":"evidence","x-credit-multiplier":2,"x-plans":["basic","desk","enterprise"],"x-sample-url":"/v1/datasets/market-data/sample","responses":{"200":{"description":"Stored dataset response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DatasetResponse"}}},"headers":{"Request-Id":{"$ref":"#/components/headers/RequestId"},"Gloom-Version":{"$ref":"#/components/headers/GloomVersion"},"X-Credits-Cost":{"$ref":"#/components/headers/CreditsCost"},"X-Credits-Remaining":{"$ref":"#/components/headers/CreditsRemaining"},"X-Plan":{"$ref":"#/components/headers/Plan"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimitLimit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimitRemaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimitReset"},"ETag":{"$ref":"#/components/headers/ETag"}}},"304":{"$ref":"#/components/responses/NotModified"},"400":{"$ref":"#/components/responses/Error400"},"401":{"$ref":"#/components/responses/Error401"},"402":{"$ref":"#/components/responses/Error402"},"403":{"$ref":"#/components/responses/Error403"},"404":{"$ref":"#/components/responses/Error404"},"429":{"$ref":"#/components/responses/Error429"},"503":{"$ref":"#/components/responses/Error503"}}}},"/v1/market/quotes":{"get":{"operationId":"market.quotes","tags":["market-data"],"summary":"Delayed market quotes for up to ten tickers","description":"Reads the existing dataset service and needs a key on an account with a plan; every plan reads every live dataset in full. Cached market reads can refresh their source data. Unknown, empty and repeated parameters are rejected. History and coverage metadata are null when the stored service cannot establish them.","parameters":[{"name":"tickers","in":"query","required":true,"description":"Comma-separated tickers, at most ten.","schema":{"type":"string","minLength":1,"maxLength":1024,"pattern":"\\S","description":"Comma-separated tickers, at most ten."}},{"$ref":"#/components/parameters/GloomVersion"},{"$ref":"#/components/parameters/IfNoneMatch"}],"x-dataset":"market-data","x-credit-cost":4,"x-credit-call-type":"search","x-credit-multiplier":2,"x-plans":["basic","desk","enterprise"],"x-sample-url":"/v1/datasets/market-data/sample","responses":{"200":{"description":"Stored dataset response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DatasetResponse"}}},"headers":{"Request-Id":{"$ref":"#/components/headers/RequestId"},"Gloom-Version":{"$ref":"#/components/headers/GloomVersion"},"X-Credits-Cost":{"$ref":"#/components/headers/CreditsCost"},"X-Credits-Remaining":{"$ref":"#/components/headers/CreditsRemaining"},"X-Plan":{"$ref":"#/components/headers/Plan"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimitLimit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimitRemaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimitReset"},"ETag":{"$ref":"#/components/headers/ETag"}}},"304":{"$ref":"#/components/responses/NotModified"},"400":{"$ref":"#/components/responses/Error400"},"401":{"$ref":"#/components/responses/Error401"},"402":{"$ref":"#/components/responses/Error402"},"403":{"$ref":"#/components/responses/Error403"},"404":{"$ref":"#/components/responses/Error404"},"429":{"$ref":"#/components/responses/Error429"},"503":{"$ref":"#/components/responses/Error503"}}}},"/v1/market/data":{"get":{"operationId":"market.data","tags":["market-data"],"summary":"Field-level data for one ticker","description":"Reads the existing dataset service and needs a key on an account with a plan; every plan reads every live dataset in full. Cached market reads can refresh their source data. Unknown, empty and repeated parameters are rejected. History and coverage metadata are null when the stored service cannot establish them.","parameters":[{"name":"tickers","in":"query","required":true,"description":"One ticker per call.","schema":{"type":"string","minLength":1,"maxLength":1024,"pattern":"\\S","description":"One ticker per call."}},{"name":"fields","in":"query","required":true,"description":"Comma-separated field names, at most 25.","schema":{"type":"string","minLength":1,"maxLength":1024,"pattern":"\\S","description":"Comma-separated field names, at most 25."}},{"name":"period","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":1024,"pattern":"\\S","enum":["annual","quarterly"]}},{"$ref":"#/components/parameters/GloomVersion"},{"$ref":"#/components/parameters/IfNoneMatch"}],"x-dataset":"market-data","x-credit-cost":20,"x-credit-call-type":"evidence","x-credit-multiplier":4,"x-plans":["basic","desk","enterprise"],"x-sample-url":"/v1/datasets/market-data/sample","responses":{"200":{"description":"Stored dataset response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DatasetResponse"}}},"headers":{"Request-Id":{"$ref":"#/components/headers/RequestId"},"Gloom-Version":{"$ref":"#/components/headers/GloomVersion"},"X-Credits-Cost":{"$ref":"#/components/headers/CreditsCost"},"X-Credits-Remaining":{"$ref":"#/components/headers/CreditsRemaining"},"X-Plan":{"$ref":"#/components/headers/Plan"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimitLimit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimitRemaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimitReset"},"ETag":{"$ref":"#/components/headers/ETag"}}},"304":{"$ref":"#/components/responses/NotModified"},"400":{"$ref":"#/components/responses/Error400"},"401":{"$ref":"#/components/responses/Error401"},"402":{"$ref":"#/components/responses/Error402"},"403":{"$ref":"#/components/responses/Error403"},"404":{"$ref":"#/components/responses/Error404"},"429":{"$ref":"#/components/responses/Error429"},"503":{"$ref":"#/components/responses/Error503"}}}},"/v1/market/history":{"get":{"operationId":"market.history","tags":["market-data"],"summary":"Delayed price history for one ticker and up to 366 days","description":"Reads the existing dataset service and needs a key on an account with a plan; every plan reads every live dataset in full. Cached market reads can refresh their source data. Unknown, empty and repeated parameters are rejected. History and coverage metadata are null when the stored service cannot establish them.","parameters":[{"name":"tickers","in":"query","required":true,"description":"One ticker per call.","schema":{"type":"string","minLength":1,"maxLength":1024,"pattern":"\\S","description":"One ticker per call."}},{"name":"fields","in":"query","required":false,"description":"Price fields; price and volume by default.","schema":{"type":"string","minLength":1,"maxLength":1024,"pattern":"\\S","description":"Price fields; price and volume by default."}},{"name":"start","in":"query","required":false,"schema":{"type":"string","minLength":10,"maxLength":10,"pattern":"^\\d{4}-\\d{2}-\\d{2}$","format":"date","description":"Valid calendar date (YYYY-MM-DD). from must be on or before to."}},{"name":"end","in":"query","required":false,"schema":{"type":"string","minLength":10,"maxLength":10,"pattern":"^\\d{4}-\\d{2}-\\d{2}$","format":"date","description":"Valid calendar date (YYYY-MM-DD). from must be on or before to."}},{"name":"period","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":1024,"pattern":"\\S","enum":["daily","weekly","monthly"]}},{"$ref":"#/components/parameters/GloomVersion"},{"$ref":"#/components/parameters/IfNoneMatch"}],"x-dataset":"market-data","x-credit-cost":4,"x-credit-call-type":"history","x-credit-multiplier":2,"x-plans":["basic","desk","enterprise"],"x-sample-url":"/v1/datasets/market-data/sample","responses":{"200":{"description":"Stored dataset response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DatasetResponse"}}},"headers":{"Request-Id":{"$ref":"#/components/headers/RequestId"},"Gloom-Version":{"$ref":"#/components/headers/GloomVersion"},"X-Credits-Cost":{"$ref":"#/components/headers/CreditsCost"},"X-Credits-Remaining":{"$ref":"#/components/headers/CreditsRemaining"},"X-Plan":{"$ref":"#/components/headers/Plan"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimitLimit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimitRemaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimitReset"},"ETag":{"$ref":"#/components/headers/ETag"}}},"304":{"$ref":"#/components/responses/NotModified"},"400":{"$ref":"#/components/responses/Error400"},"401":{"$ref":"#/components/responses/Error401"},"402":{"$ref":"#/components/responses/Error402"},"403":{"$ref":"#/components/responses/Error403"},"404":{"$ref":"#/components/responses/Error404"},"429":{"$ref":"#/components/responses/Error429"},"503":{"$ref":"#/components/responses/Error503"}}}},"/v1/market/fields":{"get":{"operationId":"market.fields","tags":["market-data"],"summary":"Field dictionary with units and supported history periods","description":"Reads the existing dataset service and needs a key on an account with a plan; every plan reads every live dataset in full. Cached market reads can refresh their source data. Unknown, empty and repeated parameters are rejected. History and coverage metadata are null when the stored service cannot establish them.","parameters":[{"$ref":"#/components/parameters/GloomVersion"},{"$ref":"#/components/parameters/IfNoneMatch"}],"x-dataset":"market-data","x-credit-cost":2,"x-credit-call-type":"lookup","x-credit-multiplier":2,"x-plans":["basic","desk","enterprise"],"x-sample-url":"/v1/datasets/market-data/sample","responses":{"200":{"description":"Stored dataset response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DatasetResponse"}}},"headers":{"Request-Id":{"$ref":"#/components/headers/RequestId"},"Gloom-Version":{"$ref":"#/components/headers/GloomVersion"},"X-Credits-Cost":{"$ref":"#/components/headers/CreditsCost"},"X-Credits-Remaining":{"$ref":"#/components/headers/CreditsRemaining"},"X-Plan":{"$ref":"#/components/headers/Plan"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimitLimit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimitRemaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimitReset"},"ETag":{"$ref":"#/components/headers/ETag"}}},"304":{"$ref":"#/components/responses/NotModified"},"400":{"$ref":"#/components/responses/Error400"},"401":{"$ref":"#/components/responses/Error401"},"402":{"$ref":"#/components/responses/Error402"},"403":{"$ref":"#/components/responses/Error403"},"404":{"$ref":"#/components/responses/Error404"},"429":{"$ref":"#/components/responses/Error429"},"503":{"$ref":"#/components/responses/Error503"}}}},"/v1/futures/{root}/curve":{"get":{"operationId":"futures.curve","tags":["futures"],"summary":"Current futures term structure for a root","description":"Reads the existing dataset service and needs a key on an account with a plan; every plan reads every live dataset in full. Cached market reads can refresh their source data. Unknown, empty and repeated parameters are rejected. History and coverage metadata are null when the stored service cannot establish them.","parameters":[{"name":"root","in":"path","required":true,"schema":{"type":"string","minLength":1,"maxLength":1024,"pattern":"\\S"}},{"$ref":"#/components/parameters/GloomVersion"},{"$ref":"#/components/parameters/IfNoneMatch"}],"x-dataset":"futures","x-credit-cost":50,"x-credit-call-type":"bulk","x-credit-multiplier":2,"x-plans":["basic","desk","enterprise"],"x-sample-url":"/v1/datasets/futures/sample","responses":{"200":{"description":"Stored dataset response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DatasetResponse"}}},"headers":{"Request-Id":{"$ref":"#/components/headers/RequestId"},"Gloom-Version":{"$ref":"#/components/headers/GloomVersion"},"X-Credits-Cost":{"$ref":"#/components/headers/CreditsCost"},"X-Credits-Remaining":{"$ref":"#/components/headers/CreditsRemaining"},"X-Plan":{"$ref":"#/components/headers/Plan"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimitLimit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimitRemaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimitReset"},"ETag":{"$ref":"#/components/headers/ETag"}}},"304":{"$ref":"#/components/responses/NotModified"},"400":{"$ref":"#/components/responses/Error400"},"401":{"$ref":"#/components/responses/Error401"},"402":{"$ref":"#/components/responses/Error402"},"403":{"$ref":"#/components/responses/Error403"},"404":{"$ref":"#/components/responses/Error404"},"429":{"$ref":"#/components/responses/Error429"},"503":{"$ref":"#/components/responses/Error503"}}}},"/v1/futures/{root}/archive":{"get":{"operationId":"futures.archive","tags":["futures"],"summary":"Archived futures curve for a specified date","description":"Reads the existing dataset service and needs a key on an account with a plan; every plan reads every live dataset in full. Cached market reads can refresh their source data. Unknown, empty and repeated parameters are rejected. History and coverage metadata are null when the stored service cannot establish them.","parameters":[{"name":"root","in":"path","required":true,"schema":{"type":"string","minLength":1,"maxLength":1024,"pattern":"\\S"}},{"name":"date","in":"query","required":true,"schema":{"type":"string","minLength":10,"maxLength":10,"pattern":"^\\d{4}-\\d{2}-\\d{2}$","format":"date","description":"Valid calendar date (YYYY-MM-DD). from must be on or before to."}},{"$ref":"#/components/parameters/GloomVersion"},{"$ref":"#/components/parameters/IfNoneMatch"}],"x-dataset":"futures","x-credit-cost":4,"x-credit-call-type":"history","x-credit-multiplier":2,"x-plans":["basic","desk","enterprise"],"x-sample-url":"/v1/datasets/futures/sample","responses":{"200":{"description":"Stored dataset response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DatasetResponse"}}},"headers":{"Request-Id":{"$ref":"#/components/headers/RequestId"},"Gloom-Version":{"$ref":"#/components/headers/GloomVersion"},"X-Credits-Cost":{"$ref":"#/components/headers/CreditsCost"},"X-Credits-Remaining":{"$ref":"#/components/headers/CreditsRemaining"},"X-Plan":{"$ref":"#/components/headers/Plan"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimitLimit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimitRemaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimitReset"},"ETag":{"$ref":"#/components/headers/ETag"}}},"304":{"$ref":"#/components/responses/NotModified"},"400":{"$ref":"#/components/responses/Error400"},"401":{"$ref":"#/components/responses/Error401"},"402":{"$ref":"#/components/responses/Error402"},"403":{"$ref":"#/components/responses/Error403"},"404":{"$ref":"#/components/responses/Error404"},"429":{"$ref":"#/components/responses/Error429"},"503":{"$ref":"#/components/responses/Error503"}}}},"/v1/futures/generics/{ticker}":{"get":{"operationId":"futures.generic","tags":["futures"],"summary":"Generic futures contract data","description":"Reads the existing dataset service and needs a key on an account with a plan; every plan reads every live dataset in full. Cached market reads can refresh their source data. Unknown, empty and repeated parameters are rejected. History and coverage metadata are null when the stored service cannot establish them.","parameters":[{"name":"ticker","in":"path","required":true,"schema":{"type":"string","minLength":1,"maxLength":1024,"pattern":"\\S"}},{"name":"from","in":"query","required":false,"schema":{"type":"string","minLength":10,"maxLength":10,"pattern":"^\\d{4}-\\d{2}-\\d{2}$","format":"date","description":"Valid calendar date (YYYY-MM-DD). from must be on or before to."}},{"name":"to","in":"query","required":false,"schema":{"type":"string","minLength":10,"maxLength":10,"pattern":"^\\d{4}-\\d{2}-\\d{2}$","format":"date","description":"Valid calendar date (YYYY-MM-DD). from must be on or before to."}},{"$ref":"#/components/parameters/GloomVersion"},{"$ref":"#/components/parameters/IfNoneMatch"}],"x-dataset":"futures","x-credit-cost":4,"x-credit-call-type":"history","x-credit-multiplier":2,"x-plans":["basic","desk","enterprise"],"x-sample-url":"/v1/datasets/futures/sample","responses":{"200":{"description":"Stored dataset response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DatasetResponse"}}},"headers":{"Request-Id":{"$ref":"#/components/headers/RequestId"},"Gloom-Version":{"$ref":"#/components/headers/GloomVersion"},"X-Credits-Cost":{"$ref":"#/components/headers/CreditsCost"},"X-Credits-Remaining":{"$ref":"#/components/headers/CreditsRemaining"},"X-Plan":{"$ref":"#/components/headers/Plan"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimitLimit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimitRemaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimitReset"},"ETag":{"$ref":"#/components/headers/ETag"}}},"304":{"$ref":"#/components/responses/NotModified"},"400":{"$ref":"#/components/responses/Error400"},"401":{"$ref":"#/components/responses/Error401"},"402":{"$ref":"#/components/responses/Error402"},"403":{"$ref":"#/components/responses/Error403"},"404":{"$ref":"#/components/responses/Error404"},"429":{"$ref":"#/components/responses/Error429"},"503":{"$ref":"#/components/responses/Error503"}}}},"/v1/rate-path":{"get":{"operationId":"rate-path.board","tags":["rate-path"],"summary":"Implied policy rate paths and meeting probabilities","description":"Reads the existing dataset service and needs a key on an account with a plan; every plan reads every live dataset in full. Cached market reads can refresh their source data. Unknown, empty and repeated parameters are rejected. History and coverage metadata are null when the stored service cannot establish them.","parameters":[{"$ref":"#/components/parameters/GloomVersion"},{"$ref":"#/components/parameters/IfNoneMatch"}],"x-dataset":"rate-path","x-credit-cost":50,"x-credit-call-type":"bulk","x-credit-multiplier":2,"x-plans":["basic","desk","enterprise"],"x-sample-url":"/v1/datasets/rate-path/sample","responses":{"200":{"description":"Stored dataset response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DatasetResponse"}}},"headers":{"Request-Id":{"$ref":"#/components/headers/RequestId"},"Gloom-Version":{"$ref":"#/components/headers/GloomVersion"},"X-Credits-Cost":{"$ref":"#/components/headers/CreditsCost"},"X-Credits-Remaining":{"$ref":"#/components/headers/CreditsRemaining"},"X-Plan":{"$ref":"#/components/headers/Plan"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimitLimit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimitRemaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimitReset"},"ETag":{"$ref":"#/components/headers/ETag"}}},"304":{"$ref":"#/components/responses/NotModified"},"400":{"$ref":"#/components/responses/Error400"},"401":{"$ref":"#/components/responses/Error401"},"402":{"$ref":"#/components/responses/Error402"},"403":{"$ref":"#/components/responses/Error403"},"404":{"$ref":"#/components/responses/Error404"},"429":{"$ref":"#/components/responses/Error429"},"503":{"$ref":"#/components/responses/Error503"}}}},"/v1/options/flow":{"get":{"operationId":"options.flow","tags":["options"],"summary":"Stored options trade flow","description":"Reads the existing dataset service and needs a key on an account with a plan; every plan reads every live dataset in full. Cached market reads can refresh their source data. Unknown, empty and repeated parameters are rejected. History and coverage metadata are null when the stored service cannot establish them.","parameters":[{"name":"limit","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":200}},{"name":"before","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":1024,"pattern":"\\S"}},{"name":"symbol","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":32,"pattern":"^[A-Za-z0-9.:-]{1,32}$","description":"Company symbol; normalized to uppercase."}},{"$ref":"#/components/parameters/GloomVersion"},{"$ref":"#/components/parameters/IfNoneMatch"}],"x-dataset":"options","x-credit-cost":4,"x-credit-call-type":"history","x-credit-multiplier":2,"x-plans":["basic","desk","enterprise"],"x-sample-url":"/v1/datasets/options/sample","responses":{"200":{"description":"Stored dataset response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DatasetResponse"}}},"headers":{"Request-Id":{"$ref":"#/components/headers/RequestId"},"Gloom-Version":{"$ref":"#/components/headers/GloomVersion"},"X-Credits-Cost":{"$ref":"#/components/headers/CreditsCost"},"X-Credits-Remaining":{"$ref":"#/components/headers/CreditsRemaining"},"X-Plan":{"$ref":"#/components/headers/Plan"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimitLimit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimitRemaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimitReset"},"ETag":{"$ref":"#/components/headers/ETag"}}},"304":{"$ref":"#/components/responses/NotModified"},"400":{"$ref":"#/components/responses/Error400"},"401":{"$ref":"#/components/responses/Error401"},"402":{"$ref":"#/components/responses/Error402"},"403":{"$ref":"#/components/responses/Error403"},"404":{"$ref":"#/components/responses/Error404"},"429":{"$ref":"#/components/responses/Error429"},"503":{"$ref":"#/components/responses/Error503"}}}},"/v1/options/{symbol}/iv":{"get":{"operationId":"options.iv","tags":["options"],"summary":"Historical implied volatility for an underlying symbol","description":"Reads the existing dataset service and needs a key on an account with a plan; every plan reads every live dataset in full. Cached market reads can refresh their source data. Unknown, empty and repeated parameters are rejected. History and coverage metadata are null when the stored service cannot establish them.","parameters":[{"name":"symbol","in":"path","required":true,"schema":{"type":"string","minLength":1,"maxLength":32,"pattern":"^[A-Za-z0-9.:-]{1,32}$","description":"Company symbol; normalized to uppercase."}},{"name":"from","in":"query","required":false,"schema":{"type":"string","minLength":10,"maxLength":10,"pattern":"^\\d{4}-\\d{2}-\\d{2}$","format":"date","description":"Valid calendar date (YYYY-MM-DD). from must be on or before to."}},{"name":"to","in":"query","required":false,"schema":{"type":"string","minLength":10,"maxLength":10,"pattern":"^\\d{4}-\\d{2}-\\d{2}$","format":"date","description":"Valid calendar date (YYYY-MM-DD). from must be on or before to."}},{"$ref":"#/components/parameters/GloomVersion"},{"$ref":"#/components/parameters/IfNoneMatch"}],"x-dataset":"options","x-credit-cost":4,"x-credit-call-type":"history","x-credit-multiplier":2,"x-plans":["basic","desk","enterprise"],"x-sample-url":"/v1/datasets/options/sample","responses":{"200":{"description":"Stored dataset response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DatasetResponse"}}},"headers":{"Request-Id":{"$ref":"#/components/headers/RequestId"},"Gloom-Version":{"$ref":"#/components/headers/GloomVersion"},"X-Credits-Cost":{"$ref":"#/components/headers/CreditsCost"},"X-Credits-Remaining":{"$ref":"#/components/headers/CreditsRemaining"},"X-Plan":{"$ref":"#/components/headers/Plan"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimitLimit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimitRemaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimitReset"},"ETag":{"$ref":"#/components/headers/ETag"}}},"304":{"$ref":"#/components/responses/NotModified"},"400":{"$ref":"#/components/responses/Error400"},"401":{"$ref":"#/components/responses/Error401"},"402":{"$ref":"#/components/responses/Error402"},"403":{"$ref":"#/components/responses/Error403"},"404":{"$ref":"#/components/responses/Error404"},"429":{"$ref":"#/components/responses/Error429"},"503":{"$ref":"#/components/responses/Error503"}}}},"/v1/options/{symbol}/surface":{"get":{"operationId":"options.surface","tags":["options"],"summary":"Implied volatility across strikes and expiries","description":"Reads the existing dataset service and needs a key on an account with a plan; every plan reads every live dataset in full. Cached market reads can refresh their source data. Unknown, empty and repeated parameters are rejected. History and coverage metadata are null when the stored service cannot establish them.","parameters":[{"name":"symbol","in":"path","required":true,"schema":{"type":"string","minLength":1,"maxLength":32,"pattern":"^[A-Za-z0-9.:-]{1,32}$","description":"Company symbol; normalized to uppercase."}},{"name":"date","in":"query","required":false,"schema":{"type":"string","minLength":10,"maxLength":10,"pattern":"^\\d{4}-\\d{2}-\\d{2}$","format":"date","description":"Valid calendar date (YYYY-MM-DD). from must be on or before to."}},{"$ref":"#/components/parameters/GloomVersion"},{"$ref":"#/components/parameters/IfNoneMatch"}],"x-dataset":"options","x-credit-cost":50,"x-credit-call-type":"bulk","x-credit-multiplier":2,"x-plans":["basic","desk","enterprise"],"x-sample-url":"/v1/datasets/options/sample","responses":{"200":{"description":"Stored dataset response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DatasetResponse"}}},"headers":{"Request-Id":{"$ref":"#/components/headers/RequestId"},"Gloom-Version":{"$ref":"#/components/headers/GloomVersion"},"X-Credits-Cost":{"$ref":"#/components/headers/CreditsCost"},"X-Credits-Remaining":{"$ref":"#/components/headers/CreditsRemaining"},"X-Plan":{"$ref":"#/components/headers/Plan"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimitLimit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimitRemaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimitReset"},"ETag":{"$ref":"#/components/headers/ETag"}}},"304":{"$ref":"#/components/responses/NotModified"},"400":{"$ref":"#/components/responses/Error400"},"401":{"$ref":"#/components/responses/Error401"},"402":{"$ref":"#/components/responses/Error402"},"403":{"$ref":"#/components/responses/Error403"},"404":{"$ref":"#/components/responses/Error404"},"429":{"$ref":"#/components/responses/Error429"},"503":{"$ref":"#/components/responses/Error503"}}}},"/v1/options/{symbol}/chain":{"get":{"operationId":"options.chain","tags":["options"],"summary":"Option calls and puts for a specified expiry","description":"Reads the existing dataset service and needs a key on an account with a plan; every plan reads every live dataset in full. Cached market reads can refresh their source data. Unknown, empty and repeated parameters are rejected. History and coverage metadata are null when the stored service cannot establish them.","parameters":[{"name":"symbol","in":"path","required":true,"schema":{"type":"string","minLength":1,"maxLength":32,"pattern":"^[A-Za-z0-9.:-]{1,32}$","description":"Company symbol; normalized to uppercase."}},{"name":"expiry","in":"query","required":true,"schema":{"type":"string","minLength":10,"maxLength":10,"pattern":"^\\d{4}-\\d{2}-\\d{2}$","format":"date","description":"Valid calendar date (YYYY-MM-DD). from must be on or before to."}},{"$ref":"#/components/parameters/GloomVersion"},{"$ref":"#/components/parameters/IfNoneMatch"}],"x-dataset":"options","x-credit-cost":50,"x-credit-call-type":"bulk","x-credit-multiplier":2,"x-plans":["basic","desk","enterprise"],"x-sample-url":"/v1/datasets/options/sample","responses":{"200":{"description":"Stored dataset response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DatasetResponse"}}},"headers":{"Request-Id":{"$ref":"#/components/headers/RequestId"},"Gloom-Version":{"$ref":"#/components/headers/GloomVersion"},"X-Credits-Cost":{"$ref":"#/components/headers/CreditsCost"},"X-Credits-Remaining":{"$ref":"#/components/headers/CreditsRemaining"},"X-Plan":{"$ref":"#/components/headers/Plan"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimitLimit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimitRemaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimitReset"},"ETag":{"$ref":"#/components/headers/ETag"}}},"304":{"$ref":"#/components/responses/NotModified"},"400":{"$ref":"#/components/responses/Error400"},"401":{"$ref":"#/components/responses/Error401"},"402":{"$ref":"#/components/responses/Error402"},"403":{"$ref":"#/components/responses/Error403"},"404":{"$ref":"#/components/responses/Error404"},"429":{"$ref":"#/components/responses/Error429"},"503":{"$ref":"#/components/responses/Error503"}}}},"/v1/options/{symbol}/gamma":{"get":{"operationId":"options.gamma","tags":["options"],"summary":"Retained dealer gamma positioning for one expiry","description":"Reads the existing dataset service and needs a key on an account with a plan; every plan reads every live dataset in full. Cached market reads can refresh their source data. Unknown, empty and repeated parameters are rejected. History and coverage metadata are null when the stored service cannot establish them.","parameters":[{"name":"symbol","in":"path","required":true,"schema":{"type":"string","minLength":1,"maxLength":32,"pattern":"^[A-Za-z0-9.:-]{1,32}$","description":"Company symbol; normalized to uppercase."}},{"name":"expiry","in":"query","required":true,"schema":{"type":"string","minLength":10,"maxLength":10,"pattern":"^\\d{4}-\\d{2}-\\d{2}$","format":"date","description":"Valid calendar date (YYYY-MM-DD). from must be on or before to."}},{"$ref":"#/components/parameters/GloomVersion"},{"$ref":"#/components/parameters/IfNoneMatch"}],"x-dataset":"options","x-credit-cost":50,"x-credit-call-type":"bulk","x-credit-multiplier":2,"x-plans":["basic","desk","enterprise"],"x-sample-url":"/v1/datasets/options/sample","responses":{"200":{"description":"Stored dataset response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DatasetResponse"}}},"headers":{"Request-Id":{"$ref":"#/components/headers/RequestId"},"Gloom-Version":{"$ref":"#/components/headers/GloomVersion"},"X-Credits-Cost":{"$ref":"#/components/headers/CreditsCost"},"X-Credits-Remaining":{"$ref":"#/components/headers/CreditsRemaining"},"X-Plan":{"$ref":"#/components/headers/Plan"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimitLimit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimitRemaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimitReset"},"ETag":{"$ref":"#/components/headers/ETag"}}},"304":{"$ref":"#/components/responses/NotModified"},"400":{"$ref":"#/components/responses/Error400"},"401":{"$ref":"#/components/responses/Error401"},"402":{"$ref":"#/components/responses/Error402"},"403":{"$ref":"#/components/responses/Error403"},"404":{"$ref":"#/components/responses/Error404"},"429":{"$ref":"#/components/responses/Error429"},"503":{"$ref":"#/components/responses/Error503"}}}},"/v1/earnings/calendar":{"get":{"operationId":"earnings.calendar","tags":["earnings"],"summary":"Earnings calendar with reporting dates and estimates","description":"Reads the existing dataset service and needs a key on an account with a plan; every plan reads every live dataset in full. Cached market reads can refresh their source data. Unknown, empty and repeated parameters are rejected. History and coverage metadata are null when the stored service cannot establish them.","parameters":[{"name":"from","in":"query","required":false,"schema":{"type":"string","minLength":10,"maxLength":10,"pattern":"^\\d{4}-\\d{2}-\\d{2}$","format":"date","description":"Valid calendar date (YYYY-MM-DD). from must be on or before to."}},{"name":"to","in":"query","required":false,"schema":{"type":"string","minLength":10,"maxLength":10,"pattern":"^\\d{4}-\\d{2}-\\d{2}$","format":"date","description":"Valid calendar date (YYYY-MM-DD). from must be on or before to."}},{"name":"perDay","in":"query","required":false,"schema":{"type":"number"}},{"name":"symbols","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":1024,"pattern":"\\S"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":200}},{"$ref":"#/components/parameters/GloomVersion"},{"$ref":"#/components/parameters/IfNoneMatch"}],"x-dataset":"earnings","x-credit-cost":4,"x-credit-call-type":"search","x-credit-multiplier":2,"x-plans":["basic","desk","enterprise"],"x-sample-url":"/v1/datasets/earnings/sample","responses":{"200":{"description":"Stored dataset response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DatasetResponse"}}},"headers":{"Request-Id":{"$ref":"#/components/headers/RequestId"},"Gloom-Version":{"$ref":"#/components/headers/GloomVersion"},"X-Credits-Cost":{"$ref":"#/components/headers/CreditsCost"},"X-Credits-Remaining":{"$ref":"#/components/headers/CreditsRemaining"},"X-Plan":{"$ref":"#/components/headers/Plan"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimitLimit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimitRemaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimitReset"},"ETag":{"$ref":"#/components/headers/ETag"}}},"304":{"$ref":"#/components/responses/NotModified"},"400":{"$ref":"#/components/responses/Error400"},"401":{"$ref":"#/components/responses/Error401"},"402":{"$ref":"#/components/responses/Error402"},"403":{"$ref":"#/components/responses/Error403"},"404":{"$ref":"#/components/responses/Error404"},"429":{"$ref":"#/components/responses/Error429"},"503":{"$ref":"#/components/responses/Error503"}}}},"/v1/earnings/{symbol}/moves":{"get":{"operationId":"earnings.moves","tags":["earnings"],"summary":"Historical price moves around earnings reports","description":"Reads the existing dataset service and needs a key on an account with a plan; every plan reads every live dataset in full. Cached market reads can refresh their source data. Unknown, empty and repeated parameters are rejected. History and coverage metadata are null when the stored service cannot establish them.","parameters":[{"name":"symbol","in":"path","required":true,"schema":{"type":"string","minLength":1,"maxLength":32,"pattern":"^[A-Za-z0-9.:-]{1,32}$","description":"Company symbol; normalized to uppercase."}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":200}},{"$ref":"#/components/parameters/GloomVersion"},{"$ref":"#/components/parameters/IfNoneMatch"}],"x-dataset":"earnings","x-credit-cost":4,"x-credit-call-type":"history","x-credit-multiplier":2,"x-plans":["basic","desk","enterprise"],"x-sample-url":"/v1/datasets/earnings/sample","responses":{"200":{"description":"Stored dataset response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DatasetResponse"}}},"headers":{"Request-Id":{"$ref":"#/components/headers/RequestId"},"Gloom-Version":{"$ref":"#/components/headers/GloomVersion"},"X-Credits-Cost":{"$ref":"#/components/headers/CreditsCost"},"X-Credits-Remaining":{"$ref":"#/components/headers/CreditsRemaining"},"X-Plan":{"$ref":"#/components/headers/Plan"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimitLimit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimitRemaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimitReset"},"ETag":{"$ref":"#/components/headers/ETag"}}},"304":{"$ref":"#/components/responses/NotModified"},"400":{"$ref":"#/components/responses/Error400"},"401":{"$ref":"#/components/responses/Error401"},"402":{"$ref":"#/components/responses/Error402"},"403":{"$ref":"#/components/responses/Error403"},"404":{"$ref":"#/components/responses/Error404"},"429":{"$ref":"#/components/responses/Error429"},"503":{"$ref":"#/components/responses/Error503"}}}},"/v1/ipo/calendar":{"get":{"operationId":"ipo.calendar","tags":["ipo"],"summary":"Upcoming and recent initial public offerings","description":"Reads the existing dataset service and needs a key on an account with a plan; every plan reads every live dataset in full. Cached market reads can refresh their source data. Unknown, empty and repeated parameters are rejected. History and coverage metadata are null when the stored service cannot establish them.","parameters":[{"name":"from","in":"query","required":false,"schema":{"type":"string","minLength":10,"maxLength":10,"pattern":"^\\d{4}-\\d{2}-\\d{2}$","format":"date","description":"Valid calendar date (YYYY-MM-DD). from must be on or before to."}},{"name":"to","in":"query","required":false,"schema":{"type":"string","minLength":10,"maxLength":10,"pattern":"^\\d{4}-\\d{2}-\\d{2}$","format":"date","description":"Valid calendar date (YYYY-MM-DD). from must be on or before to."}},{"name":"status","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":1024,"pattern":"\\S"}},{"name":"region","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":1024,"pattern":"\\S"}},{"name":"country","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":1024,"pattern":"\\S"}},{"name":"q","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":1024,"pattern":"\\S"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":200}},{"$ref":"#/components/parameters/GloomVersion"},{"$ref":"#/components/parameters/IfNoneMatch"}],"x-dataset":"ipo","x-credit-cost":4,"x-credit-call-type":"search","x-credit-multiplier":2,"x-plans":["basic","desk","enterprise"],"x-sample-url":"/v1/datasets/ipo/sample","responses":{"200":{"description":"Stored dataset response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DatasetResponse"}}},"headers":{"Request-Id":{"$ref":"#/components/headers/RequestId"},"Gloom-Version":{"$ref":"#/components/headers/GloomVersion"},"X-Credits-Cost":{"$ref":"#/components/headers/CreditsCost"},"X-Credits-Remaining":{"$ref":"#/components/headers/CreditsRemaining"},"X-Plan":{"$ref":"#/components/headers/Plan"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimitLimit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimitRemaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimitReset"},"ETag":{"$ref":"#/components/headers/ETag"}}},"304":{"$ref":"#/components/responses/NotModified"},"400":{"$ref":"#/components/responses/Error400"},"401":{"$ref":"#/components/responses/Error401"},"402":{"$ref":"#/components/responses/Error402"},"403":{"$ref":"#/components/responses/Error403"},"404":{"$ref":"#/components/responses/Error404"},"429":{"$ref":"#/components/responses/Error429"},"503":{"$ref":"#/components/responses/Error503"}}}},"/v1/mna/deals":{"get":{"operationId":"mna.deals","tags":["mna"],"summary":"Search mergers and acquisitions deals","description":"Reads the existing dataset service and needs a key on an account with a plan; every plan reads every live dataset in full. Cached market reads can refresh their source data. Unknown, empty and repeated parameters are rejected. History and coverage metadata are null when the stored service cannot establish them.","parameters":[{"name":"status","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":1024,"pattern":"\\S"}},{"name":"target","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":1024,"pattern":"\\S"}},{"name":"region","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":1024,"pattern":"\\S"}},{"name":"symbol","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":32,"pattern":"^[A-Za-z0-9.:-]{1,32}$","description":"Company symbol; normalized to uppercase."}},{"name":"query","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":1024,"pattern":"\\S"}},{"name":"cursor","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":120,"pattern":"^[A-Za-z0-9_-]+$","description":"Opaque: meta.page.nextCursor of the previous page. Bound to this route and query. Pages up to 10,000 rows deep."}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":100,"default":50}},{"$ref":"#/components/parameters/GloomVersion"},{"$ref":"#/components/parameters/IfNoneMatch"}],"x-dataset":"mna","x-credit-cost":4,"x-credit-call-type":"search","x-credit-multiplier":2,"x-plans":["basic","desk","enterprise"],"x-sample-url":"/v1/datasets/mna/sample","responses":{"200":{"description":"Stored dataset response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DatasetResponse"}}},"headers":{"Request-Id":{"$ref":"#/components/headers/RequestId"},"Gloom-Version":{"$ref":"#/components/headers/GloomVersion"},"X-Credits-Cost":{"$ref":"#/components/headers/CreditsCost"},"X-Credits-Remaining":{"$ref":"#/components/headers/CreditsRemaining"},"X-Plan":{"$ref":"#/components/headers/Plan"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimitLimit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimitRemaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimitReset"},"ETag":{"$ref":"#/components/headers/ETag"}}},"304":{"$ref":"#/components/responses/NotModified"},"400":{"$ref":"#/components/responses/Error400"},"401":{"$ref":"#/components/responses/Error401"},"402":{"$ref":"#/components/responses/Error402"},"403":{"$ref":"#/components/responses/Error403"},"404":{"$ref":"#/components/responses/Error404"},"429":{"$ref":"#/components/responses/Error429"},"503":{"$ref":"#/components/responses/Error503"}}}},"/v1/mna/deals/{id}":{"get":{"operationId":"mna.deal","tags":["mna"],"summary":"Details for a merger or acquisition deal","description":"Reads the existing dataset service and needs a key on an account with a plan; every plan reads every live dataset in full. Cached market reads can refresh their source data. Unknown, empty and repeated parameters are rejected. History and coverage metadata are null when the stored service cannot establish them.","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","minLength":1,"maxLength":1024,"pattern":"\\S"}},{"$ref":"#/components/parameters/GloomVersion"},{"$ref":"#/components/parameters/IfNoneMatch"}],"x-dataset":"mna","x-credit-cost":10,"x-credit-call-type":"evidence","x-credit-multiplier":2,"x-plans":["basic","desk","enterprise"],"x-sample-url":"/v1/datasets/mna/sample","responses":{"200":{"description":"Stored dataset response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DatasetResponse"}}},"headers":{"Request-Id":{"$ref":"#/components/headers/RequestId"},"Gloom-Version":{"$ref":"#/components/headers/GloomVersion"},"X-Credits-Cost":{"$ref":"#/components/headers/CreditsCost"},"X-Credits-Remaining":{"$ref":"#/components/headers/CreditsRemaining"},"X-Plan":{"$ref":"#/components/headers/Plan"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimitLimit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimitRemaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimitReset"},"ETag":{"$ref":"#/components/headers/ETag"}}},"304":{"$ref":"#/components/responses/NotModified"},"400":{"$ref":"#/components/responses/Error400"},"401":{"$ref":"#/components/responses/Error401"},"402":{"$ref":"#/components/responses/Error402"},"403":{"$ref":"#/components/responses/Error403"},"404":{"$ref":"#/components/responses/Error404"},"429":{"$ref":"#/components/responses/Error429"},"503":{"$ref":"#/components/responses/Error503"}}}},"/v1/equity-screener":{"get":{"operationId":"equity-screener.query","tags":["equity-screener"],"summary":"Screen equities using a structured query","description":"Reads the existing dataset service and needs a key on an account with a plan; every plan reads every live dataset in full. Cached market reads can refresh their source data. Unknown, empty and repeated parameters are rejected. History and coverage metadata are null when the stored service cannot establish them.","parameters":[{"name":"definition","in":"query","required":true,"description":"JSON string describing the existing screen query.","schema":{"type":"string","minLength":1,"maxLength":1024,"pattern":"\\S","description":"JSON string describing the existing screen query."}},{"$ref":"#/components/parameters/GloomVersion"},{"$ref":"#/components/parameters/IfNoneMatch"}],"x-dataset":"equity-screener","x-credit-cost":4,"x-credit-call-type":"search","x-credit-multiplier":2,"x-plans":["basic","desk","enterprise"],"x-sample-url":"/v1/datasets/equity-screener/sample","responses":{"200":{"description":"Stored dataset response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DatasetResponse"}}},"headers":{"Request-Id":{"$ref":"#/components/headers/RequestId"},"Gloom-Version":{"$ref":"#/components/headers/GloomVersion"},"X-Credits-Cost":{"$ref":"#/components/headers/CreditsCost"},"X-Credits-Remaining":{"$ref":"#/components/headers/CreditsRemaining"},"X-Plan":{"$ref":"#/components/headers/Plan"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimitLimit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimitRemaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimitReset"},"ETag":{"$ref":"#/components/headers/ETag"}}},"304":{"$ref":"#/components/responses/NotModified"},"400":{"$ref":"#/components/responses/Error400"},"401":{"$ref":"#/components/responses/Error401"},"402":{"$ref":"#/components/responses/Error402"},"403":{"$ref":"#/components/responses/Error403"},"404":{"$ref":"#/components/responses/Error404"},"429":{"$ref":"#/components/responses/Error429"},"503":{"$ref":"#/components/responses/Error503"}}}},"/v1/crypto/markets":{"get":{"operationId":"crypto.markets","tags":["crypto"],"summary":"Digital asset market rankings and performance","description":"Reads the existing dataset service and needs a key on an account with a plan; every plan reads every live dataset in full. Cached market reads can refresh their source data. Unknown, empty and repeated parameters are rejected. History and coverage metadata are null when the stored service cannot establish them.","parameters":[{"$ref":"#/components/parameters/GloomVersion"},{"$ref":"#/components/parameters/IfNoneMatch"}],"x-dataset":"crypto","x-credit-cost":50,"x-credit-call-type":"bulk","x-credit-multiplier":2,"x-plans":["basic","desk","enterprise"],"x-sample-url":"/v1/datasets/crypto/sample","responses":{"200":{"description":"Stored dataset response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DatasetResponse"}}},"headers":{"Request-Id":{"$ref":"#/components/headers/RequestId"},"Gloom-Version":{"$ref":"#/components/headers/GloomVersion"},"X-Credits-Cost":{"$ref":"#/components/headers/CreditsCost"},"X-Credits-Remaining":{"$ref":"#/components/headers/CreditsRemaining"},"X-Plan":{"$ref":"#/components/headers/Plan"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimitLimit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimitRemaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimitReset"},"ETag":{"$ref":"#/components/headers/ETag"}}},"304":{"$ref":"#/components/responses/NotModified"},"400":{"$ref":"#/components/responses/Error400"},"401":{"$ref":"#/components/responses/Error401"},"402":{"$ref":"#/components/responses/Error402"},"403":{"$ref":"#/components/responses/Error403"},"404":{"$ref":"#/components/responses/Error404"},"429":{"$ref":"#/components/responses/Error429"},"503":{"$ref":"#/components/responses/Error503"}}}},"/v1/session-tape/movers":{"get":{"operationId":"session-tape.movers","tags":["session-tape"],"summary":"Session market movers ranked by performance","description":"Reads the existing dataset service and needs a key on an account with a plan; every plan reads every live dataset in full. Cached market reads can refresh their source data. Unknown, empty and repeated parameters are rejected. History and coverage metadata are null when the stored service cannot establish them.","parameters":[{"name":"view","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":1024,"pattern":"\\S","enum":["premarket","afterhours","gaps"]}},{"name":"side","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":1024,"pattern":"\\S","enum":["up","down","active"]}},{"name":"count","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":50}},{"$ref":"#/components/parameters/GloomVersion"},{"$ref":"#/components/parameters/IfNoneMatch"}],"x-dataset":"session-tape","x-credit-cost":50,"x-credit-call-type":"bulk","x-credit-multiplier":2,"x-plans":["basic","desk","enterprise"],"x-sample-url":"/v1/datasets/session-tape/sample","responses":{"200":{"description":"Stored dataset response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DatasetResponse"}}},"headers":{"Request-Id":{"$ref":"#/components/headers/RequestId"},"Gloom-Version":{"$ref":"#/components/headers/GloomVersion"},"X-Credits-Cost":{"$ref":"#/components/headers/CreditsCost"},"X-Credits-Remaining":{"$ref":"#/components/headers/CreditsRemaining"},"X-Plan":{"$ref":"#/components/headers/Plan"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimitLimit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimitRemaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimitReset"},"ETag":{"$ref":"#/components/headers/ETag"}}},"304":{"$ref":"#/components/responses/NotModified"},"400":{"$ref":"#/components/responses/Error400"},"401":{"$ref":"#/components/responses/Error401"},"402":{"$ref":"#/components/responses/Error402"},"403":{"$ref":"#/components/responses/Error403"},"404":{"$ref":"#/components/responses/Error404"},"429":{"$ref":"#/components/responses/Error429"},"503":{"$ref":"#/components/responses/Error503"}}}},"/v1/session-tape/highs-lows":{"get":{"operationId":"session-tape.hilo","tags":["session-tape"],"summary":"Last stored highs and lows publication without starting the scanner","description":"Reads the existing dataset service and needs a key on an account with a plan; every plan reads every live dataset in full. Cached market reads can refresh their source data. Unknown, empty and repeated parameters are rejected. History and coverage metadata are null when the stored service cannot establish them.","parameters":[{"$ref":"#/components/parameters/GloomVersion"},{"$ref":"#/components/parameters/IfNoneMatch"}],"x-dataset":"session-tape","x-credit-cost":4,"x-credit-call-type":"history","x-credit-multiplier":2,"x-plans":["basic","desk","enterprise"],"x-sample-url":"/v1/datasets/session-tape/sample","responses":{"200":{"description":"Stored dataset response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DatasetResponse"}}},"headers":{"Request-Id":{"$ref":"#/components/headers/RequestId"},"Gloom-Version":{"$ref":"#/components/headers/GloomVersion"},"X-Credits-Cost":{"$ref":"#/components/headers/CreditsCost"},"X-Credits-Remaining":{"$ref":"#/components/headers/CreditsRemaining"},"X-Plan":{"$ref":"#/components/headers/Plan"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimitLimit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimitRemaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimitReset"},"ETag":{"$ref":"#/components/headers/ETag"}}},"304":{"$ref":"#/components/responses/NotModified"},"400":{"$ref":"#/components/responses/Error400"},"401":{"$ref":"#/components/responses/Error401"},"402":{"$ref":"#/components/responses/Error402"},"403":{"$ref":"#/components/responses/Error403"},"404":{"$ref":"#/components/responses/Error404"},"429":{"$ref":"#/components/responses/Error429"},"503":{"$ref":"#/components/responses/Error503"}}}},"/v1/session-tape/{symbol}/tape":{"get":{"operationId":"session-tape.tape","tags":["session-tape"],"summary":"Retained delayed trades and quotes without starting collection","description":"Reads the existing dataset service and needs a key on an account with a plan; every plan reads every live dataset in full. Cached market reads can refresh their source data. Unknown, empty and repeated parameters are rejected. History and coverage metadata are null when the stored service cannot establish them.","parameters":[{"name":"symbol","in":"path","required":true,"schema":{"type":"string","minLength":1,"maxLength":32,"pattern":"^[A-Za-z0-9.:-]{1,32}$","description":"Company symbol; normalized to uppercase."}},{"name":"exchange","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":32,"pattern":"^[A-Za-z0-9_]+$"}},{"$ref":"#/components/parameters/GloomVersion"},{"$ref":"#/components/parameters/IfNoneMatch"}],"x-dataset":"session-tape","x-credit-cost":4,"x-credit-call-type":"history","x-credit-multiplier":2,"x-plans":["basic","desk","enterprise"],"x-sample-url":"/v1/datasets/session-tape/sample","responses":{"200":{"description":"Stored dataset response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DatasetResponse"}}},"headers":{"Request-Id":{"$ref":"#/components/headers/RequestId"},"Gloom-Version":{"$ref":"#/components/headers/GloomVersion"},"X-Credits-Cost":{"$ref":"#/components/headers/CreditsCost"},"X-Credits-Remaining":{"$ref":"#/components/headers/CreditsRemaining"},"X-Plan":{"$ref":"#/components/headers/Plan"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimitLimit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimitRemaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimitReset"},"ETag":{"$ref":"#/components/headers/ETag"}}},"304":{"$ref":"#/components/responses/NotModified"},"400":{"$ref":"#/components/responses/Error400"},"401":{"$ref":"#/components/responses/Error401"},"402":{"$ref":"#/components/responses/Error402"},"403":{"$ref":"#/components/responses/Error403"},"404":{"$ref":"#/components/responses/Error404"},"429":{"$ref":"#/components/responses/Error429"},"503":{"$ref":"#/components/responses/Error503"}}}},"/v1/analyst-estimates/{symbol}":{"get":{"operationId":"analyst.estimates","tags":["analyst-estimates"],"summary":"Analyst earnings and revenue estimates","description":"Reads the existing dataset service and needs a key on an account with a plan; every plan reads every live dataset in full. Cached market reads can refresh their source data. Unknown, empty and repeated parameters are rejected. History and coverage metadata are null when the stored service cannot establish them.","parameters":[{"name":"symbol","in":"path","required":true,"schema":{"type":"string","minLength":1,"maxLength":32,"pattern":"^[A-Za-z0-9.:-]{1,32}$","description":"Company symbol; normalized to uppercase."}},{"name":"exchange","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":1024,"pattern":"\\S"}},{"$ref":"#/components/parameters/GloomVersion"},{"$ref":"#/components/parameters/IfNoneMatch"}],"x-dataset":"analyst-estimates","x-credit-cost":10,"x-credit-call-type":"evidence","x-credit-multiplier":2,"x-plans":["basic","desk","enterprise"],"x-sample-url":"/v1/datasets/analyst-estimates/sample","responses":{"200":{"description":"Stored dataset response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DatasetResponse"}}},"headers":{"Request-Id":{"$ref":"#/components/headers/RequestId"},"Gloom-Version":{"$ref":"#/components/headers/GloomVersion"},"X-Credits-Cost":{"$ref":"#/components/headers/CreditsCost"},"X-Credits-Remaining":{"$ref":"#/components/headers/CreditsRemaining"},"X-Plan":{"$ref":"#/components/headers/Plan"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimitLimit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimitRemaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimitReset"},"ETag":{"$ref":"#/components/headers/ETag"}}},"304":{"$ref":"#/components/responses/NotModified"},"400":{"$ref":"#/components/responses/Error400"},"401":{"$ref":"#/components/responses/Error401"},"402":{"$ref":"#/components/responses/Error402"},"403":{"$ref":"#/components/responses/Error403"},"404":{"$ref":"#/components/responses/Error404"},"429":{"$ref":"#/components/responses/Error429"},"503":{"$ref":"#/components/responses/Error503"}}}},"/v1/analyst-estimates/{symbol}/revisions":{"get":{"operationId":"analyst.revisions","tags":["analyst-estimates"],"summary":"Analyst estimate revision history","description":"Reads the existing dataset service and needs a key on an account with a plan; every plan reads every live dataset in full. Cached market reads can refresh their source data. Unknown, empty and repeated parameters are rejected. History and coverage metadata are null when the stored service cannot establish them.","parameters":[{"name":"symbol","in":"path","required":true,"schema":{"type":"string","minLength":1,"maxLength":32,"pattern":"^[A-Za-z0-9.:-]{1,32}$","description":"Company symbol; normalized to uppercase."}},{"name":"exchange","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":1024,"pattern":"\\S"}},{"name":"from","in":"query","required":false,"schema":{"type":"string","minLength":10,"maxLength":10,"pattern":"^\\d{4}-\\d{2}-\\d{2}$","format":"date","description":"Valid calendar date (YYYY-MM-DD). from must be on or before to."}},{"name":"to","in":"query","required":false,"schema":{"type":"string","minLength":10,"maxLength":10,"pattern":"^\\d{4}-\\d{2}-\\d{2}$","format":"date","description":"Valid calendar date (YYYY-MM-DD). from must be on or before to."}},{"$ref":"#/components/parameters/GloomVersion"},{"$ref":"#/components/parameters/IfNoneMatch"}],"x-dataset":"analyst-estimates","x-credit-cost":4,"x-credit-call-type":"history","x-credit-multiplier":2,"x-plans":["basic","desk","enterprise"],"x-sample-url":"/v1/datasets/analyst-estimates/sample","responses":{"200":{"description":"Stored dataset response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DatasetResponse"}}},"headers":{"Request-Id":{"$ref":"#/components/headers/RequestId"},"Gloom-Version":{"$ref":"#/components/headers/GloomVersion"},"X-Credits-Cost":{"$ref":"#/components/headers/CreditsCost"},"X-Credits-Remaining":{"$ref":"#/components/headers/CreditsRemaining"},"X-Plan":{"$ref":"#/components/headers/Plan"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimitLimit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimitRemaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimitReset"},"ETag":{"$ref":"#/components/headers/ETag"}}},"304":{"$ref":"#/components/responses/NotModified"},"400":{"$ref":"#/components/responses/Error400"},"401":{"$ref":"#/components/responses/Error401"},"402":{"$ref":"#/components/responses/Error402"},"403":{"$ref":"#/components/responses/Error403"},"404":{"$ref":"#/components/responses/Error404"},"429":{"$ref":"#/components/responses/Error429"},"503":{"$ref":"#/components/responses/Error503"}}}}},"components":{"parameters":{"GloomVersion":{"name":"Gloom-Version","in":"header","required":false,"description":"The contract version to answer with. Omitted: the latest. An unknown version is refused with version_invalid.","schema":{"type":"string","enum":["2026-10-21"]}},"IfNoneMatch":{"name":"If-None-Match","in":"header","required":false,"description":"An ETag from an earlier response. When the data is unchanged the answer is a 304 with no body, at no credit cost.","schema":{"type":"string"}}},"headers":{"RequestId":{"description":"This request's id. Quote it to support.","schema":{"type":"string"}},"GloomVersion":{"description":"The contract version that answered.","schema":{"type":"string","enum":["2026-10-21"]}},"CreditsCost":{"description":"Credits charged for this request. An error is never charged: a call that fails after its charge, 4xx or 5xx, is refunded. A 304 is free.","schema":{"type":"integer","minimum":0}},"CreditsRemaining":{"description":"Credits remaining in the account's current period.","schema":{"type":"integer","minimum":0}},"Plan":{"schema":{"type":"string","enum":["basic","desk","enterprise"]}},"RateLimitLimit":{"description":"Credits the key may spend a minute.","schema":{"type":"integer","minimum":0}},"RateLimitRemaining":{"description":"Credits left in the key's sliding minute.","schema":{"type":"integer","minimum":0}},"RateLimitReset":{"description":"Seconds until the current minute ends.","schema":{"type":"integer","minimum":1}},"ETag":{"description":"A validator for this body. Send it back as If-None-Match to get a free 304 when nothing changed.","schema":{"type":"string"}},"RetryAfter":{"description":"Seconds until the request may be retried.","schema":{"type":"integer","minimum":1}},"WWWAuthenticate":{"description":"Bearer realm=\"Gloom Datasets\"; error=\"invalid_token\" only when a key was sent and refused (RFC 6750).","schema":{"type":"string"}}},"responses":{"NotModified":{"description":"Not modified: the If-None-Match ETag still matches. No body, no credits.","headers":{"Request-Id":{"$ref":"#/components/headers/RequestId"},"Gloom-Version":{"$ref":"#/components/headers/GloomVersion"}}},"Error400":{"description":"invalid_request: parameter_unknown, parameter_missing, parameter_invalid, parameter_repeated, cursor_invalid, body_invalid, version_invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"headers":{"Request-Id":{"$ref":"#/components/headers/RequestId"},"Gloom-Version":{"$ref":"#/components/headers/GloomVersion"},"X-Credits-Cost":{"$ref":"#/components/headers/CreditsCost"},"X-Credits-Remaining":{"$ref":"#/components/headers/CreditsRemaining"},"X-Plan":{"$ref":"#/components/headers/Plan"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimitLimit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimitRemaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimitReset"}}},"Error401":{"description":"authentication: missing_key, invalid_key, wrong_key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"headers":{"Request-Id":{"$ref":"#/components/headers/RequestId"},"Gloom-Version":{"$ref":"#/components/headers/GloomVersion"},"X-Credits-Cost":{"$ref":"#/components/headers/CreditsCost"},"X-Credits-Remaining":{"$ref":"#/components/headers/CreditsRemaining"},"X-Plan":{"$ref":"#/components/headers/Plan"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimitLimit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimitRemaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimitReset"},"WWW-Authenticate":{"$ref":"#/components/headers/WWWAuthenticate"}}},"Error402":{"description":"plan: plan_required, dataset_not_included.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"headers":{"Request-Id":{"$ref":"#/components/headers/RequestId"},"Gloom-Version":{"$ref":"#/components/headers/GloomVersion"},"X-Credits-Cost":{"$ref":"#/components/headers/CreditsCost"},"X-Credits-Remaining":{"$ref":"#/components/headers/CreditsRemaining"},"X-Plan":{"$ref":"#/components/headers/Plan"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimitLimit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimitRemaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimitReset"}}},"Error403":{"description":"permission: key_disabled.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"headers":{"Request-Id":{"$ref":"#/components/headers/RequestId"},"Gloom-Version":{"$ref":"#/components/headers/GloomVersion"},"X-Credits-Cost":{"$ref":"#/components/headers/CreditsCost"},"X-Credits-Remaining":{"$ref":"#/components/headers/CreditsRemaining"},"X-Plan":{"$ref":"#/components/headers/Plan"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimitLimit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimitRemaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimitReset"}}},"Error404":{"description":"not_found: not_found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"headers":{"Request-Id":{"$ref":"#/components/headers/RequestId"},"Gloom-Version":{"$ref":"#/components/headers/GloomVersion"},"X-Credits-Cost":{"$ref":"#/components/headers/CreditsCost"},"X-Credits-Remaining":{"$ref":"#/components/headers/CreditsRemaining"},"X-Plan":{"$ref":"#/components/headers/Plan"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimitLimit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimitRemaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimitReset"}}},"Error429":{"description":"rate_limit: rate_limited, credits_exhausted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"headers":{"Request-Id":{"$ref":"#/components/headers/RequestId"},"Gloom-Version":{"$ref":"#/components/headers/GloomVersion"},"X-Credits-Cost":{"$ref":"#/components/headers/CreditsCost"},"X-Credits-Remaining":{"$ref":"#/components/headers/CreditsRemaining"},"X-Plan":{"$ref":"#/components/headers/Plan"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimitLimit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimitRemaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimitReset"},"Retry-After":{"$ref":"#/components/headers/RetryAfter"}}},"Error503":{"description":"api_error: unavailable.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"headers":{"Request-Id":{"$ref":"#/components/headers/RequestId"},"Gloom-Version":{"$ref":"#/components/headers/GloomVersion"},"X-Credits-Cost":{"$ref":"#/components/headers/CreditsCost"},"X-Credits-Remaining":{"$ref":"#/components/headers/CreditsRemaining"},"X-Plan":{"$ref":"#/components/headers/Plan"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimitLimit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimitRemaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimitReset"},"Retry-After":{"$ref":"#/components/headers/RetryAfter"}}}},"securitySchemes":{"bearer":{"type":"http","scheme":"bearer","description":"A Gloom Datasets key, starting gds_. Gloom Pro and News API keys are refused with wrong_key."},"apiKey":{"type":"apiKey","in":"header","name":"x-api-key"}},"schemas":{"Error":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["type","code","message","param","requestId","docUrl"],"properties":{"type":{"type":"string","enum":["invalid_request","authentication","plan","permission","not_found","rate_limit","api_error"],"description":"Branch on the type first."},"code":{"type":"string","enum":["parameter_unknown","parameter_missing","parameter_invalid","parameter_repeated","cursor_invalid","body_invalid","version_invalid","missing_key","invalid_key","wrong_key","plan_required","dataset_not_included","key_disabled","not_found","rate_limited","credits_exhausted","unavailable"],"description":"The specific reason. Messages may change; codes do not."},"message":{"type":"string"},"param":{"type":["string","null"],"description":"The parameter or header the error is about."},"requestId":{"type":"string"},"docUrl":{"type":"string","format":"uri"}}}}},"Notice":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"}}},"Meta":{"type":"object","required":["dataset","requestId","asOf","dataThrough","historyStart","updatedAt","page","next","coverage","source","notices"],"properties":{"dataset":{"type":["string","null"],"enum":["gpu","hiring-jobs","hiring-momentum","app-attention","awards","kpis-guidance","credit-documents","power","perps","catalysts","research-attention","supply-chain","exposure","transcripts","exec-pay","risk-factors","events","document-search","news","social-mentions","cpi","energy-inventories","cot","short-volume","short-interest","sec","congress","macro","central-bank-rates","cds","debt-maturities","revenue-breakdown","market-data","futures","rate-path","options","earnings","ipo","mna","equity-screener","crypto","session-tape","analyst-estimates",null]},"requestId":{"type":"string","description":"Quote it to support."},"asOf":{"type":["string","null"],"description":"The point in time you asked for with asOf, or null for the latest."},"dataThrough":{"type":["string","null"],"description":"The newest date or time the data covers."},"historyStart":{"type":["string","null"],"description":"Earliest stored history when established by the service; otherwise null."},"updatedAt":{"type":["string","null"],"description":"When the stored data last changed, when established."},"page":{"oneOf":[{"type":"null"},{"type":"object","required":["limit","hasMore","nextCursor"],"properties":{"limit":{"type":"integer","minimum":1},"hasMore":{"type":"boolean"},"nextCursor":{"type":["string","null"]}}}],"description":"Paging of a list; null for a single record."},"next":{"type":["string","null"],"description":"The next page as a ready URL, or null."},"coverage":{"description":"Service-established coverage; null when unavailable."},"source":{"type":"array","items":{"type":"object","required":["id","attribution","licence"],"properties":{"id":{"type":"string"},"attribution":{"type":"string"},"licence":{"type":"string"}}}},"delayed":{"type":"boolean","const":true,"description":"Present, and true, only on market prices that follow delayed-data access."},"notices":{"type":"array","items":{"$ref":"#/components/schemas/Notice"},"description":"Caveats that change how to read the data: disclaimers, gaps, illustrative samples."}}},"DatasetResponse":{"type":"object","required":["data","meta"],"properties":{"data":{"description":"Dataset-specific stored records. See the sample route for representative field names."},"meta":{"$ref":"#/components/schemas/Meta"}}},"ChangelogEntry":{"type":"object","required":["version","title","changes","breaking"],"properties":{"version":{"type":"string","enum":["2026-10-21"]},"title":{"type":"string"},"changes":{"type":"array","items":{"type":"string"}},"breaking":{"type":"boolean"}}},"Dataset":{"type":"object","required":["id","name","status","creditCost","plans"],"properties":{"id":{"type":"string"},"name":{"type":"string"},"status":{"type":"string","enum":["live"]},"creditCost":{"type":"integer","minimum":1},"plans":{"type":"array","items":{"type":"string","enum":["basic","desk","enterprise"]}}}},"CreditEstimate":{"type":"object","required":["endpoint","dataset","credits","callType","base","multiplier"],"properties":{"endpoint":{"type":"string"},"dataset":{"type":"string"},"credits":{"type":"integer","minimum":1},"callType":{"type":"string","enum":["lookup","history","search","evidence","bulk","change"]},"base":{"type":"integer","minimum":1},"multiplier":{"type":"integer","enum":[1,2,4]}}},"Account":{"type":"object","required":["plan","status","period","credits","limits"],"description":"The account's plan and status, its credit period with authoritative credits used and remaining, and the rate and key limits applied to it. Enterprise limits are set by contract; until then an Enterprise account gets 6,000 credits a minute for each key and 100 keys.","properties":{"plan":{"type":"string","enum":["basic","desk","enterprise"]},"status":{"type":"string","enum":["active","suspended","canceled"]},"period":{"type":"object","required":["start","end"],"properties":{"start":{"type":"string","format":"date-time"},"end":{"type":"string","format":"date-time"}}},"credits":{"type":"object","required":["included","used","remaining"],"properties":{"included":{"type":"integer","minimum":0},"used":{"type":"integer","minimum":0},"remaining":{"type":"integer","minimum":0}}},"limits":{"type":"object","required":["perMinute","maxKeys"],"properties":{"perMinute":{"type":"integer","minimum":0,"description":"Credits a minute, for each key."},"maxKeys":{"type":"integer","minimum":0}}}}},"Usage":{"type":"object","required":["plan","status","period","credits","datasets"],"description":"The account's plan, credit period, authoritative credits used and remaining, and buffered per-dataset usage.","properties":{"plan":{"type":"string","enum":["basic","desk","enterprise"]},"status":{"type":"string","enum":["active","suspended","canceled"]},"credits":{"type":"object","required":["included","used","remaining"],"properties":{"included":{"type":"integer","minimum":0},"used":{"type":"integer","minimum":0},"remaining":{"type":"integer","minimum":0}}},"period":{"type":"object","required":["start","end"],"properties":{"start":{"type":"string","format":"date-time"},"end":{"type":"string","format":"date-time"}}},"datasets":{"type":"array","items":{"type":"object","required":["dataset","requests","credits","rows","errors"],"properties":{"dataset":{"type":"string"},"requests":{"type":"integer","minimum":0},"credits":{"type":"integer","minimum":0},"rows":{"type":"integer","minimum":0},"errors":{"type":"integer","minimum":0}}}}}}}}}