Skip to content

Commit fddb3b2

Browse files
actions-botactions-bot
committed
Auto-generate SDK for FinFeedAPI SEC API REST Historical
1 parent f6a14c1 commit fddb3b2

File tree

690 files changed

+4960
-3160
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

690 files changed

+4960
-3160
lines changed

‎finfeedapi/sec-api-rest/sdk/ada/defaultpackage.gpr‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
-- REST API
1+
-- FinFeedAPI SEC REST API
22
-- No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
33
-- The version of the OpenAPI document: 1.0.0
44
--

‎finfeedapi/sec-api-rest/sdk/ada/src/-client.adb‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
-- ------------ EDIT NOTE ------------
2-
-- REST API
2+
-- FinFeedAPI SEC REST API
33
-- No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
44
-- This file was generated with openapi-generator. You can modify it to implement
55
-- the client. After you modify this file, you should add the following line

‎finfeedapi/sec-api-rest/sdk/ada/src/.ads‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
-- REST API
1+
-- FinFeedAPI SEC REST API
22
-- No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
33
-- ------------ EDIT NOTE ------------
44
-- This file was generated with openapi-generator. You can modify it to implement

‎finfeedapi/sec-api-rest/sdk/ada/src/client/-clients.adb‎

Lines changed: 137 additions & 137 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
-- REST API
1+
-- FinFeedAPI SEC REST API
22
-- No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
33
--
44
-- The version of the OpenAPI document: v1
@@ -18,22 +18,22 @@ package body .Clients is
1818

1919

