Skip to content

Commit 398fb89

Browse files
SvisstackSvisstack
committed
update openapi file
1 parent d590b9a commit 398fb89

2 files changed

Lines changed: 28 additions & 18 deletions

File tree

‎finfeedapi/sec-api-rest/spec/openapi.json‎

Lines changed: 14 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -448,7 +448,7 @@
448448
"/v1/full-text": {
449449
"get": {
450450
"tags": [
451-
"FullText"
451+
"Full Text"
452452
],
453453
"summary": "Full-text search of SEC filing documents",
454454
"description": "Search across SEC filing documents with advanced filtering and sorting capabilities.\n\n### Available Sort Fields\n\nField Name | Description\n-----------|-------------\nAccessionNumber | SEC filing accession number\nFormType | Type of the filing document\nFilingDate | Date when filing was submitted\nCompanyName | Name of the company\nCIK | Central Index Key\nDocumentFilename | Name of the filing document\nDocumentDescription | Description of the document\n\n### Search Options\n\nOption | Description\n--------|-------------\ntext_contains | Keywords that must appear in the document\ntext_not_contain | Keywords that must not appear in the document\n\n### Date Format\nAll dates must be provided in YYYY-MM-DD format\n\n:::tip\nUse text_contains and text_not_contain with multiple keywords separated by commas for more precise searches\n:::\n\n:::note\nThe search is case-insensitive and supports partial word matches\n:::",
@@ -588,7 +588,7 @@
588588
"/v1/xbrl-converter": {
589589
"get": {
590590
"tags": [
591-
"XbrlConverter"
591+
"XBRL Converter"
592592
],
593593
"summary": "Convert XBRL data to JSON format",
594594
"description": "Converts XBRL data to JSON format using one of three possible input methods.\n\n### Input Methods\n\n1. HTML URL (htm-url)\n - URL of the filing ending with .htm or .html\n - Both filing URLs and index page URLs are accepted\n - Example: https://www.sec.gov/Archives/edgar/data/1318605/000156459021004599/tsla-10k_20201231.htm\n\n2. XBRL URL (xbrl-url)\n - URL of the XBRL file ending with .xml\n - Can be found in the dataFiles array from Query API\n - Example: https://www.sec.gov/Archives/edgar/data/1318605/000156459021004599/tsla-10k_20201231_htm.xml\n\n3. Accession Number (accession-no)\n - The SEC filing accession number\n - Example: 0001564590-21-004599\n\n:::note\nOnly one of the three parameters should be provided. If multiple parameters are provided, the priority order is:\n1. htm-url\n2. xbrl-url\n3. accession-no\n:::\n\n### Supported Filing Types\n\n- Annual Reports (10-K)\n- Quarterly Reports (10-Q)\n- Current Reports (8-K)\n- Registration Statements (S-1, S-3)\n- Foreign Private Issuer Reports (20-F, 40-F)\n\n### Response Format\n\nThe API returns a JSON object containing:\n- Financial statements (Income Statement, Balance Sheet, Cash Flow Statement)\n- Accounting policies and footnotes\n- Company information\n- Filing metadata\n\n### Example Response\n```json\n{\n \"StatementsOfIncome\": {\n \"RevenueFromContractWithCustomerExcludingAssessedTax\": [\n {\n \"decimals\": \"-6\",\n \"unitRef\": \"U_USD\",\n \"period\": {\n \"startDate\": \"2023-07-01\",\n \"endDate\": \"2024-06-30\"\n },\n \"value\": \"245122000000\"\n }\n ]\n }\n}\n```",
@@ -1046,24 +1046,29 @@
10461046
],
10471047
"tags": [
10481048
{
1049-
"name": "XbrlConverter",
1050-
"description": "Provides endpoints for converting XBRL data to JSON format from various SEC filing sources."
1049+
"name": "XBRL Converter",
1050+
"description": "Convert SEC filing XBRL sources into structured JSON output.",
1051+
"x-displayName": "XBRL Converter"
10511052
},
10521053
{
1053-
"name": "FullText",
1054-
"description": "Provides endpoints for performing full-text searches on historical SEC filing documents.\nAllows users to query filings based on various criteria such as form type, date ranges, and text content."
1054+
"name": "Full Text",
1055+
"description": "Search SEC filing document contents using full-text queries and filters.",
1056+
"x-displayName": "Full Text"
10551057
},
10561058
{
10571059
"name": "Filings",
1058-
"description": "Provides endpoints for querying historical SEC filing metadata.\nAllows users to filter filings based on criteria like CIK, form type, date ranges, etc."
1060+
"description": "Query historical SEC filing metadata with filters such as CIK, forms, and dates.",
1061+
"x-displayName": "Filings"
10591062
},
10601063
{
10611064
"name": "Extractor",
1062-
"description": "Provides endpoints for extracting and classifying content from SEC filing HTML documents."
1065+
"description": "Extract and classify sections from SEC filing HTML documents.",
1066+
"x-displayName": "Extractor"
10631067
},
10641068
{
10651069
"name": "Download",
1066-
"description": "Provides endpoints for downloading files directly from the SEC EDGAR archive.\nAllows users to download specific filing documents by accession number and filename."
1070+
"description": "Download original filing documents directly from the SEC EDGAR archive.",
1071+
"x-displayName": "Download"
10671072
}
10681073
]
10691074
}

‎finfeedapi/sec-api-rest/spec/openapi.yaml‎

Lines changed: 14 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -301,7 +301,7 @@ paths:
301301
/v1/full-text:
302302
get:
303303
tags:
304-
- FullText
304+
- Full Text
305305
summary: Full-text search of SEC filing documents
306306
description: "Search across SEC filing documents with advanced filtering and sorting capabilities.\n\n### Available Sort Fields\n\nField Name | Description\n-----------|-------------\nAccessionNumber | SEC filing accession number\nFormType | Type of the filing document\nFilingDate | Date when filing was submitted\nCompanyName | Name of the company\nCIK | Central Index Key\nDocumentFilename | Name of the filing document\nDocumentDescription | Description of the document\n\n### Search Options\n\nOption | Description\n--------|-------------\ntext_contains | Keywords that must appear in the document\ntext_not_contain | Keywords that must not appear in the document\n\n### Date Format\nAll dates must be provided in YYYY-MM-DD format\n\n:::tip\nUse text_contains and text_not_contain with multiple keywords separated by commas for more precise searches\n:::\n\n:::note\nThe search is case-insensitive and supports partial word matches\n:::"
307307
parameters:
@@ -394,7 +394,7 @@ paths:
394394
/v1/xbrl-converter:
395395
get:
396396
tags:
397-
- XbrlConverter
397+
- XBRL Converter
398398
summary: Convert XBRL data to JSON format
399399
description: "Converts XBRL data to JSON format using one of three possible input methods.\n\n### Input Methods\n\n1. HTML URL (htm-url)\n - URL of the filing ending with .htm or .html\n - Both filing URLs and index page URLs are accepted\n - Example: https://www.sec.gov/Archives/edgar/data/1318605/000156459021004599/tsla-10k_20201231.htm\n\n2. XBRL URL (xbrl-url)\n - URL of the XBRL file ending with .xml\n - Can be found in the dataFiles array from Query API\n - Example: https://www.sec.gov/Archives/edgar/data/1318605/000156459021004599/tsla-10k_20201231_htm.xml\n\n3. Accession Number (accession-no)\n - The SEC filing accession number\n - Example: 0001564590-21-004599\n\n:::note\nOnly one of the three parameters should be provided. If multiple parameters are provided, the priority order is:\n1. htm-url\n2. xbrl-url\n3. accession-no\n:::\n\n### Supported Filing Types\n\n- Annual Reports (10-K)\n- Quarterly Reports (10-Q)\n- Current Reports (8-K)\n- Registration Statements (S-1, S-3)\n- Foreign Private Issuer Reports (20-F, 40-F)\n\n### Response Format\n\nThe API returns a JSON object containing:\n- Financial statements (Income Statement, Balance Sheet, Cash Flow Statement)\n- Accounting policies and footnotes\n- Company information\n- Filing metadata\n\n### Example Response\n```json\n{\n \"StatementsOfIncome\": {\n \"RevenueFromContractWithCustomerExcludingAssessedTax\": [\n {\n \"decimals\": \"-6\",\n \"unitRef\": \"U_USD\",\n \"period\": {\n \"startDate\": \"2023-07-01\",\n \"endDate\": \"2024-06-30\"\n },\n \"value\": \"245122000000\"\n }\n ]\n }\n}\n```"
400400
parameters:
@@ -761,13 +761,18 @@ security:
761761
- APIKey: [ ]
762762
- JWT: [ ]
763763
tags:
764-
- name: XbrlConverter
765-
description: Provides endpoints for converting XBRL data to JSON format from various SEC filing sources.
766-
- name: FullText
767-
description: "Provides endpoints for performing full-text searches on historical SEC filing documents.\nAllows users to query filings based on various criteria such as form type, date ranges, and text content."
764+
- name: XBRL Converter
765+
description: Convert SEC filing XBRL sources into structured JSON output.
766+
x-displayName: XBRL Converter
767+
- name: Full Text
768+
description: Search SEC filing document contents using full-text queries and filters.
769+
x-displayName: Full Text
768770
- name: Filings
769-
description: "Provides endpoints for querying historical SEC filing metadata.\nAllows users to filter filings based on criteria like CIK, form type, date ranges, etc."
771+
description: 'Query historical SEC filing metadata with filters such as CIK, forms, and dates.'
772+
x-displayName: Filings
770773
- name: Extractor
771-
description: Provides endpoints for extracting and classifying content from SEC filing HTML documents.
774+
description: Extract and classify sections from SEC filing HTML documents.
775+
x-displayName: Extractor
772776
- name: Download
773-
description: "Provides endpoints for downloading files directly from the SEC EDGAR archive.\nAllows users to download specific filing documents by accession number and filename."
777+
description: Download original filing documents directly from the SEC EDGAR archive.
778+
x-displayName: Download

0 commit comments

Comments
 (0)