Skip to content

Commit 73f9db6

Browse files
actions-botactions-bot
committed
Auto-generate SDK for FinFeedAPI SEC API REST Historical
1 parent 3727923 commit 73f9db6

File tree

389 files changed

+8381
-11424
lines changed

Some content is hidden

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

389 files changed

+8381
-11424
lines changed

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

Lines changed: 81 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ package body .Clients is
3939
(Client : in out Client_Type;
4040
Accession_Number : in Swagger.UString;
4141
P_Type : in .Models.DTOExtractorType_Type;
42-
Result : out .Models.DTOFilingExtractResultDto_Type) is
42+
Result : out Swagger..Models.AnyType_Type_Map) is
4343
URI : Swagger.Clients.URI_Type;
4444
Reply : Swagger.Value_Type;
4545
begin
@@ -208,4 +208,84 @@ package body .Clients is
208208
Client.Call (Swagger.Clients.GET, URI, Reply);
209209
.Models.Deserialize (Reply, "", Result);
210210
end V_1Full_Text_Get;
211+
212+
-- Convert XBRL data to JSON format
213+
-- Converts XBRL data to JSON format using one of three possible input methods.
214+
--
215+
-- ### Input Methods
216+
--
217+
-- 1. HTML URL (htm-url)
218+
-- - URL of the filing ending with .htm or .html
219+
-- - Both filing URLs and index page URLs are accepted
220+
-- - Example: https://www.sec.gov/Archives/edgar/data/1318605/000156459021004599/tsla-10k_20201231.htm
221+
--
222+
-- 2. XBRL URL (xbrl-url)
223+
-- - URL of the XBRL file ending with .xml
224+
-- - Can be found in the dataFiles array from Query API
225+
-- - Example: https://www.sec.gov/Archives/edgar/data/1318605/000156459021004599/tsla-10k_20201231_htm.xml
226+
--
227+
-- 3. Accession Number (accession-no)
228+
-- - The SEC filing accession number
229+
-- - Example: 0001564590-21-004599
230+
--
231+
-- :::note
232+
-- Only one of the three parameters should be provided. If multiple parameters are provided, the priority order is:
233+
-- 1. htm-url
234+
-- 2. xbrl-url
235+
-- 3. accession-no
236+
-- :::
237+
--
238+
-- ### Supported Filing Types
239+
--
240+
-- - Annual Reports (10-K)
241+
-- - Quarterly Reports (10-Q)
242+
-- - Current Reports (8-K)
243+
-- - Registration Statements (S-1, S-3)
244+
-- - Foreign Private Issuer Reports (20-F, 40-F)
245+
--
246+
-- ### Response Format
247+
--
248+
-- The API returns a JSON object containing:
249+
-- - Financial statements (Income Statement, Balance Sheet, Cash Flow Statement)
250+
-- - Accounting policies and footnotes
251+
-- - Company information
252+
-- - Filing metadata
253+
--
254+
-- ### Example Response
255+
-- ```json
256+
-- {
257+
-- "StatementsOfIncome": {
258+
-- "RevenueFromContractWithCustomerExcludingAssessedTax": [
259+
-- {
260+
-- "decimals": "-6",
261+
-- "unitRef": "U_USD",
262+
-- "period": {
263+
-- "startDate": "2023-07-01",
264+
-- "endDate": "2024-06-30"
265+
-- },
266+
-- "value": "245122000000"
267+
-- }
268+
-- ]
269+
-- }
270+
-- }
271+
-- ```
272+
procedure V_1Xbrl_Converter_Get
273+
(Client : in out Client_Type;
274+
Htm_Url : in Swagger.Nullable_UString;
275+
Xbrl_Url : in Swagger.Nullable_UString;
276+
Accession_No : in Swagger.Nullable_UString;
277+
Result : out Swagger..Models.AnyType_Type_Map) is
278+
URI : Swagger.Clients.URI_Type;
279+
Reply : Swagger.Value_Type;
280+
begin
281+
Client.Set_Accept (Media_List_1);
282+
283+
284+
URI.Add_Param ("htm-url", Htm_Url);
285+
URI.Add_Param ("xbrl-url", Xbrl_Url);
286+
URI.Add_Param ("accession-no", Accession_No);
287+
URI.Set_Path ("/v1/xbrl-converter");
288+
Client.Call (Swagger.Clients.GET, URI, Reply);
289+
.Models.Deserialize (Reply, "", Result);
290+
end V_1Xbrl_Converter_Get;
211291
end .Clients;

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