2020
-- Extract and classify SEC filing content
21-
-- Retrieves filing content from the EDGAR database and intelligently classifies it according to form type and item categories.
22-
--
23-
-- ### Supported Form Types
24-
--
25-
-- Form Type | Description
26-
-- ----------|------------
27-
-- 8-K | Current report filing
28-
-- 10-K | Annual report filing
29-
-- 10-Q | Quarterly report filing
30-
--
31-
-- ### Content Classification
32-
-- - 8-K forms: Content classified by item numbers (e.g., 1.01, 2.01)
33-
-- - 10-K/10-Q forms: Items categorized by their respective part and item structure
34-
--
35-
-- :::note
36-
-- Both HTML and plain text documents are supported for content extraction.
21+
-- Retrieves filing content from the EDGAR database and intelligently classifies it according to form type and item categories.
22+
--
23+
-- ### Supported Form Types
24+
--
25+
-- Form Type | Description
26+
-- ----------|------------
27+
-- 8-K | Current report filing
28+
-- 10-K | Annual report filing
29+
-- 10-Q | Quarterly report filing
30+
--
31+
-- ### Content Classification
32+
-- - 8-K forms: Content classified by item numbers (e.g., 1.01, 2.01)
33+
-- - 10-K/10-Q forms: Items categorized by their respective part and item structure
34+
--
35+
-- :::note
36+
-- Both HTML and plain text documents are supported for content extraction.
3737
-- :::
3838
procedure V_1Extractor_Get
3939
(Client : in out Client_Type;
@@ -54,18 +54,18 @@ package body .Clients is
5454
end V_1Extractor_Get;
5555

5656
-- Extract specific item content from SEC filing
57-
-- Retrieves filing content from the EDGAR database and returns only the text content of the specified item number.
58-
--
59-
-- ### Item Number Format
60-
--
61-
-- Form Type | Item Format Examples
62-
-- -----------|-------------------
63-
-- 8-K | 1.01, 2.01, 7.01
64-
-- 10-K | 1, 2, 3
65-
-- 10-K/10-Q | PartI 1, PartII 2
66-
--
67-
-- :::tip
68-
-- For best results, ensure the item number matches exactly with the filing's structure.
57+
-- Retrieves filing content from the EDGAR database and returns only the text content of the specified item number.
58+
--
59+
-- ### Item Number Format
60+
--
61+
-- Form Type | Item Format Examples
62+
-- -----------|-------------------
63+
-- 8-K | 1.01, 2.01, 7.01
64+
-- 10-K | 1, 2, 3
65+
-- 10-K/10-Q | PartI 1, PartII 2
66+
--
67+
-- :::tip
68+
-- For best results, ensure the item number matches exactly with the filing's structure.
6969
-- :::
7070
procedure V_1Extractor_Item_Get
7171
(Client : in out Client_Type;
@@ -88,26 +88,26 @@ package body .Clients is
8888
end V_1Extractor_Item_Get;
8989

9090
-- Query SEC filing metadata
91-
-- Retrieves metadata for SEC filings based on various filter criteria with pagination and sorting support.
92-
--
93-
-- ### Available Sort Fields
94-
--
95-
-- Field Name | Description
96-
-- -----------|-------------
97-
-- AccessionNumber | SEC filing accession number
98-
-- FilingDate | Date when filing was submitted
99-
-- AcceptanceDateTime | Date and time of filing acceptance
100-
-- ReportDate | Date of the report
101-
-- Size | Size of the filing document
102-
--
103-
-- ### Date Format
104-
-- All dates must be provided in YYYY-MM-DD format
105-
--
106-
-- ### Form Types
107-
-- Form types can be provided as comma-separated values, e.g.: "10-K,8-K,10-Q"
108-
--
109-
-- :::tip
110-
-- For optimal performance, use date ranges and form types to narrow down your search
91+
-- Retrieves metadata for SEC filings based on various filter criteria with pagination and sorting support.
92+
--
93+
-- ### Available Sort Fields
94+
--
95+
-- Field Name | Description
96+
-- -----------|-------------
97+
-- AccessionNumber | SEC filing accession number
98+
-- FilingDate | Date when filing was submitted
99+
-- AcceptanceDateTime | Date and time of filing acceptance
100+
-- ReportDate | Date of the report
101+
-- Size | Size of the filing document
102+
--
103+
-- ### Date Format
104+
-- All dates must be provided in YYYY-MM-DD format
105+
--
106+
-- ### Form Types
107+
-- Form types can be provided as comma-separated values, e.g.: "10-K,8-K,10-Q"
108+
--
109+
-- :::tip
110+
-- For optimal performance, use date ranges and form types to narrow down your search
111111
-- :::
112112
procedure V_1Filings_Get
113113
(Client : in out Client_Type;
@@ -148,36 +148,36 @@ package body .Clients is
148148
end V_1Filings_Get;
149149

150150
-- Full_text search of SEC filing documents
151-
-- Search across SEC filing documents with advanced filtering and sorting capabilities.
152-
--
153-
-- ### Available Sort Fields
154-
--
155-
-- Field Name | Description
156-
-- -----------|-------------
157-
-- AccessionNumber | SEC filing accession number
158-
-- FormType | Type of the filing document
159-
-- FilingDate | Date when filing was submitted
160-
-- CompanyName | Name of the company
161-
-- CIK | Central Index Key
162-
-- DocumentFilename | Name of the filing document
163-
-- DocumentDescription | Description of the document
164-
--
165-
-- ### Search Options
166-
--
167-
-- Option | Description
168-
-- --------|-------------
169-
-- text_contains | Keywords that must appear in the document
170-
-- text_not_contain | Keywords that must not appear in the document
171-
--
172-
-- ### Date Format
173-
-- All dates must be provided in YYYY-MM-DD format
174-
--
175-
-- :::tip
176-
-- Use text_contains and text_not_contain with multiple keywords separated by commas for more precise searches
177-
-- :::
178-
--
179-
-- :::note
180-
-- The search is case-insensitive and supports partial word matches
151+
-- Search across SEC filing documents with advanced filtering and sorting capabilities.
152+
--
153+
-- ### Available Sort Fields
154+
--
155+
-- Field Name | Description
156+
-- -----------|-------------
157+
-- AccessionNumber | SEC filing accession number
158+
-- FormType | Type of the filing document
159+
-- FilingDate | Date when filing was submitted
160+
-- CompanyName | Name of the company
161+
-- CIK | Central Index Key
162+
-- DocumentFilename | Name of the filing document
163+
-- DocumentDescription | Description of the document
164+
--
165+
-- ### Search Options
166+
--
167+
-- Option | Description
168+
-- --------|-------------
169+
-- text_contains | Keywords that must appear in the document
170+
-- text_not_contain | Keywords that must not appear in the document
171+
--
172+
-- ### Date Format
173+
-- All dates must be provided in YYYY-MM-DD format
174+
--
175+
-- :::tip
176+
-- Use text_contains and text_not_contain with multiple keywords separated by commas for more precise searches
177+
-- :::
178+
--
179+
-- :::note
180+
-- The search is case-insensitive and supports partial word matches
181181
-- :::
182182
procedure V_1Full_Text_Get
183183
(Client : in out Client_Type;
@@ -212,64 +212,64 @@ package body .Clients is
212212
end V_1Full_Text_Get;
213213

214214
-- Convert XBRL data to JSON format
215-
-- Converts XBRL data to JSON format using one of three possible input methods.
216-
--
217-
-- ### Input Methods
218-
--
219-
-- 1. HTML URL (htm-url)
220-
-- - URL of the filing ending with .htm or .html
221-
-- - Both filing URLs and index page URLs are accepted
222-
-- - Example: https://www.sec.gov/Archives/edgar/data/1318605/000156459021004599/tsla-10k_20201231.htm
223-
--
224-
-- 2. XBRL URL (xbrl-url)
225-
-- - URL of the XBRL file ending with .xml
226-
-- - Can be found in the dataFiles array from Query API
227-
-- - Example: https://www.sec.gov/Archives/edgar/data/1318605/000156459021004599/tsla-10k_20201231_htm.xml
228-
--
229-
-- 3. Accession Number (accession-no)
230-
-- - The SEC filing accession number
231-
-- - Example: 0001564590-21-004599
232-
--
233-
-- :::note
234-
-- Only one of the three parameters should be provided. If multiple parameters are provided, the priority order is:
235-
-- 1. htm-url
236-
-- 2. xbrl-url
237-
-- 3. accession-no
238-
-- :::
239-
--
240-
-- ### Supported Filing Types
241-
--
242-
-- - Annual Reports (10-K)
243-
-- - Quarterly Reports (10-Q)
244-
-- - Current Reports (8-K)
245-
-- - Registration Statements (S-1, S-3)
246-
-- - Foreign Private Issuer Reports (20-F, 40-F)
247-
--
248-
-- ### Response Format
249-
--
250-
-- The API returns a JSON object containing:
251-
-- - Financial statements (Income Statement, Balance Sheet, Cash Flow Statement)
252-
-- - Accounting policies and footnotes
253-
-- - Company information
254-
-- - Filing metadata
255-
--
256-
-- ### Example Response
257-
-- ```json
258-
-- {
259-
-- "StatementsOfIncome": {
260-
-- "RevenueFromContractWithCustomerExcludingAssessedTax": [
261-
-- {
262-
-- "decimals": "-6",
263-
-- "unitRef": "U_USD",
264-
-- "period": {
265-
-- "startDate": "2023-07-01",
266-
-- "endDate": "2024-06-30"
267-
-- },
268-
-- "value": "245122000000"
269-
-- }
270-
-- ]
271-
-- }
272-
-- }
215+
-- Converts XBRL data to JSON format using one of three possible input methods.
216+
--
217+
-- ### Input Methods
218+
--
219+
-- 1. HTML URL (htm-url)
220+
-- - URL of the filing ending with .htm or .html
221+
-- - Both filing URLs and index page URLs are accepted
222+
-- - Example: https://www.sec.gov/Archives/edgar/data/1318605/000156459021004599/tsla-10k_20201231.htm
223+
--
224+
-- 2. XBRL URL (xbrl-url)
225+
-- - URL of the XBRL file ending with .xml
226+
-- - Can be found in the dataFiles array from Query API
227+
-- - Example: https://www.sec.gov/Archives/edgar/data/1318605/000156459021004599/tsla-10k_20201231_htm.xml
228+
--
229+
-- 3. Accession Number (accession-no)
230+
-- - The SEC filing accession number
231+
-- - Example: 0001564590-21-004599
232+
--
233+
-- :::note
234+
-- Only one of the three parameters should be provided. If multiple parameters are provided, the priority order is:
235+
-- 1. htm-url
236+
-- 2. xbrl-url
237+
-- 3. accession-no
238+
-- :::
239+
--
240+
-- ### Supported Filing Types
241+
--
242+
-- - Annual Reports (10-K)
243+
-- - Quarterly Reports (10-Q)
244+
-- - Current Reports (8-K)
245+
-- - Registration Statements (S-1, S-3)
246+
-- - Foreign Private Issuer Reports (20-F, 40-F)
247+
--
248+
-- ### Response Format
249+
--
250+
-- The API returns a JSON object containing:
251+
-- - Financial statements (Income Statement, Balance Sheet, Cash Flow Statement)
252+
-- - Accounting policies and footnotes
253+
-- - Company information
254+
-- - Filing metadata
255+
--
256+
-- ### Example Response
257+
-- ```json
258+
-- {
259+
-- "StatementsOfIncome": {
260+
-- "RevenueFromContractWithCustomerExcludingAssessedTax": [
261+
-- {
262+
-- "decimals": "-6",
263+
-- "unitRef": "U_USD",
264+
-- "period": {
265+
-- "startDate": "2023-07-01",
266+
-- "endDate": "2024-06-30"
267+
-- },
268+
-- "value": "245122000000"
269+
-- }
270+
-- ]
271+
-- }
272+
-- }
273273
-- ```
274274
procedure V_1Xbrl_Converter_Get
275275
(Client : in out Client_Type;

0 commit comments

Comments
 (0)