@invinite-org/data-api-client 5.6.0 → 5.7.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.openapi-generator/FILES +26 -0
- package/dist/apis/HoldingsApi.d.ts +33 -0
- package/dist/apis/HoldingsApi.js +79 -1
- package/dist/apis/IPOsApi.d.ts +54 -0
- package/dist/apis/IPOsApi.js +137 -1
- package/dist/apis/InsiderTradesApi.d.ts +3 -0
- package/dist/apis/InsiderTradesApi.js +9 -0
- package/dist/esm/apis/HoldingsApi.d.ts +33 -0
- package/dist/esm/apis/HoldingsApi.js +78 -0
- package/dist/esm/apis/IPOsApi.d.ts +54 -0
- package/dist/esm/apis/IPOsApi.js +136 -0
- package/dist/esm/apis/InsiderTradesApi.d.ts +3 -0
- package/dist/esm/apis/InsiderTradesApi.js +9 -0
- package/dist/esm/models/Company.d.ts +1 -1
- package/dist/esm/models/Filer.d.ts +6 -0
- package/dist/esm/models/Filer.js +2 -0
- package/dist/esm/models/FilerDetail.d.ts +14 -0
- package/dist/esm/models/FilerDetail.js +6 -0
- package/dist/esm/models/FilerFund.d.ts +45 -0
- package/dist/esm/models/FilerFund.js +52 -0
- package/dist/esm/models/FilerFundAdviser.d.ts +56 -0
- package/dist/esm/models/FilerFundAdviser.js +59 -0
- package/dist/esm/models/FilerFundReturn.d.ts +62 -0
- package/dist/esm/models/FilerFundReturn.js +63 -0
- package/dist/esm/models/FilerFundSeries.d.ts +217 -0
- package/dist/esm/models/FilerFundSeries.js +169 -0
- package/dist/esm/models/FilerFundShareClass.d.ts +44 -0
- package/dist/esm/models/FilerFundShareClass.js +51 -0
- package/dist/esm/models/FilerPrivateOfferings.d.ts +62 -0
- package/dist/esm/models/FilerPrivateOfferings.js +63 -0
- package/dist/esm/models/FundHolding.d.ts +140 -0
- package/dist/esm/models/FundHolding.js +83 -0
- package/dist/esm/models/InsiderTrade.d.ts +101 -0
- package/dist/esm/models/InsiderTrade.js +71 -0
- package/dist/esm/models/InsiderTradeFootnote.d.ts +38 -0
- package/dist/esm/models/InsiderTradeFootnote.js +47 -0
- package/dist/esm/models/ListFundHoldings200Response.d.ts +52 -0
- package/dist/esm/models/ListFundHoldings200Response.js +57 -0
- package/dist/esm/models/ListOfferings200Response.d.ts +52 -0
- package/dist/esm/models/ListOfferings200Response.js +57 -0
- package/dist/esm/models/ListOfferings200ResponseMeta.d.ts +39 -0
- package/dist/esm/models/ListOfferings200ResponseMeta.js +44 -0
- package/dist/esm/models/Offering.d.ts +275 -0
- package/dist/esm/models/Offering.js +209 -0
- package/dist/esm/models/OfferingRelatedPerson.d.ts +44 -0
- package/dist/esm/models/OfferingRelatedPerson.js +51 -0
- package/dist/esm/models/index.d.ts +13 -0
- package/dist/esm/models/index.js +13 -0
- package/dist/models/Company.d.ts +1 -1
- package/dist/models/Filer.d.ts +6 -0
- package/dist/models/Filer.js +2 -0
- package/dist/models/FilerDetail.d.ts +14 -0
- package/dist/models/FilerDetail.js +6 -0
- package/dist/models/FilerFund.d.ts +45 -0
- package/dist/models/FilerFund.js +59 -0
- package/dist/models/FilerFundAdviser.d.ts +56 -0
- package/dist/models/FilerFundAdviser.js +66 -0
- package/dist/models/FilerFundReturn.d.ts +62 -0
- package/dist/models/FilerFundReturn.js +70 -0
- package/dist/models/FilerFundSeries.d.ts +217 -0
- package/dist/models/FilerFundSeries.js +177 -0
- package/dist/models/FilerFundShareClass.d.ts +44 -0
- package/dist/models/FilerFundShareClass.js +58 -0
- package/dist/models/FilerPrivateOfferings.d.ts +62 -0
- package/dist/models/FilerPrivateOfferings.js +70 -0
- package/dist/models/FundHolding.d.ts +140 -0
- package/dist/models/FundHolding.js +90 -0
- package/dist/models/InsiderTrade.d.ts +101 -0
- package/dist/models/InsiderTrade.js +72 -1
- package/dist/models/InsiderTradeFootnote.d.ts +38 -0
- package/dist/models/InsiderTradeFootnote.js +54 -0
- package/dist/models/ListFundHoldings200Response.d.ts +52 -0
- package/dist/models/ListFundHoldings200Response.js +64 -0
- package/dist/models/ListOfferings200Response.d.ts +52 -0
- package/dist/models/ListOfferings200Response.js +64 -0
- package/dist/models/ListOfferings200ResponseMeta.d.ts +39 -0
- package/dist/models/ListOfferings200ResponseMeta.js +51 -0
- package/dist/models/Offering.d.ts +275 -0
- package/dist/models/Offering.js +217 -0
- package/dist/models/OfferingRelatedPerson.d.ts +44 -0
- package/dist/models/OfferingRelatedPerson.js +58 -0
- package/dist/models/index.d.ts +13 -0
- package/dist/models/index.js +13 -0
- package/docs/CompaniesApi.md +2 -2
- package/docs/Filer.md +2 -0
- package/docs/FilerDetail.md +4 -0
- package/docs/FilerFund.md +39 -0
- package/docs/FilerFundAdviser.md +43 -0
- package/docs/FilerFundReturn.md +45 -0
- package/docs/FilerFundSeries.md +93 -0
- package/docs/FilerFundShareClass.md +39 -0
- package/docs/FilerPrivateOfferings.md +45 -0
- package/docs/FundHolding.md +70 -0
- package/docs/HoldingsApi.md +105 -0
- package/docs/IPOsApi.md +195 -0
- package/docs/InsiderTrade.md +28 -0
- package/docs/InsiderTradeFootnote.md +37 -0
- package/docs/InsiderTradesApi.md +10 -1
- package/docs/ListFundHoldings200Response.md +41 -0
- package/docs/ListOfferings200Response.md +41 -0
- package/docs/ListOfferings200ResponseMeta.md +37 -0
- package/docs/Offering.md +111 -0
- package/docs/OfferingRelatedPerson.md +39 -0
- package/package.json +1 -1
- package/src/apis/HoldingsApi.ts +107 -0
- package/src/apis/IPOsApi.ts +186 -0
- package/src/apis/InsiderTradesApi.ts +15 -0
- package/src/models/Company.ts +1 -1
- package/src/models/Filer.ts +8 -0
- package/src/models/FilerDetail.ts +30 -0
- package/src/models/FilerFund.ts +92 -0
- package/src/models/FilerFundAdviser.ts +102 -0
- package/src/models/FilerFundReturn.ts +111 -0
- package/src/models/FilerFundSeries.ts +360 -0
- package/src/models/FilerFundShareClass.ts +84 -0
- package/src/models/FilerPrivateOfferings.ts +111 -0
- package/src/models/FundHolding.ts +212 -0
- package/src/models/InsiderTrade.ts +152 -0
- package/src/models/InsiderTradeFootnote.ts +75 -0
- package/src/models/ListFundHoldings200Response.ts +108 -0
- package/src/models/ListOfferings200Response.ts +108 -0
- package/src/models/ListOfferings200ResponseMeta.ts +81 -0
- package/src/models/Offering.ts +433 -0
- package/src/models/OfferingRelatedPerson.ts +84 -0
- package/src/models/index.ts +13 -0
|
@@ -21,12 +21,84 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
|
|
|
21
21
|
});
|
|
22
22
|
};
|
|
23
23
|
import * as runtime from '../runtime';
|
|
24
|
+
import { ListFundHoldings200ResponseFromJSON, } from '../models/ListFundHoldings200Response';
|
|
24
25
|
import { ListHoldingChanges200ResponseFromJSON, } from '../models/ListHoldingChanges200Response';
|
|
25
26
|
import { ListHoldings200ResponseFromJSON, } from '../models/ListHoldings200Response';
|
|
26
27
|
/**
|
|
27
28
|
*
|
|
28
29
|
*/
|
|
29
30
|
export class HoldingsApi extends runtime.BaseAPI {
|
|
31
|
+
/**
|
|
32
|
+
* Creates request options for listFundHoldings without sending the request
|
|
33
|
+
*/
|
|
34
|
+
listFundHoldingsRequestOpts(requestParameters) {
|
|
35
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
36
|
+
const queryParameters = {};
|
|
37
|
+
if (requestParameters['company'] != null) {
|
|
38
|
+
queryParameters['company'] = requestParameters['company'];
|
|
39
|
+
}
|
|
40
|
+
if (requestParameters['filer'] != null) {
|
|
41
|
+
queryParameters['filer'] = requestParameters['filer'];
|
|
42
|
+
}
|
|
43
|
+
if (requestParameters['series'] != null) {
|
|
44
|
+
queryParameters['series'] = requestParameters['series'];
|
|
45
|
+
}
|
|
46
|
+
if (requestParameters['accession'] != null) {
|
|
47
|
+
queryParameters['accession'] = requestParameters['accession'];
|
|
48
|
+
}
|
|
49
|
+
if (requestParameters['periodEnd'] != null) {
|
|
50
|
+
queryParameters['period_end'] = requestParameters['periodEnd'].toISOString().substring(0, 10);
|
|
51
|
+
}
|
|
52
|
+
if (requestParameters['sort'] != null) {
|
|
53
|
+
queryParameters['sort'] = requestParameters['sort'];
|
|
54
|
+
}
|
|
55
|
+
if (requestParameters['fields'] != null) {
|
|
56
|
+
queryParameters['fields'] = requestParameters['fields'];
|
|
57
|
+
}
|
|
58
|
+
if (requestParameters['limit'] != null) {
|
|
59
|
+
queryParameters['limit'] = requestParameters['limit'];
|
|
60
|
+
}
|
|
61
|
+
if (requestParameters['cursor'] != null) {
|
|
62
|
+
queryParameters['cursor'] = requestParameters['cursor'];
|
|
63
|
+
}
|
|
64
|
+
const headerParameters = {};
|
|
65
|
+
if (this.configuration && this.configuration.accessToken) {
|
|
66
|
+
const token = this.configuration.accessToken;
|
|
67
|
+
const tokenString = yield token("bearerAuth", []);
|
|
68
|
+
if (tokenString) {
|
|
69
|
+
headerParameters["Authorization"] = `Bearer ${tokenString}`;
|
|
70
|
+
}
|
|
71
|
+
}
|
|
72
|
+
let urlPath = `/v1/fund-holdings`;
|
|
73
|
+
return {
|
|
74
|
+
path: urlPath,
|
|
75
|
+
method: 'GET',
|
|
76
|
+
headers: headerParameters,
|
|
77
|
+
query: queryParameters,
|
|
78
|
+
};
|
|
79
|
+
});
|
|
80
|
+
}
|
|
81
|
+
/**
|
|
82
|
+
* N-PORT fund and ETF positions from the funds\' quarterly public reports (about 60 days after the report date): by issuer (`company=`, one row per fund holding it, from each fund\'s latest report on or before `period_end`, its positions in the issuer summed), by fund (`filer=` registrant CIK, `series=` when the registrant files for several funds: that fund\'s positions) or by filing (`accession=`, an NPORT-P filing\'s reported holdings as filed); exactly one of `company`, `filer` or `accession` (`series` alone needs `filer`). `period_end` defaults to today. Order: value in USD, descending (`company=`, `filer=`), the filing\'s line order (`accession=`); several companies are read one after another. A fund row is not a 13F `Holding` (different row type, R16): `/v1/holdings` keeps the 13F managers.
|
|
83
|
+
* List N-PORT fund holdings
|
|
84
|
+
*/
|
|
85
|
+
listFundHoldingsRaw(requestParameters, initOverrides) {
|
|
86
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
87
|
+
const requestOptions = yield this.listFundHoldingsRequestOpts(requestParameters);
|
|
88
|
+
const response = yield this.request(requestOptions, initOverrides);
|
|
89
|
+
return new runtime.JSONApiResponse(response, (jsonValue) => ListFundHoldings200ResponseFromJSON(jsonValue));
|
|
90
|
+
});
|
|
91
|
+
}
|
|
92
|
+
/**
|
|
93
|
+
* N-PORT fund and ETF positions from the funds\' quarterly public reports (about 60 days after the report date): by issuer (`company=`, one row per fund holding it, from each fund\'s latest report on or before `period_end`, its positions in the issuer summed), by fund (`filer=` registrant CIK, `series=` when the registrant files for several funds: that fund\'s positions) or by filing (`accession=`, an NPORT-P filing\'s reported holdings as filed); exactly one of `company`, `filer` or `accession` (`series` alone needs `filer`). `period_end` defaults to today. Order: value in USD, descending (`company=`, `filer=`), the filing\'s line order (`accession=`); several companies are read one after another. A fund row is not a 13F `Holding` (different row type, R16): `/v1/holdings` keeps the 13F managers.
|
|
94
|
+
* List N-PORT fund holdings
|
|
95
|
+
*/
|
|
96
|
+
listFundHoldings() {
|
|
97
|
+
return __awaiter(this, arguments, void 0, function* (requestParameters = {}, initOverrides) {
|
|
98
|
+
const response = yield this.listFundHoldingsRaw(requestParameters, initOverrides);
|
|
99
|
+
return yield response.value();
|
|
100
|
+
});
|
|
101
|
+
}
|
|
30
102
|
/**
|
|
31
103
|
* Creates request options for listHoldingChanges without sending the request
|
|
32
104
|
*/
|
|
@@ -167,6 +239,12 @@ export class HoldingsApi extends runtime.BaseAPI {
|
|
|
167
239
|
});
|
|
168
240
|
}
|
|
169
241
|
}
|
|
242
|
+
/**
|
|
243
|
+
* @export
|
|
244
|
+
*/
|
|
245
|
+
export const ListFundHoldingsSortEnum = {
|
|
246
|
+
ValueUsd: '-value_usd'
|
|
247
|
+
};
|
|
170
248
|
/**
|
|
171
249
|
* @export
|
|
172
250
|
*/
|
|
@@ -12,10 +12,16 @@
|
|
|
12
12
|
import * as runtime from '../runtime';
|
|
13
13
|
import { type Ipo } from '../models/Ipo';
|
|
14
14
|
import { type ListIpos200Response } from '../models/ListIpos200Response';
|
|
15
|
+
import { type ListOfferings200Response } from '../models/ListOfferings200Response';
|
|
16
|
+
import { type Offering } from '../models/Offering';
|
|
15
17
|
export interface GetIpoRequest {
|
|
16
18
|
ipoId: string;
|
|
17
19
|
fields?: string;
|
|
18
20
|
}
|
|
21
|
+
export interface GetOfferingRequest {
|
|
22
|
+
offeringId: string;
|
|
23
|
+
fields?: string;
|
|
24
|
+
}
|
|
19
25
|
export interface ListIposRequest {
|
|
20
26
|
stage?: string;
|
|
21
27
|
isSpac?: boolean;
|
|
@@ -29,6 +35,19 @@ export interface ListIposRequest {
|
|
|
29
35
|
limit?: number;
|
|
30
36
|
cursor?: string;
|
|
31
37
|
}
|
|
38
|
+
export interface ListOfferingsRequest {
|
|
39
|
+
company?: string;
|
|
40
|
+
filedAtGte?: Date;
|
|
41
|
+
filedAtLte?: Date;
|
|
42
|
+
exemption?: string;
|
|
43
|
+
industry?: string;
|
|
44
|
+
totalSoldGte?: number;
|
|
45
|
+
isAmendment?: boolean;
|
|
46
|
+
sort?: ListOfferingsSortEnum;
|
|
47
|
+
fields?: string;
|
|
48
|
+
limit?: number;
|
|
49
|
+
cursor?: string;
|
|
50
|
+
}
|
|
32
51
|
/**
|
|
33
52
|
*
|
|
34
53
|
*/
|
|
@@ -47,6 +66,20 @@ export declare class IPOsApi extends runtime.BaseAPI {
|
|
|
47
66
|
* Get an offering
|
|
48
67
|
*/
|
|
49
68
|
getIpo(requestParameters: GetIpoRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Ipo>;
|
|
69
|
+
/**
|
|
70
|
+
* Creates request options for getOffering without sending the request
|
|
71
|
+
*/
|
|
72
|
+
getOfferingRequestOpts(requestParameters: GetOfferingRequest): Promise<runtime.RequestOpts>;
|
|
73
|
+
/**
|
|
74
|
+
* One Form D private offering by its id (the Form D file number, e.g. `021-528681`), with the latest filing\'s facts and the held filing history; an unknown id answers 404. Form D is research data, not limited to listed companies: `company=` answers any Form D issuer CIK (funds, private companies; a ticker resolves only for a listed company), and the list is not gated by the coverage of the financial families.
|
|
75
|
+
* Get a Form D private offering
|
|
76
|
+
*/
|
|
77
|
+
getOfferingRaw(requestParameters: GetOfferingRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Offering>>;
|
|
78
|
+
/**
|
|
79
|
+
* One Form D private offering by its id (the Form D file number, e.g. `021-528681`), with the latest filing\'s facts and the held filing history; an unknown id answers 404. Form D is research data, not limited to listed companies: `company=` answers any Form D issuer CIK (funds, private companies; a ticker resolves only for a listed company), and the list is not gated by the coverage of the financial families.
|
|
80
|
+
* Get a Form D private offering
|
|
81
|
+
*/
|
|
82
|
+
getOffering(requestParameters: GetOfferingRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Offering>;
|
|
50
83
|
/**
|
|
51
84
|
* Creates request options for listIpos without sending the request
|
|
52
85
|
*/
|
|
@@ -61,6 +94,20 @@ export declare class IPOsApi extends runtime.BaseAPI {
|
|
|
61
94
|
* List offerings
|
|
62
95
|
*/
|
|
63
96
|
listIpos(requestParameters?: ListIposRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ListIpos200Response>;
|
|
97
|
+
/**
|
|
98
|
+
* Creates request options for listOfferings without sending the request
|
|
99
|
+
*/
|
|
100
|
+
listOfferingsRequestOpts(requestParameters: ListOfferingsRequest): Promise<runtime.RequestOpts>;
|
|
101
|
+
/**
|
|
102
|
+
* Form D private offerings (Regulation D and Section 4(a)(5) exempt offerings) from the SEC\'s quarterly Form D data sets, five years held: one row per offering (SEC\'s Form D file number; every amendment folds into it) with the latest filing\'s facts — issuer and co-issuers, exemptions as filed, industry group, security types, offering / sold / remaining amounts (USD), investors, related persons — and the held filing history. Filters: `company=` (one issuer CIK or listed ticker), `filed_at.gte|lte` (latest filing date), `exemption=`, `industry=`, `total_sold.gte`, `is_amendment`. Order: latest filing date descending, then offering id. An issuer CIK the SEC registry and the data set do not know answers 404; a known issuer without offerings an empty page. Form D is research data, not limited to listed companies: `company=` answers any Form D issuer CIK (funds, private companies; a ticker resolves only for a listed company), and the list is not gated by the coverage of the financial families.
|
|
103
|
+
* List Form D private offerings
|
|
104
|
+
*/
|
|
105
|
+
listOfferingsRaw(requestParameters: ListOfferingsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ListOfferings200Response>>;
|
|
106
|
+
/**
|
|
107
|
+
* Form D private offerings (Regulation D and Section 4(a)(5) exempt offerings) from the SEC\'s quarterly Form D data sets, five years held: one row per offering (SEC\'s Form D file number; every amendment folds into it) with the latest filing\'s facts — issuer and co-issuers, exemptions as filed, industry group, security types, offering / sold / remaining amounts (USD), investors, related persons — and the held filing history. Filters: `company=` (one issuer CIK or listed ticker), `filed_at.gte|lte` (latest filing date), `exemption=`, `industry=`, `total_sold.gte`, `is_amendment`. Order: latest filing date descending, then offering id. An issuer CIK the SEC registry and the data set do not know answers 404; a known issuer without offerings an empty page. Form D is research data, not limited to listed companies: `company=` answers any Form D issuer CIK (funds, private companies; a ticker resolves only for a listed company), and the list is not gated by the coverage of the financial families.
|
|
108
|
+
* List Form D private offerings
|
|
109
|
+
*/
|
|
110
|
+
listOfferings(requestParameters?: ListOfferingsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ListOfferings200Response>;
|
|
64
111
|
}
|
|
65
112
|
/**
|
|
66
113
|
* @export
|
|
@@ -72,3 +119,10 @@ export declare const ListIposSortEnum: {
|
|
|
72
119
|
readonly FirstPublicAt2: "-first_public_at";
|
|
73
120
|
};
|
|
74
121
|
export type ListIposSortEnum = typeof ListIposSortEnum[keyof typeof ListIposSortEnum];
|
|
122
|
+
/**
|
|
123
|
+
* @export
|
|
124
|
+
*/
|
|
125
|
+
export declare const ListOfferingsSortEnum: {
|
|
126
|
+
readonly FiledLatest: "-filed_latest";
|
|
127
|
+
};
|
|
128
|
+
export type ListOfferingsSortEnum = typeof ListOfferingsSortEnum[keyof typeof ListOfferingsSortEnum];
|
package/dist/esm/apis/IPOsApi.js
CHANGED
|
@@ -23,6 +23,8 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
|
|
|
23
23
|
import * as runtime from '../runtime';
|
|
24
24
|
import { IpoFromJSON, } from '../models/Ipo';
|
|
25
25
|
import { ListIpos200ResponseFromJSON, } from '../models/ListIpos200Response';
|
|
26
|
+
import { ListOfferings200ResponseFromJSON, } from '../models/ListOfferings200Response';
|
|
27
|
+
import { OfferingFromJSON, } from '../models/Offering';
|
|
26
28
|
/**
|
|
27
29
|
*
|
|
28
30
|
*/
|
|
@@ -78,6 +80,57 @@ export class IPOsApi extends runtime.BaseAPI {
|
|
|
78
80
|
return yield response.value();
|
|
79
81
|
});
|
|
80
82
|
}
|
|
83
|
+
/**
|
|
84
|
+
* Creates request options for getOffering without sending the request
|
|
85
|
+
*/
|
|
86
|
+
getOfferingRequestOpts(requestParameters) {
|
|
87
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
88
|
+
if (requestParameters['offeringId'] == null) {
|
|
89
|
+
throw new runtime.RequiredError('offeringId', 'Required parameter "offeringId" was null or undefined when calling getOffering().');
|
|
90
|
+
}
|
|
91
|
+
const queryParameters = {};
|
|
92
|
+
if (requestParameters['fields'] != null) {
|
|
93
|
+
queryParameters['fields'] = requestParameters['fields'];
|
|
94
|
+
}
|
|
95
|
+
const headerParameters = {};
|
|
96
|
+
if (this.configuration && this.configuration.accessToken) {
|
|
97
|
+
const token = this.configuration.accessToken;
|
|
98
|
+
const tokenString = yield token("bearerAuth", []);
|
|
99
|
+
if (tokenString) {
|
|
100
|
+
headerParameters["Authorization"] = `Bearer ${tokenString}`;
|
|
101
|
+
}
|
|
102
|
+
}
|
|
103
|
+
let urlPath = `/v1/offerings/{offering_id}`;
|
|
104
|
+
urlPath = urlPath.replace('{offering_id}', encodeURIComponent(String(requestParameters['offeringId'])));
|
|
105
|
+
return {
|
|
106
|
+
path: urlPath,
|
|
107
|
+
method: 'GET',
|
|
108
|
+
headers: headerParameters,
|
|
109
|
+
query: queryParameters,
|
|
110
|
+
};
|
|
111
|
+
});
|
|
112
|
+
}
|
|
113
|
+
/**
|
|
114
|
+
* One Form D private offering by its id (the Form D file number, e.g. `021-528681`), with the latest filing\'s facts and the held filing history; an unknown id answers 404. Form D is research data, not limited to listed companies: `company=` answers any Form D issuer CIK (funds, private companies; a ticker resolves only for a listed company), and the list is not gated by the coverage of the financial families.
|
|
115
|
+
* Get a Form D private offering
|
|
116
|
+
*/
|
|
117
|
+
getOfferingRaw(requestParameters, initOverrides) {
|
|
118
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
119
|
+
const requestOptions = yield this.getOfferingRequestOpts(requestParameters);
|
|
120
|
+
const response = yield this.request(requestOptions, initOverrides);
|
|
121
|
+
return new runtime.JSONApiResponse(response, (jsonValue) => OfferingFromJSON(jsonValue));
|
|
122
|
+
});
|
|
123
|
+
}
|
|
124
|
+
/**
|
|
125
|
+
* One Form D private offering by its id (the Form D file number, e.g. `021-528681`), with the latest filing\'s facts and the held filing history; an unknown id answers 404. Form D is research data, not limited to listed companies: `company=` answers any Form D issuer CIK (funds, private companies; a ticker resolves only for a listed company), and the list is not gated by the coverage of the financial families.
|
|
126
|
+
* Get a Form D private offering
|
|
127
|
+
*/
|
|
128
|
+
getOffering(requestParameters, initOverrides) {
|
|
129
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
130
|
+
const response = yield this.getOfferingRaw(requestParameters, initOverrides);
|
|
131
|
+
return yield response.value();
|
|
132
|
+
});
|
|
133
|
+
}
|
|
81
134
|
/**
|
|
82
135
|
* Creates request options for listIpos without sending the request
|
|
83
136
|
*/
|
|
@@ -155,6 +208,83 @@ export class IPOsApi extends runtime.BaseAPI {
|
|
|
155
208
|
return yield response.value();
|
|
156
209
|
});
|
|
157
210
|
}
|
|
211
|
+
/**
|
|
212
|
+
* Creates request options for listOfferings without sending the request
|
|
213
|
+
*/
|
|
214
|
+
listOfferingsRequestOpts(requestParameters) {
|
|
215
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
216
|
+
const queryParameters = {};
|
|
217
|
+
if (requestParameters['company'] != null) {
|
|
218
|
+
queryParameters['company'] = requestParameters['company'];
|
|
219
|
+
}
|
|
220
|
+
if (requestParameters['filedAtGte'] != null) {
|
|
221
|
+
queryParameters['filed_at.gte'] = requestParameters['filedAtGte'].toISOString().substring(0, 10);
|
|
222
|
+
}
|
|
223
|
+
if (requestParameters['filedAtLte'] != null) {
|
|
224
|
+
queryParameters['filed_at.lte'] = requestParameters['filedAtLte'].toISOString().substring(0, 10);
|
|
225
|
+
}
|
|
226
|
+
if (requestParameters['exemption'] != null) {
|
|
227
|
+
queryParameters['exemption'] = requestParameters['exemption'];
|
|
228
|
+
}
|
|
229
|
+
if (requestParameters['industry'] != null) {
|
|
230
|
+
queryParameters['industry'] = requestParameters['industry'];
|
|
231
|
+
}
|
|
232
|
+
if (requestParameters['totalSoldGte'] != null) {
|
|
233
|
+
queryParameters['total_sold.gte'] = requestParameters['totalSoldGte'];
|
|
234
|
+
}
|
|
235
|
+
if (requestParameters['isAmendment'] != null) {
|
|
236
|
+
queryParameters['is_amendment'] = requestParameters['isAmendment'];
|
|
237
|
+
}
|
|
238
|
+
if (requestParameters['sort'] != null) {
|
|
239
|
+
queryParameters['sort'] = requestParameters['sort'];
|
|
240
|
+
}
|
|
241
|
+
if (requestParameters['fields'] != null) {
|
|
242
|
+
queryParameters['fields'] = requestParameters['fields'];
|
|
243
|
+
}
|
|
244
|
+
if (requestParameters['limit'] != null) {
|
|
245
|
+
queryParameters['limit'] = requestParameters['limit'];
|
|
246
|
+
}
|
|
247
|
+
if (requestParameters['cursor'] != null) {
|
|
248
|
+
queryParameters['cursor'] = requestParameters['cursor'];
|
|
249
|
+
}
|
|
250
|
+
const headerParameters = {};
|
|
251
|
+
if (this.configuration && this.configuration.accessToken) {
|
|
252
|
+
const token = this.configuration.accessToken;
|
|
253
|
+
const tokenString = yield token("bearerAuth", []);
|
|
254
|
+
if (tokenString) {
|
|
255
|
+
headerParameters["Authorization"] = `Bearer ${tokenString}`;
|
|
256
|
+
}
|
|
257
|
+
}
|
|
258
|
+
let urlPath = `/v1/offerings`;
|
|
259
|
+
return {
|
|
260
|
+
path: urlPath,
|
|
261
|
+
method: 'GET',
|
|
262
|
+
headers: headerParameters,
|
|
263
|
+
query: queryParameters,
|
|
264
|
+
};
|
|
265
|
+
});
|
|
266
|
+
}
|
|
267
|
+
/**
|
|
268
|
+
* Form D private offerings (Regulation D and Section 4(a)(5) exempt offerings) from the SEC\'s quarterly Form D data sets, five years held: one row per offering (SEC\'s Form D file number; every amendment folds into it) with the latest filing\'s facts — issuer and co-issuers, exemptions as filed, industry group, security types, offering / sold / remaining amounts (USD), investors, related persons — and the held filing history. Filters: `company=` (one issuer CIK or listed ticker), `filed_at.gte|lte` (latest filing date), `exemption=`, `industry=`, `total_sold.gte`, `is_amendment`. Order: latest filing date descending, then offering id. An issuer CIK the SEC registry and the data set do not know answers 404; a known issuer without offerings an empty page. Form D is research data, not limited to listed companies: `company=` answers any Form D issuer CIK (funds, private companies; a ticker resolves only for a listed company), and the list is not gated by the coverage of the financial families.
|
|
269
|
+
* List Form D private offerings
|
|
270
|
+
*/
|
|
271
|
+
listOfferingsRaw(requestParameters, initOverrides) {
|
|
272
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
273
|
+
const requestOptions = yield this.listOfferingsRequestOpts(requestParameters);
|
|
274
|
+
const response = yield this.request(requestOptions, initOverrides);
|
|
275
|
+
return new runtime.JSONApiResponse(response, (jsonValue) => ListOfferings200ResponseFromJSON(jsonValue));
|
|
276
|
+
});
|
|
277
|
+
}
|
|
278
|
+
/**
|
|
279
|
+
* Form D private offerings (Regulation D and Section 4(a)(5) exempt offerings) from the SEC\'s quarterly Form D data sets, five years held: one row per offering (SEC\'s Form D file number; every amendment folds into it) with the latest filing\'s facts — issuer and co-issuers, exemptions as filed, industry group, security types, offering / sold / remaining amounts (USD), investors, related persons — and the held filing history. Filters: `company=` (one issuer CIK or listed ticker), `filed_at.gte|lte` (latest filing date), `exemption=`, `industry=`, `total_sold.gte`, `is_amendment`. Order: latest filing date descending, then offering id. An issuer CIK the SEC registry and the data set do not know answers 404; a known issuer without offerings an empty page. Form D is research data, not limited to listed companies: `company=` answers any Form D issuer CIK (funds, private companies; a ticker resolves only for a listed company), and the list is not gated by the coverage of the financial families.
|
|
280
|
+
* List Form D private offerings
|
|
281
|
+
*/
|
|
282
|
+
listOfferings() {
|
|
283
|
+
return __awaiter(this, arguments, void 0, function* (requestParameters = {}, initOverrides) {
|
|
284
|
+
const response = yield this.listOfferingsRaw(requestParameters, initOverrides);
|
|
285
|
+
return yield response.value();
|
|
286
|
+
});
|
|
287
|
+
}
|
|
158
288
|
}
|
|
159
289
|
/**
|
|
160
290
|
* @export
|
|
@@ -165,3 +295,9 @@ export const ListIposSortEnum = {
|
|
|
165
295
|
FirstPublicAt: 'first_public_at',
|
|
166
296
|
FirstPublicAt2: '-first_public_at'
|
|
167
297
|
};
|
|
298
|
+
/**
|
|
299
|
+
* @export
|
|
300
|
+
*/
|
|
301
|
+
export const ListOfferingsSortEnum = {
|
|
302
|
+
FiledLatest: '-filed_latest'
|
|
303
|
+
};
|
|
@@ -23,6 +23,9 @@ export interface ListInsiderTradesRequest {
|
|
|
23
23
|
filedAtGt?: Date;
|
|
24
24
|
filedAtLte?: Date;
|
|
25
25
|
filedAtLt?: Date;
|
|
26
|
+
transactionDateGte?: Date;
|
|
27
|
+
transactionDateLte?: Date;
|
|
28
|
+
isDerivative?: boolean;
|
|
26
29
|
sort?: ListInsiderTradesSortEnum;
|
|
27
30
|
fields?: string;
|
|
28
31
|
limit?: number;
|
|
@@ -105,6 +105,15 @@ export class InsiderTradesApi extends runtime.BaseAPI {
|
|
|
105
105
|
if (requestParameters['filedAtLt'] != null) {
|
|
106
106
|
queryParameters['filed_at.lt'] = requestParameters['filedAtLt'].toISOString().substring(0, 10);
|
|
107
107
|
}
|
|
108
|
+
if (requestParameters['transactionDateGte'] != null) {
|
|
109
|
+
queryParameters['transaction_date.gte'] = requestParameters['transactionDateGte'].toISOString().substring(0, 10);
|
|
110
|
+
}
|
|
111
|
+
if (requestParameters['transactionDateLte'] != null) {
|
|
112
|
+
queryParameters['transaction_date.lte'] = requestParameters['transactionDateLte'].toISOString().substring(0, 10);
|
|
113
|
+
}
|
|
114
|
+
if (requestParameters['isDerivative'] != null) {
|
|
115
|
+
queryParameters['is_derivative'] = requestParameters['isDerivative'];
|
|
116
|
+
}
|
|
108
117
|
if (requestParameters['sort'] != null) {
|
|
109
118
|
queryParameters['sort'] = requestParameters['sort'];
|
|
110
119
|
}
|
|
@@ -119,7 +119,7 @@ export interface Company {
|
|
|
119
119
|
*/
|
|
120
120
|
employees: number | null;
|
|
121
121
|
/**
|
|
122
|
-
* Market capitalization;
|
|
122
|
+
* Market capitalization; for an ETF: fund net assets from its latest public N-PORT report (single-class funds only), else null
|
|
123
123
|
* @type {number}
|
|
124
124
|
* @memberof Company
|
|
125
125
|
*/
|
|
@@ -64,6 +64,12 @@ export interface Filer {
|
|
|
64
64
|
* @memberof Filer
|
|
65
65
|
*/
|
|
66
66
|
listing: FilerListing | null;
|
|
67
|
+
/**
|
|
68
|
+
* Number of Form D private offerings naming the filer (`phase=pre_ipo` lists); null on other lists and while Form D data is not served (optional: answers captured before release 5.7 lack it)
|
|
69
|
+
* @type {number}
|
|
70
|
+
* @memberof Filer
|
|
71
|
+
*/
|
|
72
|
+
private_offerings_count?: number | null;
|
|
67
73
|
}
|
|
68
74
|
/**
|
|
69
75
|
* @export
|
package/dist/esm/models/Filer.js
CHANGED
|
@@ -60,6 +60,7 @@ export function FilerFromJSONTyped(json, ignoreDiscriminator) {
|
|
|
60
60
|
'forms': json['forms'],
|
|
61
61
|
'stated_tickers': json['stated_tickers'],
|
|
62
62
|
'listing': FilerListingFromJSON(json['listing']),
|
|
63
|
+
'private_offerings_count': json['private_offerings_count'] == null ? undefined : json['private_offerings_count'],
|
|
63
64
|
};
|
|
64
65
|
}
|
|
65
66
|
export function FilerToJSON(json) {
|
|
@@ -78,5 +79,6 @@ export function FilerToJSONTyped(value, ignoreDiscriminator = false) {
|
|
|
78
79
|
'forms': value['forms'],
|
|
79
80
|
'stated_tickers': value['stated_tickers'],
|
|
80
81
|
'listing': FilerListingToJSON(value['listing']),
|
|
82
|
+
'private_offerings_count': value['private_offerings_count'],
|
|
81
83
|
};
|
|
82
84
|
}
|
|
@@ -13,6 +13,8 @@ import type { FilerDetailSuccessorsInner } from './FilerDetailSuccessorsInner';
|
|
|
13
13
|
import type { ProposedTicker } from './ProposedTicker';
|
|
14
14
|
import type { FilerDetailFormerNamesInner } from './FilerDetailFormerNamesInner';
|
|
15
15
|
import type { FilerListing } from './FilerListing';
|
|
16
|
+
import type { FilerPrivateOfferings } from './FilerPrivateOfferings';
|
|
17
|
+
import type { FilerFund } from './FilerFund';
|
|
16
18
|
/**
|
|
17
19
|
* One SEC filer's registry identity
|
|
18
20
|
* @export
|
|
@@ -93,6 +95,18 @@ export interface FilerDetail {
|
|
|
93
95
|
* @memberof FilerDetail
|
|
94
96
|
*/
|
|
95
97
|
successors?: Array<FilerDetailSuccessorsInner> | null;
|
|
98
|
+
/**
|
|
99
|
+
* With `expand=fund`: the registered investment company's fund series (SEC N-CEN census, risk/return prospectus data, N-PORT net assets); null for a filer without fund series and while fund data is not served
|
|
100
|
+
* @type {FilerFund}
|
|
101
|
+
* @memberof FilerDetail
|
|
102
|
+
*/
|
|
103
|
+
fund?: FilerFund | null;
|
|
104
|
+
/**
|
|
105
|
+
* With `expand=private_offerings`: summary of the filer's Form D private offerings (GET /v1/offerings?company=); null for a filer without Form D offerings and while Form D data is not served. Only for filers the SEC registry knows
|
|
106
|
+
* @type {FilerPrivateOfferings}
|
|
107
|
+
* @memberof FilerDetail
|
|
108
|
+
*/
|
|
109
|
+
private_offerings?: FilerPrivateOfferings | null;
|
|
96
110
|
}
|
|
97
111
|
/**
|
|
98
112
|
* @export
|
|
@@ -15,6 +15,8 @@ import { FilerDetailSuccessorsInnerFromJSON, FilerDetailSuccessorsInnerToJSON, }
|
|
|
15
15
|
import { ProposedTickerFromJSON, ProposedTickerToJSON, } from './ProposedTicker';
|
|
16
16
|
import { FilerDetailFormerNamesInnerFromJSON, FilerDetailFormerNamesInnerToJSON, } from './FilerDetailFormerNamesInner';
|
|
17
17
|
import { FilerListingFromJSON, FilerListingToJSON, } from './FilerListing';
|
|
18
|
+
import { FilerPrivateOfferingsFromJSON, FilerPrivateOfferingsToJSON, } from './FilerPrivateOfferings';
|
|
19
|
+
import { FilerFundFromJSON, FilerFundToJSON, } from './FilerFund';
|
|
18
20
|
/**
|
|
19
21
|
* @export
|
|
20
22
|
*/
|
|
@@ -67,6 +69,8 @@ export function FilerDetailFromJSONTyped(json, ignoreDiscriminator) {
|
|
|
67
69
|
'proposed_symbols': json['proposed_symbols'] == null ? undefined : (json['proposed_symbols'].map(ProposedTickerFromJSON)),
|
|
68
70
|
'former_names': json['former_names'] == null ? undefined : (json['former_names'].map(FilerDetailFormerNamesInnerFromJSON)),
|
|
69
71
|
'successors': json['successors'] == null ? undefined : (json['successors'].map(FilerDetailSuccessorsInnerFromJSON)),
|
|
72
|
+
'fund': json['fund'] == null ? undefined : FilerFundFromJSON(json['fund']),
|
|
73
|
+
'private_offerings': json['private_offerings'] == null ? undefined : FilerPrivateOfferingsFromJSON(json['private_offerings']),
|
|
70
74
|
};
|
|
71
75
|
}
|
|
72
76
|
export function FilerDetailToJSON(json) {
|
|
@@ -89,5 +93,7 @@ export function FilerDetailToJSONTyped(value, ignoreDiscriminator = false) {
|
|
|
89
93
|
'proposed_symbols': value['proposed_symbols'] == null ? undefined : (value['proposed_symbols'].map(ProposedTickerToJSON)),
|
|
90
94
|
'former_names': value['former_names'] == null ? undefined : (value['former_names'].map(FilerDetailFormerNamesInnerToJSON)),
|
|
91
95
|
'successors': value['successors'] == null ? undefined : (value['successors'].map(FilerDetailSuccessorsInnerToJSON)),
|
|
96
|
+
'fund': FilerFundToJSON(value['fund']),
|
|
97
|
+
'private_offerings': FilerPrivateOfferingsToJSON(value['private_offerings']),
|
|
92
98
|
};
|
|
93
99
|
}
|
|
@@ -0,0 +1,45 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Invinite API
|
|
3
|
+
* Invinite financial data API. Each operation has a base credit cost: `x-credits` is the base cost; responses add 1 credit per started 1,000 rows beyond the first 1,000; `X-Credits-Charged` reports the final debit and `X-Credits-Remaining` what is left of the plan\'s included credits after it. A `304 Not Modified` costs nothing. `GET /v1/me/usage` returns your account\'s usage by day, product family and key (it costs no credits). **Coverage.** Financial data covers US SEC registrants and their US listings; a symbol that is not a US SEC registrant (or a crypto pair such as `X:BTCUSD`) is not a known company and answers 404. A known company with no data in a family (for example no statements yet) answers 404 with `code: not_covered`; an empty page of a covered company stays 200 with an empty list. `GET /v1/companies` lists every known company. ## Webhooks Accounts on LITE and above subscribe with `POST /v1/webhooks` to the `event.*` lifecycle events (filtered by company) and, on STANDARD and above, to `news.published` (one delivery per new news item, filtered by the companies it mentions); see `x-webhooks` for each `data` object. What a subscription may hold depends on the plan (a create / update beyond it is refused with the plan\'s limit; `event.test` needs no subscription — the test route and the disabled notice send it to any subscription): | Plan | Webhooks | Events | CIKs per webhook | Keywords per webhook | |---|---|---|---|---| | FREE | 0 | — | — | — | | LITE | 5 | `.scheduled`, `.rescheduled`, `.started`, `.ended`, `.transcript_ready`, `.assets_ready` | ≤ 10 | — | | STANDARD | 15 | LITE + `.transcript_provisional`, `.transcript_corrected`, `.documents_updated`, `news.published` | ≤ 25 | — | | PRO / ENTERPRISE | 50 | STANDARD + `.guidance_flash`, `.keyword_hit` | ≤ 100 | ≤ 20 (on ≤ 10 webhooks) | Every delivery is a `POST` with `Content-Type: application/json`, `X-Invinite-Event`, `X-Invinite-Delivery` and `X-Invinite-Signature: t=<unix seconds>,v1=<hex>` where `v1` = HMAC-SHA256(secret, `<t>.<raw body>`); during a secret rotation the header carries one `v1` per valid secret. Reject a signature older than 5 minutes. Any 2xx within 10 s acknowledges; redirects are not followed. A failed delivery is retried after 1 min, 5 min, 30 min, 2 h, 6 h, 12 h, 24 h (8 attempts in all, the same delivery id each time). A subscription is disabled after 8 consecutive dead-lettered deliveries (a final `event.test` with `notice: subscription_disabled` is sent). Deliveries are at-least-once and unordered: dedupe on the delivery id, order by `created_at`. ## Licensing | Tier | display | redistribute | rag | train | audio | resell | | --- | --- | --- | --- | --- | --- | --- | | FREE | ✓ | – | – | – | – | – | | LITE | ✓ | – | – | – | – | – | | STANDARD | ✓ | – | ✓ | – | – | – | | PRO | ✓ | ✓ | ✓ | – | ✓ | – | Invinite data may be shown and, from PRO, redistributed inside the licensee\'s own product with attribution (\"Source: Invinite\" on screen or in the API response that carries it). It may never be resold, relicensed, white-labelled or offered as a data feed as the licensee\'s own data, at any tier, under any contract. Policy version: 2026-10-draft. Draft — pending counsel sign-off. Audio files carry a forensic watermark that identifies the recording. Audio is subject to per-company takedown and may not be re-hosted. SEC data: Figures and filings originate from SEC EDGAR; the standardisation, mapping and derived metrics are Invinite\'s. News: News text is Invinite\'s own summary of the issuer\'s or the SEC\'s publication (the publisher\'s text and media are never served); the licensee shows the attribution (publisher, source URL and date) next to it; the resale rule applies. PDF documents: Branded PDFs of transcripts and news items are permanent URLs to one shared file per version. They may be shown, downloaded and forwarded unmodified with the notice page intact; the resale rule applies unchanged. News PDFs carry Invinite\'s summary of the issuer\'s or the SEC\'s publication under the attribution stated on their notice page; a PDF disappears when the item is taken down or its source\'s reuse is denied. Every `/v1/_*` data operation carries `x-license`, the minimum use right its data ships with; `GET /status/licensing` serves the same matrix per route, rendered at [data.invinite.com/docs/licensing](https://data.invinite.com/docs/licensing). `/v1/me` and `/v1/me/usage` serve no licensed data and carry none. ## Status [`/status`](/status) reports whether each product family works (a status and its uptime over 7, 30 and 90 days); [`/status/licensing`](/status/licensing) serves the licensing matrix per route. The status routes need no API key and are cached for 5 minutes. The public status page is [status.data.invinite.com](https://status.data.invinite.com): a snapshot of `/status` every 15 minutes plus an external reachability probe of the API. Uptime is the share of requests answered without a server error, measured by the API per product family; a window with too little traffic to judge shows no figure. Status reflects the last 24 hours. Product families: Company, Financials, SEC Filings, Insider Trades, Institutional Ownership, IPOs, Market, Metadata, Earnings Calls, News, WebSocket, Account.
|
|
4
|
+
*
|
|
5
|
+
* The version of the OpenAPI document: 2026-11-13
|
|
6
|
+
*
|
|
7
|
+
*
|
|
8
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
9
|
+
* https://openapi-generator.tech
|
|
10
|
+
* Do not edit the class manually.
|
|
11
|
+
*/
|
|
12
|
+
import type { FilerFundSeries } from './FilerFundSeries';
|
|
13
|
+
/**
|
|
14
|
+
* A registered investment company's fund series (SEC N-CEN, risk/return prospectus data, N-PORT)
|
|
15
|
+
* @export
|
|
16
|
+
* @interface FilerFund
|
|
17
|
+
*/
|
|
18
|
+
export interface FilerFund {
|
|
19
|
+
/**
|
|
20
|
+
* Registration form of the investment company: N-1A (open-end fund, ETF) or N-2 (closed-end fund); null when mixed or unknown
|
|
21
|
+
* @type {string}
|
|
22
|
+
* @memberof FilerFund
|
|
23
|
+
*/
|
|
24
|
+
investment_company_type: string | null;
|
|
25
|
+
/**
|
|
26
|
+
* Number of fund series
|
|
27
|
+
* @type {number}
|
|
28
|
+
* @memberof FilerFund
|
|
29
|
+
*/
|
|
30
|
+
series_count: number;
|
|
31
|
+
/**
|
|
32
|
+
* The fund series
|
|
33
|
+
* @type {Array<FilerFundSeries>}
|
|
34
|
+
* @memberof FilerFund
|
|
35
|
+
*/
|
|
36
|
+
series: Array<FilerFundSeries>;
|
|
37
|
+
}
|
|
38
|
+
/**
|
|
39
|
+
* Check if a given object implements the FilerFund interface.
|
|
40
|
+
*/
|
|
41
|
+
export declare function instanceOfFilerFund(value: object): value is FilerFund;
|
|
42
|
+
export declare function FilerFundFromJSON(json: any): FilerFund;
|
|
43
|
+
export declare function FilerFundFromJSONTyped(json: any, ignoreDiscriminator: boolean): FilerFund;
|
|
44
|
+
export declare function FilerFundToJSON(json: any): FilerFund;
|
|
45
|
+
export declare function FilerFundToJSONTyped(value?: FilerFund | null, ignoreDiscriminator?: boolean): any;
|
|
@@ -0,0 +1,52 @@
|
|
|
1
|
+
/* tslint:disable */
|
|
2
|
+
/* eslint-disable */
|
|
3
|
+
/**
|
|
4
|
+
* Invinite API
|
|
5
|
+
* Invinite financial data API. Each operation has a base credit cost: `x-credits` is the base cost; responses add 1 credit per started 1,000 rows beyond the first 1,000; `X-Credits-Charged` reports the final debit and `X-Credits-Remaining` what is left of the plan\'s included credits after it. A `304 Not Modified` costs nothing. `GET /v1/me/usage` returns your account\'s usage by day, product family and key (it costs no credits). **Coverage.** Financial data covers US SEC registrants and their US listings; a symbol that is not a US SEC registrant (or a crypto pair such as `X:BTCUSD`) is not a known company and answers 404. A known company with no data in a family (for example no statements yet) answers 404 with `code: not_covered`; an empty page of a covered company stays 200 with an empty list. `GET /v1/companies` lists every known company. ## Webhooks Accounts on LITE and above subscribe with `POST /v1/webhooks` to the `event.*` lifecycle events (filtered by company) and, on STANDARD and above, to `news.published` (one delivery per new news item, filtered by the companies it mentions); see `x-webhooks` for each `data` object. What a subscription may hold depends on the plan (a create / update beyond it is refused with the plan\'s limit; `event.test` needs no subscription — the test route and the disabled notice send it to any subscription): | Plan | Webhooks | Events | CIKs per webhook | Keywords per webhook | |---|---|---|---|---| | FREE | 0 | — | — | — | | LITE | 5 | `.scheduled`, `.rescheduled`, `.started`, `.ended`, `.transcript_ready`, `.assets_ready` | ≤ 10 | — | | STANDARD | 15 | LITE + `.transcript_provisional`, `.transcript_corrected`, `.documents_updated`, `news.published` | ≤ 25 | — | | PRO / ENTERPRISE | 50 | STANDARD + `.guidance_flash`, `.keyword_hit` | ≤ 100 | ≤ 20 (on ≤ 10 webhooks) | Every delivery is a `POST` with `Content-Type: application/json`, `X-Invinite-Event`, `X-Invinite-Delivery` and `X-Invinite-Signature: t=<unix seconds>,v1=<hex>` where `v1` = HMAC-SHA256(secret, `<t>.<raw body>`); during a secret rotation the header carries one `v1` per valid secret. Reject a signature older than 5 minutes. Any 2xx within 10 s acknowledges; redirects are not followed. A failed delivery is retried after 1 min, 5 min, 30 min, 2 h, 6 h, 12 h, 24 h (8 attempts in all, the same delivery id each time). A subscription is disabled after 8 consecutive dead-lettered deliveries (a final `event.test` with `notice: subscription_disabled` is sent). Deliveries are at-least-once and unordered: dedupe on the delivery id, order by `created_at`. ## Licensing | Tier | display | redistribute | rag | train | audio | resell | | --- | --- | --- | --- | --- | --- | --- | | FREE | ✓ | – | – | – | – | – | | LITE | ✓ | – | – | – | – | – | | STANDARD | ✓ | – | ✓ | – | – | – | | PRO | ✓ | ✓ | ✓ | – | ✓ | – | Invinite data may be shown and, from PRO, redistributed inside the licensee\'s own product with attribution (\"Source: Invinite\" on screen or in the API response that carries it). It may never be resold, relicensed, white-labelled or offered as a data feed as the licensee\'s own data, at any tier, under any contract. Policy version: 2026-10-draft. Draft — pending counsel sign-off. Audio files carry a forensic watermark that identifies the recording. Audio is subject to per-company takedown and may not be re-hosted. SEC data: Figures and filings originate from SEC EDGAR; the standardisation, mapping and derived metrics are Invinite\'s. News: News text is Invinite\'s own summary of the issuer\'s or the SEC\'s publication (the publisher\'s text and media are never served); the licensee shows the attribution (publisher, source URL and date) next to it; the resale rule applies. PDF documents: Branded PDFs of transcripts and news items are permanent URLs to one shared file per version. They may be shown, downloaded and forwarded unmodified with the notice page intact; the resale rule applies unchanged. News PDFs carry Invinite\'s summary of the issuer\'s or the SEC\'s publication under the attribution stated on their notice page; a PDF disappears when the item is taken down or its source\'s reuse is denied. Every `/v1/_*` data operation carries `x-license`, the minimum use right its data ships with; `GET /status/licensing` serves the same matrix per route, rendered at [data.invinite.com/docs/licensing](https://data.invinite.com/docs/licensing). `/v1/me` and `/v1/me/usage` serve no licensed data and carry none. ## Status [`/status`](/status) reports whether each product family works (a status and its uptime over 7, 30 and 90 days); [`/status/licensing`](/status/licensing) serves the licensing matrix per route. The status routes need no API key and are cached for 5 minutes. The public status page is [status.data.invinite.com](https://status.data.invinite.com): a snapshot of `/status` every 15 minutes plus an external reachability probe of the API. Uptime is the share of requests answered without a server error, measured by the API per product family; a window with too little traffic to judge shows no figure. Status reflects the last 24 hours. Product families: Company, Financials, SEC Filings, Insider Trades, Institutional Ownership, IPOs, Market, Metadata, Earnings Calls, News, WebSocket, Account.
|
|
6
|
+
*
|
|
7
|
+
* The version of the OpenAPI document: 2026-11-13
|
|
8
|
+
*
|
|
9
|
+
*
|
|
10
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
11
|
+
* https://openapi-generator.tech
|
|
12
|
+
* Do not edit the class manually.
|
|
13
|
+
*/
|
|
14
|
+
import { FilerFundSeriesFromJSON, FilerFundSeriesToJSON, } from './FilerFundSeries';
|
|
15
|
+
/**
|
|
16
|
+
* Check if a given object implements the FilerFund interface.
|
|
17
|
+
*/
|
|
18
|
+
export function instanceOfFilerFund(value) {
|
|
19
|
+
if (!('investment_company_type' in value) || value['investment_company_type'] === undefined)
|
|
20
|
+
return false;
|
|
21
|
+
if (!('series_count' in value) || value['series_count'] === undefined)
|
|
22
|
+
return false;
|
|
23
|
+
if (!('series' in value) || value['series'] === undefined)
|
|
24
|
+
return false;
|
|
25
|
+
return true;
|
|
26
|
+
}
|
|
27
|
+
export function FilerFundFromJSON(json) {
|
|
28
|
+
return FilerFundFromJSONTyped(json, false);
|
|
29
|
+
}
|
|
30
|
+
export function FilerFundFromJSONTyped(json, ignoreDiscriminator) {
|
|
31
|
+
if (json == null) {
|
|
32
|
+
return json;
|
|
33
|
+
}
|
|
34
|
+
return {
|
|
35
|
+
'investment_company_type': json['investment_company_type'],
|
|
36
|
+
'series_count': json['series_count'],
|
|
37
|
+
'series': (json['series'].map(FilerFundSeriesFromJSON)),
|
|
38
|
+
};
|
|
39
|
+
}
|
|
40
|
+
export function FilerFundToJSON(json) {
|
|
41
|
+
return FilerFundToJSONTyped(json, false);
|
|
42
|
+
}
|
|
43
|
+
export function FilerFundToJSONTyped(value, ignoreDiscriminator = false) {
|
|
44
|
+
if (value == null) {
|
|
45
|
+
return value;
|
|
46
|
+
}
|
|
47
|
+
return {
|
|
48
|
+
'investment_company_type': value['investment_company_type'],
|
|
49
|
+
'series_count': value['series_count'],
|
|
50
|
+
'series': (value['series'].map(FilerFundSeriesToJSON)),
|
|
51
|
+
};
|
|
52
|
+
}
|