Lines changed: 68 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ package .Clients is
3737
(Client : in out Client_Type;
3838
Accession_Number : in Swagger.UString;
3939
P_Type : in .Models.DTOExtractorType_Type;
40-
Result : out .Models.DTOFilingExtractResultDto_Type);
40+
Result : out Swagger..Models.AnyType_Type_Map);
4141

4242
-- Extract specific item content from SEC filing
4343
-- Retrieves filing content from the EDGAR database and returns only the text content of the specified item number.
@@ -142,4 +142,71 @@ package .Clients is
142142
Sort_Order : in Swagger.Nullable_UString;
143143
Result : out .Models.DTOSecFilingResultDto_Type_Vectors.Vector);
144144

145+
-- Convert XBRL data to JSON format
146+
-- Converts XBRL data to JSON format using one of three possible input methods.
147+
--
148+
-- ### Input Methods
149+
--
150+
-- 1. HTML URL (htm-url)
151+
-- - URL of the filing ending with .htm or .html
152+
-- - Both filing URLs and index page URLs are accepted
153+
-- - Example: https://www.sec.gov/Archives/edgar/data/1318605/000156459021004599/tsla-10k_20201231.htm
154+
--
155+
-- 2. XBRL URL (xbrl-url)
156+
-- - URL of the XBRL file ending with .xml
157+
-- - Can be found in the dataFiles array from Query API
158+
-- - Example: https://www.sec.gov/Archives/edgar/data/1318605/000156459021004599/tsla-10k_20201231_htm.xml
159+
--
160+
-- 3. Accession Number (accession-no)
161+
-- - The SEC filing accession number
162+
-- - Example: 0001564590-21-004599
163+
--
164+
-- :::note
165+
-- Only one of the three parameters should be provided. If multiple parameters are provided, the priority order is:
166+
-- 1. htm-url
167+
-- 2. xbrl-url
168+
-- 3. accession-no
169+
-- :::
170+
--
171+
-- ### Supported Filing Types
172+
--
173+
-- - Annual Reports (10-K)
174+
-- - Quarterly Reports (10-Q)
175+
-- - Current Reports (8-K)
176+
-- - Registration Statements (S-1, S-3)
177+
-- - Foreign Private Issuer Reports (20-F, 40-F)
178+
--
179+
-- ### Response Format
180+
--
181+
-- The API returns a JSON object containing:
182+
-- - Financial statements (Income Statement, Balance Sheet, Cash Flow Statement)
183+
-- - Accounting policies and footnotes
184+
-- - Company information
185+
-- - Filing metadata
186+
--
187+
-- ### Example Response
188+
-- ```json
189+
-- {
190+
-- "StatementsOfIncome": {
191+
-- "RevenueFromContractWithCustomerExcludingAssessedTax": [
192+
-- {
193+
-- "decimals": "-6",
194+
-- "unitRef": "U_USD",
195+
-- "period": {
196+
-- "startDate": "2023-07-01",
197+
-- "endDate": "2024-06-30"
198+
-- },
199+
-- "value": "245122000000"
200+
-- }
201+
-- ]
202+
-- }
203+
-- }
204+
-- ```
205+
procedure V_1Xbrl_Converter_Get
206+
(Client : in out Client_Type;
207+
Htm_Url : in Swagger.Nullable_UString;
208+
Xbrl_Url : in Swagger.Nullable_UString;
209+
Accession_No : in Swagger.Nullable_UString;
210+
Result : out Swagger..Models.AnyType_Type_Map);
211+
145212
end .Clients;

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

Lines changed: 0 additions & 94 deletions
Original file line numberDiff line numberDiff line change
@@ -78,53 +78,6 @@ package body .Models is
7878
end loop;
7979
end Deserialize;
8080

