Skip to content

Commit 6399cbb

Browse files
actions-botactions-bot
committed
Auto-generate SDK for FinFeedAPI SEC API REST Historical
1 parent 6e1fd32 commit 6399cbb

File tree

176 files changed

+7631
-34
lines changed

Some content is hidden

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

176 files changed

+7631
-34
lines changed

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

Lines changed: 62 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,22 @@ with Swagger.Streams;
1313
package body .Clients is
1414
pragma Style_Checks ("-bmrIu");
1515

16+
Mime_1 : aliased constant String := "application/octet-stream";
17+
Mime_2 : aliased constant String := "application/pdf";
18+
Mime_3 : aliased constant String := "text/html";
1619
Media_List_1 : constant Swagger.Mime_List := (
20+
1 => Swagger.Mime_Json,
21+
22+
2 => Mime_1'Access,
23+
24+
3 => Mime_2'Access,
25+
26+
4 => Swagger.Mime_Xml,
27+
28+
5 => Mime_3'Access,
29+
30+
6 => Swagger.Mime_Text );
31+
Media_List_2 : constant Swagger.Mime_List := (
1732
1 => Swagger.Mime_Json );
1833

1934

@@ -43,7 +58,7 @@ package body .Clients is
4358
URI : Swagger.Clients.URI_Type;
4459
Reply : Swagger.Value_Type;
4560
begin
46-
Client.Set_Accept (Media_List_1);
61+
Client.Set_Accept (Media_List_2);
4762

4863

4964
URI.Add_Param ("accession_number", Accession_Number);
@@ -76,7 +91,7 @@ package body .Clients is
7691
URI : Swagger.Clients.URI_Type;
7792
Reply : Swagger.Value_Type;
7893
begin
79-
Client.Set_Accept (Media_List_1);
94+
Client.Set_Accept (Media_List_2);
8095

8196

8297
URI.Add_Param ("accession_number", Accession_Number);
@@ -87,6 +102,48 @@ package body .Clients is
87102
.Models.Deserialize (Reply, "", Result);
88103
end V_1Extractor_Item_Get;
89104

105+
-- Download file from SEC EDGAR archive
106+
-- Downloads a specific file from the SEC EDGAR archive using the accession number and filename.
107+
-- The file is streamed directly from the SEC servers to the client.
108+
--
109+
-- ### Accession Number Format
110+
-- Accession numbers must be in the format: 0000000000-00-000000 (10 digits, dash, 2 digits, dash, 6 digits)
111+
--
112+
-- ### File Name Examples
113+
-- - Primary documents: `d123456d10k.htm`, `d789012d8k.htm`
114+
-- - XBRL files: `d123456d10k_htm.xml`, `FilingSummary.xml`
115+
-- - Exhibits: `d123456dexhibit99.htm`, `d123456dex101.htm`
116+
--
117+
-- ### File Types
118+
-- The endpoint supports downloading various file types from SEC filings:
119+
-- - HTML documents (.htm, .html)
120+
-- - XBRL files (.xml, .xsd)
121+
-- - Text files (.txt)
122+
-- - PDF files (.pdf)
123+
-- - Other document formats as submitted to SEC
124+
--
125+
-- :::tip
126+
-- You can find available filenames for a specific filing using the `/v1/filings` endpoint first
127+
-- :::
128+
--
129+
-- :::warning
130+
-- This endpoint streams files directly from the SEC. Large files may take longer to download.
131+
-- :::
132+
procedure V_1Download_Get
133+
(Client : in out Client_Type;
134+
Accession_No : in Swagger.UString;
135+
File_Name : in Swagger.UString) is
136+
URI : Swagger.Clients.URI_Type;
137+
begin
138+
Client.Set_Accept (Media_List_1);
139+
140+
141+
URI.Add_Param ("accession_no", Accession_No);
142+
URI.Add_Param ("file_name", File_Name);
143+
URI.Set_Path ("/v1/download");
144+
Client.Call (Swagger.Clients.GET, URI);
145+
end V_1Download_Get;
146+
90147
-- Query SEC filing metadata
91148
-- Retrieves metadata for SEC filings based on various filter criteria with pagination and sorting support.
92149
--
@@ -127,7 +184,7 @@ package body .Clients is
127184
URI : Swagger.Clients.URI_Type;
128185
Reply : Swagger.Value_Type;
129186
begin
130-
Client.Set_Accept (Media_List_1);
187+
Client.Set_Accept (Media_List_2);
131188

