update openapi file

Author: Svisstack

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

@@ -22,10 +22,10 @@
     "/v1/download": {
       "get": {
         "tags": [
-          "File Download"
+          "Download"
         ],
         "summary": "Download file from SEC EDGAR archive",
-        "description": "Downloads a specific file from the SEC EDGAR archive using the accession number and filename.\nThe file is streamed directly from the SEC servers to the client.\n\n### Accession Number Format\nAccession numbers must be in the format: 0000000000-00-000000 (10 digits, dash, 2 digits, dash, 6 digits)\n\n### File Name Examples\n- Primary documents: `d123456d10k.htm`, `d789012d8k.htm`\n- XBRL files: `d123456d10k_htm.xml`, `FilingSummary.xml`\n- Exhibits: `d123456dexhibit99.htm`, `d123456dex101.htm`\n\n### File Types\nThe endpoint supports downloading various file types from SEC filings:\n- HTML documents (.htm, .html)\n- XBRL files (.xml, .xsd)\n- Text files (.txt)\n- PDF files (.pdf)\n- Other document formats as submitted to SEC\n\n:::tip\nYou can find available filenames for a specific filing using the `/v1/filings` endpoint first\n:::\n\n:::warning\nThis endpoint streams files directly from the SEC. Large files may take longer to download.\n:::",
+        "description": "Downloads a specific file from the SEC EDGAR archive using the accession number and filename.\nThe file is streamed directly from the SEC servers to the client.\n            \n### Accession Number Format\nAccession numbers must be in the format: 0000000000-00-000000 (10 digits, dash, 2 digits, dash, 6 digits)\n            \n### File Name Examples\n- Primary documents: `d123456d10k.htm`, `d789012d8k.htm`\n- XBRL files: `d123456d10k_htm.xml`, `FilingSummary.xml`\n- Exhibits: `d123456dexhibit99.htm`, `d123456dex101.htm`\n            \n### File Types\nThe endpoint supports downloading various file types from SEC filings:\n- HTML documents (.htm, .html)\n- XBRL files (.xml, .xsd)\n- Text files (.txt)\n- PDF files (.pdf)\n- Other document formats as submitted to SEC\n            \n:::tip\nYou can find available filenames for a specific filing using the `/v1/filings` endpoint first\n:::\n            \n:::warning\nThis endpoint streams files directly from the SEC. Large files may take longer to download.\n:::",
         "parameters": [
           {
             "name": "accession_no",
@@ -109,7 +109,7 @@
     "/v1/extractor": {
       "get": {
         "tags": [
-          "Content Extraction"
+          "Extractor"
         ],
         "summary": "Extract and classify SEC filing content",
         "description": "Retrieves filing content from the EDGAR database and intelligently classifies it according to form type and item categories.\n\n### Supported Form Types\n\nForm Type | Description\n----------|------------\n8-K      | Current report filing\n10-K     | Annual report filing\n10-Q     | Quarterly report filing\n\n### Content Classification\n- 8-K forms: Content classified by item numbers (e.g., 1.01, 2.01)\n- 10-K/10-Q forms: Items categorized by their respective part and item structure\n\n:::note\nBoth HTML and plain text documents are supported for content extraction.\n:::",
@@ -198,7 +198,7 @@
     "/v1/extractor/item": {
       "get": {
         "tags": [
-          "Content Extraction"
+          "Extractor"
         ],
         "summary": "Extract specific item content from SEC filing",
         "description": "Retrieves filing content from the EDGAR database and returns only the text content of the specified item number.\n\n### Item Number Format\n\nForm Type | Item Format Examples\n-----------|-------------------\n8-K       | 1.01, 2.01, 7.01\n10-K      | 1, 2, 3\n10-K/10-Q | PartI 1, PartII 2\n\n:::tip\nFor best results, ensure the item number matches exactly with the filing's structure.\n:::",
@@ -270,7 +270,7 @@
     "/v1/filings": {
       "get": {
         "tags": [
-          "Filing Metadata"
+          "Filings"
         ],
         "summary": "Query SEC filing metadata",
         "description": "Retrieves metadata for SEC filings based on various filter criteria with pagination and sorting support.\n\n### Available Sort Fields\n\nField Name | Description\n-----------|-------------\nAccessionNumber | SEC filing accession number\nFilingDate | Date when filing was submitted\nAcceptanceDateTime | Date and time of filing acceptance\nReportDate | Date of the report\nSize | Size of the filing document\n\n### Date Format\nAll dates must be provided in YYYY-MM-DD format\n\n### Form Types\nForm types can be provided as comma-separated values, e.g.: \"10-K,8-K,10-Q\"\n\n:::tip\nFor optimal performance, use date ranges and form types to narrow down your search\n:::",
@@ -448,7 +448,7 @@
     "/v1/full-text": {
       "get": {
         "tags": [
-          "Full Text Search"
+          "FullText"
         ],
         "summary": "Full-text search of SEC filing documents",
         "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 @@
     "/v1/xbrl-converter": {
       "get": {
         "tags": [
-          "XBRL Conversion"
+          "XbrlConverter"
         ],
         "summary": "Convert XBRL data to JSON format",
         "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,20 +1046,20 @@
   ],
   "tags": [
     {
-      "name": "Extractor",
-      "description": "Provides endpoints for extracting and classifying content from SEC filing HTML documents."
-    },
-    {
-      "name": "Filings",
-      "description": "Provides endpoints for querying historical SEC filing metadata.\nAllows users to filter filings based on criteria like CIK, form type, date ranges, etc."
+      "name": "XbrlConverter",
+      "description": "Provides endpoints for converting XBRL data to JSON format from various SEC filing sources."
     },
     {
       "name": "FullText",
       "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."
     },
     {
-      "name": "XbrlConverter",
-      "description": "Provides endpoints for converting XBRL data to JSON format from various SEC filing sources."
+      "name": "Filings",
+      "description": "Provides endpoints for querying historical SEC filing metadata.\nAllows users to filter filings based on criteria like CIK, form type, date ranges, etc."
+    },
+    {
+      "name": "Extractor",
+      "description": "Provides endpoints for extracting and classifying content from SEC filing HTML documents."
     },
     {
       "name": "Download",

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

@@ -15,9 +15,9 @@ paths:
   /v1/download:
     get:
       tags:
-        - File Download
+        - Download
       summary: Download file from SEC EDGAR archive
-      description: "Downloads a specific file from the SEC EDGAR archive using the accession number and filename.\nThe file is streamed directly from the SEC servers to the client.\n\n### Accession Number Format\nAccession numbers must be in the format: 0000000000-00-000000 (10 digits, dash, 2 digits, dash, 6 digits)\n\n### File Name Examples\n- Primary documents: `d123456d10k.htm`, `d789012d8k.htm`\n- XBRL files: `d123456d10k_htm.xml`, `FilingSummary.xml`\n- Exhibits: `d123456dexhibit99.htm`, `d123456dex101.htm`\n\n### File Types\nThe endpoint supports downloading various file types from SEC filings:\n- HTML documents (.htm, .html)\n- XBRL files (.xml, .xsd)\n- Text files (.txt)\n- PDF files (.pdf)\n- Other document formats as submitted to SEC\n\n:::tip\nYou can find available filenames for a specific filing using the `/v1/filings` endpoint first\n:::\n\n:::warning\nThis endpoint streams files directly from the SEC. Large files may take longer to download.\n:::"
+      description: "Downloads a specific file from the SEC EDGAR archive using the accession number and filename.\nThe file is streamed directly from the SEC servers to the client.\n            \n### Accession Number Format\nAccession numbers must be in the format: 0000000000-00-000000 (10 digits, dash, 2 digits, dash, 6 digits)\n            \n### File Name Examples\n- Primary documents: `d123456d10k.htm`, `d789012d8k.htm`\n- XBRL files: `d123456d10k_htm.xml`, `FilingSummary.xml`\n- Exhibits: `d123456dexhibit99.htm`, `d123456dex101.htm`\n            \n### File Types\nThe endpoint supports downloading various file types from SEC filings:\n- HTML documents (.htm, .html)\n- XBRL files (.xml, .xsd)\n- Text files (.txt)\n- PDF files (.pdf)\n- Other document formats as submitted to SEC\n            \n:::tip\nYou can find available filenames for a specific filing using the `/v1/filings` endpoint first\n:::\n            \n:::warning\nThis endpoint streams files directly from the SEC. Large files may take longer to download.\n:::"
       parameters:
         - name: accession_no
           in: query
@@ -71,7 +71,7 @@ paths:
   /v1/extractor:
     get:
       tags:
-        - Content Extraction
+        - Extractor
       summary: Extract and classify SEC filing content
       description: "Retrieves filing content from the EDGAR database and intelligently classifies it according to form type and item categories.\n\n### Supported Form Types\n\nForm Type | Description\n----------|------------\n8-K      | Current report filing\n10-K     | Annual report filing\n10-Q     | Quarterly report filing\n\n### Content Classification\n- 8-K forms: Content classified by item numbers (e.g., 1.01, 2.01)\n- 10-K/10-Q forms: Items categorized by their respective part and item structure\n\n:::note\nBoth HTML and plain text documents are supported for content extraction.\n:::"
       parameters:
@@ -134,7 +134,7 @@ paths:
   /v1/extractor/item:
     get:
       tags:
-        - Content Extraction
+        - Extractor
       summary: Extract specific item content from SEC filing
       description: "Retrieves filing content from the EDGAR database and returns only the text content of the specified item number.\n\n### Item Number Format\n\nForm Type | Item Format Examples\n-----------|-------------------\n8-K       | 1.01, 2.01, 7.01\n10-K      | 1, 2, 3\n10-K/10-Q | PartI 1, PartII 2\n\n:::tip\nFor best results, ensure the item number matches exactly with the filing's structure.\n:::"
       parameters:
@@ -179,7 +179,7 @@ paths:
   /v1/filings:
     get:
       tags:
-        - Filing Metadata
+        - Filings
       summary: Query SEC filing metadata
       description: "Retrieves metadata for SEC filings based on various filter criteria with pagination and sorting support.\n\n### Available Sort Fields\n\nField Name | Description\n-----------|-------------\nAccessionNumber | SEC filing accession number\nFilingDate | Date when filing was submitted\nAcceptanceDateTime | Date and time of filing acceptance\nReportDate | Date of the report\nSize | Size of the filing document\n\n### Date Format\nAll dates must be provided in YYYY-MM-DD format\n\n### Form Types\nForm types can be provided as comma-separated values, e.g.: \"10-K,8-K,10-Q\"\n\n:::tip\nFor optimal performance, use date ranges and form types to narrow down your search\n:::"
       parameters:
@@ -301,7 +301,7 @@ paths:
   /v1/full-text:
     get:
       tags:
-        - Full Text Search
+        - FullText
       summary: Full-text search of SEC filing documents
       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:::"
       parameters:
@@ -394,7 +394,7 @@ paths:
   /v1/xbrl-converter:
     get:
       tags:
-        - XBRL Conversion
+        - XbrlConverter
       summary: Convert XBRL data to JSON format
       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```"
       parameters:
@@ -761,13 +761,13 @@ security:
   - APIKey: [ ]
   - JWT: [ ]
 tags:
-  - name: Extractor
-    description: Provides endpoints for extracting and classifying content from SEC filing HTML documents.
-  - name: Filings
-    description: "Provides endpoints for querying historical SEC filing metadata.\nAllows users to filter filings based on criteria like CIK, form type, date ranges, etc."
-  - name: FullText
-    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."
   - name: XbrlConverter
     description: Provides endpoints for converting XBRL data to JSON format from various SEC filing sources.
+  - name: FullText
+    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."
+  - name: Filings
+    description: "Provides endpoints for querying historical SEC filing metadata.\nAllows users to filter filings based on criteria like CIK, form type, date ranges, etc."
+  - name: Extractor
+    description: Provides endpoints for extracting and classifying content from SEC filing HTML documents.
   - name: Download
     description: "Provides endpoints for downloading files directly from the SEC EDGAR archive.\nAllows users to download specific filing documents by accession number and filename."