81-
procedure Serialize (Into : in out Swagger.Streams.Output_Stream'Class;
82-
Name : in String;
83-
Value : in .Models.DTOFilingItemDto_Type) is
84-
begin
85-
Into.Start_Entity (Name);
86-
Into.Write_Entity ("item_number", Value.Item_Number);
87-
Into.Write_Entity ("item_title", Value.Item_Title);
88-
Into.Write_Entity ("content", Value.Content);
89-
Into.End_Entity (Name);
90-
end Serialize;
91-
92-
procedure Serialize (Into : in out Swagger.Streams.Output_Stream'Class;
93-
Name : in String;
94-
Value : in DTOFilingItemDto_Type_Vectors.Vector) is
95-
begin
96-
Into.Start_Array (Name);
97-
for Item of Value loop
98-
Serialize (Into, "", Item);
99-
end loop;
100-
Into.End_Array (Name);
101-
end Serialize;
102-
103-
procedure Deserialize (From : in Swagger.Value_Type;
104-
Name : in String;
105-
Value : out .Models.DTOFilingItemDto_Type) is
106-
Object : Swagger.Value_Type;
107-
begin
108-
Swagger.Streams.Deserialize (From, Name, Object);
109-
Swagger.Streams.Deserialize (Object, "item_number", Value.Item_Number);
110-
Swagger.Streams.Deserialize (Object, "item_title", Value.Item_Title);
111-
Swagger.Streams.Deserialize (Object, "content", Value.Content);
112-
end Deserialize;
113-
114-
procedure Deserialize (From : in Swagger.Value_Type;
115-
Name : in String;
116-
Value : in out DTOFilingItemDto_Type_Vectors.Vector) is
117-
List : Swagger.Value_Array_Type;
118-
Item : .Models.DTOFilingItemDto_Type;
119-
begin
120-
Value.Clear;
121-
Swagger.Streams.Deserialize (From, Name, List);
122-
for Data of List loop
123-
Deserialize (Data, "", Item);
124-
Value.Append (Item);
125-
end loop;
126-
end Deserialize;
127-
12881
procedure Serialize (Into : in out Swagger.Streams.Output_Stream'Class;
12982
Name : in String;
13083
Value : in .Models.DTOFilingMetadataDto_Type) is
@@ -450,52 +403,5 @@ package body .Models is
450403
end loop;
451404
end Deserialize;
452405

453-
procedure Serialize (Into : in out Swagger.Streams.Output_Stream'Class;
454-
Name : in String;
455-
Value : in .Models.DTOFilingExtractResultDto_Type) is
456-
begin
457-
Into.Start_Entity (Name);
458-
Into.Write_Entity ("accession_number", Value.Accession_Number);
459-
Into.Write_Entity ("form_type", Value.Form_Type);
460-
Serialize (Into, "items", Value.Items);
461-
Into.End_Entity (Name);
462-
end Serialize;
463-
464-
procedure Serialize (Into : in out Swagger.Streams.Output_Stream'Class;
465-
Name : in String;
466-
Value : in DTOFilingExtractResultDto_Type_Vectors.Vector) is
467-
begin
468-
Into.Start_Array (Name);
469-
for Item of Value loop
470-
Serialize (Into, "", Item);
471-
end loop;
472-
Into.End_Array (Name);
473-
end Serialize;
474-
475-
procedure Deserialize (From : in Swagger.Value_Type;
476-
Name : in String;
477-
Value : out .Models.DTOFilingExtractResultDto_Type) is
478-
Object : Swagger.Value_Type;
479-
begin
480-
Swagger.Streams.Deserialize (From, Name, Object);
481-
Swagger.Streams.Deserialize (Object, "accession_number", Value.Accession_Number);
482-
Swagger.Streams.Deserialize (Object, "form_type", Value.Form_Type);
483-
Deserialize (Object, "items", Value.Items);
484-
end Deserialize;
485-
486-
procedure Deserialize (From : in Swagger.Value_Type;
487-
Name : in String;
488-
Value : in out DTOFilingExtractResultDto_Type_Vectors.Vector) is
489-
List : Swagger.Value_Array_Type;
490-
Item : .Models.DTOFilingExtractResultDto_Type;
491-
begin
492-
Value.Clear;
493-
Swagger.Streams.Deserialize (From, Name, List);
494-
for Data of List loop
495-
Deserialize (Data, "", Item);
496-
Value.Append (Item);
497-
end loop;
498-
end Deserialize;
499-
500406

501407
end .Models;

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

Lines changed: 0 additions & 54 deletions
Original file line numberDiff line numberDiff line change
@@ -41,33 +41,6 @@ package .Models is
4141

4242

4343