132189

133190
URI.Add_Param ("cik", Cik);
@@ -194,7 +251,7 @@ package body .Clients is
194251
URI : Swagger.Clients.URI_Type;
195252
Reply : Swagger.Value_Type;
196253
begin
197-
Client.Set_Accept (Media_List_1);
254+
Client.Set_Accept (Media_List_2);
198255

199256

200257
URI.Add_Param ("form_type", Form_Type);
@@ -280,7 +337,7 @@ package body .Clients is
280337
URI : Swagger.Clients.URI_Type;
281338
Reply : Swagger.Value_Type;
282339
begin
283-
Client.Set_Accept (Media_List_1);
340+
Client.Set_Accept (Media_List_2);
284341

285342

286343
URI.Add_Param ("htm-url", Htm_Url);

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

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -60,6 +60,38 @@ package .Clients is
6060
P_Type : in .Models.DTOExtractorType_Type;
6161
Result : out Swagger.UString);
6262

63+
-- Download file from SEC EDGAR archive
64+
-- Downloads a specific file from the SEC EDGAR archive using the accession number and filename.
65+
-- The file is streamed directly from the SEC servers to the client.
66+
--
67+
-- ### Accession Number Format
68+
-- Accession numbers must be in the format: 0000000000-00-000000 (10 digits, dash, 2 digits, dash, 6 digits)
69+
--
70+
-- ### File Name Examples
71+
-- - Primary documents: `d123456d10k.htm`, `d789012d8k.htm`
72+
-- - XBRL files: `d123456d10k_htm.xml`, `FilingSummary.xml`
73+
-- - Exhibits: `d123456dexhibit99.htm`, `d123456dex101.htm`
74+
--
75+
-- ### File Types
76+
-- The endpoint supports downloading various file types from SEC filings:
77+
-- - HTML documents (.htm, .html)
78+
-- - XBRL files (.xml, .xsd)
79+
-- - Text files (.txt)
80+
-- - PDF files (.pdf)
81+
-- - Other document formats as submitted to SEC
82+
--
83+
-- :::tip
84+
-- You can find available filenames for a specific filing using the `/v1/filings` endpoint first
85+
-- :::
86+
--
87+
-- :::warning
88+
-- This endpoint streams files directly from the SEC. Large files may take longer to download.
89+
-- :::
90+
procedure V_1Download_Get
91+
(Client : in out Client_Type;
92+
Accession_No : in Swagger.UString;
93+
File_Name : in Swagger.UString);
94+
6395
-- Query SEC filing metadata
6496
-- Retrieves metadata for SEC filings based on various filter criteria with pagination and sorting support.
6597
--

‎finfeedapi/sec-api-rest/sdk/android/.openapi-generator/FILES‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@ docs/DTOExtractorType.md
77
docs/DTOFilingMetadataDto.md
88
docs/DTOFilingSortBy.md
99
docs/DTOSecFilingResultDto.md
10+
docs/FileDownloadApi.md
1011
docs/FilingMetadataApi.md
1112
docs/FullTextSearchApi.md
1213
docs/MvcProblemDetails.md
@@ -25,6 +26,7 @@ src/main/java/org/openapitools/client/ApiInvoker.java
2526
src/main/java/org/openapitools/client/JsonUtil.java
2627
src/main/java/org/openapitools/client/Pair.java
2728
src/main/java/org/openapitools/client/api/ContentExtractionApi.java
29+
src/main/java/org/openapitools/client/api/FileDownloadApi.java
2830
src/main/java/org/openapitools/client/api/FilingMetadataApi.java
2931
src/main/java/org/openapitools/client/api/FullTextSearchApi.java
3032
src/main/java/org/openapitools/client/api/XBRLConversionApi.java

