/api/v1/indices/{id}/filingsGETThe named index plus CFTC filings related through its constituent markets.
Authorization
bearerAuth *Bearer <token>
Session token from the app, or an API key (the
ak_ prefix), sent as a Bearer token or an ?api_key= query parameter.. Token in: headerQuery Parameters
min_similarity?number
Min:
0Max: 1page?integer
Default:
1Min: 1per_page?integer
Default:
100Min: 1Max: 500Response
200 · The source index and related filings
index *object
Show properties
index_id *string
name *string
data *object[]
Show item properties
filing_id *integer (int64)
CFTC filing id.
similarity *number (double)
Cosine similarity of the title embedding match.
title *string
Product name on DCM product filings, otherwise the filing description.
org_code *string
Submitting organization code, for example KEX or CME.
feed *"ptc_dcm_rules" | "dcm_products" | "dco" | "dco_rules"
CFTC registry this filing belongs to.
status *string
Current CFTC status, for example Certified or 10 Day Review.
status_date *string (date)
Date of the current status.
description?stringnull
Filing description from the CFTC listing.
product_name?stringnull
Product name, when the registry carries one.
product_type?stringnull
category?stringnull
subcategory?stringnull
products_affected?stringnull
remarks?stringnull
receipt_date?string,null (date)
doc_count?integer
Number of attachments listed on the filing.
predicted_effective_date?string,null (date)
via_market_id?stringnull
The constituent market this filing matched most closely. Present only on index filings, where results are drawn from the index's constituent markets.
via_market_question?stringnull
The question text of that market.
meta *object
Show properties
total?integernull
Total number of records matching the request across every page, not just the current one. null on an uncounted list; page using has_next. A relevance-ranked search is uncounted, and a searched events list stays uncounted even with sort. A searched markets list with sort returns a total over the ranked matches (at most 10,000).
page?integer
The 1-based page number this response covers.
per_page?integer
Maximum number of items on a page. The last page may hold fewer.
total_pages?integernull
Total number of pages available at the current per_page. null whenever total is null; page using has_next.
has_next?boolean
True when a page exists after this one.
has_prev?boolean
True when this is not the first page.
total_capped?boolean
True when
total and total_pages reflect the server's counting ceiling rather than the exact matched count: the real set is at least total large. Render such totals as a lower bound (for example "10,000+"). Omitted when the count is exact. A sorted markets search that fills the 10,000-candidate ceiling sets this flag.404 · Unknown index id
Unknown index id