44-
type DTOFilingItemDto_Type is
45-
record
46-
Item_Number : Swagger.Nullable_UString;
47-
Item_Title : Swagger.Nullable_UString;
48-
Content : Swagger.Nullable_UString;
49-
end record;
50-
51-
52-
package DTOFilingItemDto_Type_Vectors is
53-
new Ada.Containers.Vectors (Index_Type => Positive,
54-
Element_Type => .Models.DTOFilingItemDto_Type);
55-
56-
procedure Serialize (Into : in out Swagger.Streams.Output_Stream'Class;
57-
Name : in String;
58-
Value : in .Models.DTOFilingItemDto_Type);
59-
procedure Serialize (Into : in out Swagger.Streams.Output_Stream'Class;
60-
Name : in String;
61-
Value : in DTOFilingItemDto_Type_Vectors.Vector);
62-
procedure Deserialize (From : in Swagger.Value_Type;
63-
Name : in String;
64-
Value : out .Models.DTOFilingItemDto_Type);
65-
procedure Deserialize (From : in Swagger.Value_Type;
66-
Name : in String;
67-
Value : in out DTOFilingItemDto_Type_Vectors.Vector);
68-
69-
70-
7144
type DTOFilingMetadataDto_Type is
7245
record
7346
Cik : Swagger.Nullable_Long;
@@ -225,31 +198,4 @@ package .Models is
225198
Value : in out MvcValidationProblemDetails_Type_Vectors.Vector);
226199

227200

228-
229-
type DTOFilingExtractResultDto_Type is
230-
record
231-
Accession_Number : Swagger.Nullable_UString;
232-
Form_Type : Swagger.Nullable_UString;
233-
Items : .Models.DTOFilingItemDto_Type_Vectors.Vector;
234-
end record;
235-
236-
237-
package DTOFilingExtractResultDto_Type_Vectors is
238-
new Ada.Containers.Vectors (Index_Type => Positive,
239-
Element_Type => .Models.DTOFilingExtractResultDto_Type);
240-
241-
procedure Serialize (Into : in out Swagger.Streams.Output_Stream'Class;
242-
Name : in String;
243-
Value : in .Models.DTOFilingExtractResultDto_Type);
244-
procedure Serialize (Into : in out Swagger.Streams.Output_Stream'Class;
245-
Name : in String;
246-
Value : in DTOFilingExtractResultDto_Type_Vectors.Vector);
247-
procedure Deserialize (From : in Swagger.Value_Type;
248-
Name : in String;
249-
Value : out .Models.DTOFilingExtractResultDto_Type);
250-
procedure Deserialize (From : in Swagger.Value_Type;
251-
Name : in String;
252-
Value : in out DTOFilingExtractResultDto_Type_Vectors.Vector);
253-
254-
255201
end .Models;

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

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,15 +4,14 @@ README.md
44
build.gradle
55
docs/ContentExtractionApi.md
66
docs/DTOExtractorType.md
7-
docs/DTOFilingExtractResultDto.md
8-
docs/DTOFilingItemDto.md
97
docs/DTOFilingMetadataDto.md
108
docs/DTOFilingSortBy.md
119
docs/DTOSecFilingResultDto.md
1210
docs/FilingMetadataApi.md
1311
docs/FullTextSearchApi.md
1412
docs/MvcProblemDetails.md
1513
docs/MvcValidationProblemDetails.md
14+
docs/XBRLConversionApi.md
1615
git_push.sh
1716
gradle/wrapper/gradle-wrapper.jar
1817
gradle/wrapper/gradle-wrapper.properties
@@ -28,12 +27,11 @@ src/main/java/org/openapitools/client/Pair.java
2827
src/main/java/org/openapitools/client/api/ContentExtractionApi.java
2928
src/main/java/org/openapitools/client/api/FilingMetadataApi.java
3029
src/main/java/org/openapitools/client/api/FullTextSearchApi.java
30+
src/main/java/org/openapitools/client/api/XBRLConversionApi.java
3131
src/main/java/org/openapitools/client/auth/ApiKeyAuth.java
3232
src/main/java/org/openapitools/client/auth/Authentication.java
3333
src/main/java/org/openapitools/client/auth/HttpBasicAuth.java
3434
src/main/java/org/openapitools/client/model/DTOExtractorType.java
35-
src/main/java/org/openapitools/client/model/DTOFilingExtractResultDto.java
36-
src/main/java/org/openapitools/client/model/DTOFilingItemDto.java
3735
src/main/java/org/openapitools/client/model/DTOFilingMetadataDto.java
3836
src/main/java/org/openapitools/client/model/DTOFilingSortBy.java
3937
src/main/java/org/openapitools/client/model/DTOSecFilingResultDto.java

0 commit comments

Comments
 (0)