‎finfeedapi/sec-api-rest/sdk/android/README.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -86,6 +86,7 @@ Class | Method | HTTP request | Description
8686
------------ | ------------- | ------------- | -------------
8787
*ContentExtractionApi* | [**v1ExtractorGet**](docs/ContentExtractionApi.md#v1ExtractorGet) | **GET** /v1/extractor | Extract and classify SEC filing content
8888
*ContentExtractionApi* | [**v1ExtractorItemGet**](docs/ContentExtractionApi.md#v1ExtractorItemGet) | **GET** /v1/extractor/item | Extract specific item content from SEC filing
89+
*FileDownloadApi* | [**v1DownloadGet**](docs/FileDownloadApi.md#v1DownloadGet) | **GET** /v1/download | Download file from SEC EDGAR archive
8990
*FilingMetadataApi* | [**v1FilingsGet**](docs/FilingMetadataApi.md#v1FilingsGet) | **GET** /v1/filings | Query SEC filing metadata
9091
*FullTextSearchApi* | [**v1FullTextGet**](docs/FullTextSearchApi.md#v1FullTextGet) | **GET** /v1/full-text | Full-text search of SEC filing documents
9192
*XBRLConversionApi* | [**v1XbrlConverterGet**](docs/XBRLConversionApi.md#v1XbrlConverterGet) | **GET** /v1/xbrl-converter | Convert XBRL data to JSON format

‎finfeedapi/sec-api-rest/sdk/android/docs/FileDownloadApi.md‎

Lines changed: 56 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
1+
# FileDownloadApi
2+
3+
All URIs are relative to *https://api.sec.finfeedapi.com*
4+
5+
Method | HTTP request | Description
6+
------------- | ------------- | -------------
7+
[**v1DownloadGet**](FileDownloadApi.md#v1DownloadGet) | **GET** /v1/download | Download file from SEC EDGAR archive
8+
9+
10+
11+
## v1DownloadGet
12+
13+
> v1DownloadGet(accessionNo, fileName)
14+
15+
Download file from SEC EDGAR archive
16+
17+
Downloads a specific file from the SEC EDGAR archive using the accession number and filename. The file is streamed directly from the SEC servers to the client. ### Accession Number Format Accession numbers must be in the format: 0000000000-00-000000 (10 digits, dash, 2 digits, dash, 6 digits) ### File Name Examples - Primary documents: `d123456d10k.htm`, `d789012d8k.htm` - XBRL files: `d123456d10k_htm.xml`, `FilingSummary.xml` - Exhibits: `d123456dexhibit99.htm`, `d123456dex101.htm` ### File Types The endpoint supports downloading various file types from SEC filings: - HTML documents (.htm, .html) - XBRL files (.xml, .xsd) - Text files (.txt) - PDF files (.pdf) - Other document formats as submitted to SEC :::tip You can find available filenames for a specific filing using the `/v1/filings` endpoint first ::: :::warning This endpoint streams files directly from the SEC. Large files may take longer to download. :::
18+
19+
### Example
20+
21+
```java
22+
// Import classes:
23+
//import org.openapitools.client.api.FileDownloadApi;
24+
25+
FileDownloadApi apiInstance = new FileDownloadApi();
26+
String accessionNo = null; // String | SEC filing accession number in format: 0000000000-00-000000
27+
String fileName = null; // String | Name of the file to download from the filing
28+
try {
29+
apiInstance.v1DownloadGet(accessionNo, fileName);
30+
} catch (ApiException e) {
31+
System.err.println("Exception when calling FileDownloadApi#v1DownloadGet");
32+
e.printStackTrace();
33+
}
34+
```
35+
36+
### Parameters
37+
38+
39+
Name | Type | Description | Notes
40+
------------- | ------------- | ------------- | -------------
41+
**accessionNo** | **String**| SEC filing accession number in format: 0000000000-00-000000 | [default to null]
42+
**fileName** | **String**| Name of the file to download from the filing | [default to null]
43+
44+
### Return type
45+
46+
null (empty response body)
47+
48+
### Authorization
49+
50+
[APIKey](../README.md#APIKey), [JWT](../README.md#JWT)
51+
52+
### HTTP request headers
53+
54+
- **Content-Type**: Not defined
55+
- **Accept**: application/octet-stream, text/html, application/xml, text/plain, application/pdf, application/json
56+

0 commit comments

Comments
 (0)