Documentation
Secregate API Documentation
Use the Secregate API to retrieve relevant SEC filing passages based on a search query, company identifier and optional filing filters.
Authentication
API access is currently provided manually. Contact nithard@portrak.com to request an API key.
Header
Authorization: Bearer YOUR_API_KEYSearch Endpoint
POST
/v1/searchSearch SEC filings for semantically relevant passages.
Request Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| query | string | yes | The search string, sentence or longer prompt to search for. |
| ticker | string | optional | Public company ticker, e.g. AAPL. Either ticker or cik should be provided. |
| cik | string | optional | SEC CIK number. Either ticker or cik should be provided. |
| filing_types | array of strings | optional | Filing types to search in, e.g. ["10-K", "10-Q", "8-K"]. |
| from_date | string | optional | Start date for the filing search range in YYYY-MM-DD format. |
| to_date | string | optional | End date for the filing search range in YYYY-MM-DD format. |
| max_results | integer | optional | Maximum number of passages to return. Default 10. |
| include_metadata | boolean | optional | Whether to include filing metadata. Default true. |
| include_positions | boolean | optional | Whether to include stable filing positions. Default true. |
Example Request
POST /v1/search
{
"ticker": "TSLA",
"query": "inventory growth and demand risk",
"filing_types": ["10-Q", "10-K"],
"from_date": "2022-01-01",
"to_date": "2024-12-31",
"max_results": 5,
"include_metadata": true,
"include_positions": true
}Example Response
JSON Response
{
"results": [
{
"company_name": "Tesla, Inc.",
"ticker": "TSLA",
"cik": "0001318605",
"filing_type": "10-Q",
"filing_date": "2024-04-23",
"accession_number": "0000950170-24-048006",
"section": "Management's Discussion and Analysis",
"passage": "Relevant passage text from the filing...",
"source_url": "https://www.sec.gov/Archives/edgar/data/...",
"position": {
"item": "Item 2",
"element_id": "item2_p_0031",
"char_start": 8842,
"char_end": 9460
},
"relevance_score": 0.91
}
]
}Response Fields
- company_nameCompany name
- tickerCompany ticker
- cikSEC CIK number
- filing_typeType of SEC filing
- filing_dateFiling date
- accession_numberSEC accession number
- sectionFiling section or item
- passageRetrieved relevant passage
- source_urlDirect SEC filing source URL
- positionStable position inside the parsed filing
- relevance_scoreInternal relevance score
Supported Filing Types
Initial support is focused on 10-K, 10-Q and 8-K filings. Additional filing types such as proxy statements may be added over time.
10-K10-Q8-KDEF 14AForm 4Other filing types on request
Example Use Cases
- Find risk factor language across filings
- Retrieve MD&A passages about demand, margins or liquidity
- Search for disclosure changes over time
- Find company-specific KPI context
- Ground AI-generated answers in original SEC filings
Access
To request access, contact nithard@portrak.com.