@invinite-org/data-api-client 0.0.0-stage → 0.1.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 +499 -0
- package/.openapi-generator/VERSION +1 -0
- package/.openapi-generator-ignore +23 -0
- package/README.md +113 -2
- package/dist/apis/AccountApi.d.ts +44 -0
- package/dist/apis/AccountApi.js +88 -0
- package/dist/apis/AsReportedBalanceSheetApi.d.ts +146 -0
- package/dist/apis/AsReportedBalanceSheetApi.js +288 -0
- package/dist/apis/AsReportedCashFlowStatementApi.d.ts +146 -0
- package/dist/apis/AsReportedCashFlowStatementApi.js +288 -0
- package/dist/apis/AsReportedIncomeStatementApi.d.ts +146 -0
- package/dist/apis/AsReportedIncomeStatementApi.js +288 -0
- package/dist/apis/AsReportedSnapshotApi.d.ts +119 -0
- package/dist/apis/AsReportedSnapshotApi.js +258 -0
- package/dist/apis/CompanyApi.d.ts +159 -0
- package/dist/apis/CompanyApi.js +392 -0
- package/dist/apis/EarningsCallsApi.d.ts +1079 -0
- package/dist/apis/EarningsCallsApi.js +2368 -0
- package/dist/apis/FinancialMetricsApi.d.ts +154 -0
- package/dist/apis/FinancialMetricsApi.js +294 -0
- package/dist/apis/HealthApi.d.ts +32 -0
- package/dist/apis/HealthApi.js +70 -0
- package/dist/apis/IPOsApi.d.ts +47 -0
- package/dist/apis/IPOsApi.js +99 -0
- package/dist/apis/InsiderTradesApi.d.ts +57 -0
- package/dist/apis/InsiderTradesApi.js +115 -0
- package/dist/apis/InstitutionalOwnershipApi.d.ts +150 -0
- package/dist/apis/InstitutionalOwnershipApi.js +324 -0
- package/dist/apis/MarketApi.d.ts +45 -0
- package/dist/apis/MarketApi.js +93 -0
- package/dist/apis/MetadataApi.d.ts +47 -0
- package/dist/apis/MetadataApi.js +122 -0
- package/dist/apis/SECFilingsApi.d.ts +117 -0
- package/dist/apis/SECFilingsApi.js +284 -0
- package/dist/apis/SegmentedFinancialsApi.d.ts +125 -0
- package/dist/apis/SegmentedFinancialsApi.js +226 -0
- package/dist/apis/StandardizedBalanceSheetApi.d.ts +146 -0
- package/dist/apis/StandardizedBalanceSheetApi.js +288 -0
- package/dist/apis/StandardizedCashFlowStatementApi.d.ts +146 -0
- package/dist/apis/StandardizedCashFlowStatementApi.js +288 -0
- package/dist/apis/StandardizedIncomeStatementApi.d.ts +146 -0
- package/dist/apis/StandardizedIncomeStatementApi.js +288 -0
- package/dist/apis/StandardizedSnapshotApi.d.ts +119 -0
- package/dist/apis/StandardizedSnapshotApi.js +258 -0
- package/dist/apis/StatusApi.d.ts +47 -0
- package/dist/apis/StatusApi.js +108 -0
- package/dist/apis/index.d.ts +21 -0
- package/dist/apis/index.js +39 -0
- package/dist/esm/apis/AccountApi.d.ts +44 -0
- package/dist/esm/apis/AccountApi.js +84 -0
- package/dist/esm/apis/AsReportedBalanceSheetApi.d.ts +146 -0
- package/dist/esm/apis/AsReportedBalanceSheetApi.js +284 -0
- package/dist/esm/apis/AsReportedCashFlowStatementApi.d.ts +146 -0
- package/dist/esm/apis/AsReportedCashFlowStatementApi.js +284 -0
- package/dist/esm/apis/AsReportedIncomeStatementApi.d.ts +146 -0
- package/dist/esm/apis/AsReportedIncomeStatementApi.js +284 -0
- package/dist/esm/apis/AsReportedSnapshotApi.d.ts +119 -0
- package/dist/esm/apis/AsReportedSnapshotApi.js +254 -0
- package/dist/esm/apis/CompanyApi.d.ts +159 -0
- package/dist/esm/apis/CompanyApi.js +388 -0
- package/dist/esm/apis/EarningsCallsApi.d.ts +1079 -0
- package/dist/esm/apis/EarningsCallsApi.js +2364 -0
- package/dist/esm/apis/FinancialMetricsApi.d.ts +154 -0
- package/dist/esm/apis/FinancialMetricsApi.js +290 -0
- package/dist/esm/apis/HealthApi.d.ts +32 -0
- package/dist/esm/apis/HealthApi.js +66 -0
- package/dist/esm/apis/IPOsApi.d.ts +47 -0
- package/dist/esm/apis/IPOsApi.js +95 -0
- package/dist/esm/apis/InsiderTradesApi.d.ts +57 -0
- package/dist/esm/apis/InsiderTradesApi.js +111 -0
- package/dist/esm/apis/InstitutionalOwnershipApi.d.ts +150 -0
- package/dist/esm/apis/InstitutionalOwnershipApi.js +320 -0
- package/dist/esm/apis/MarketApi.d.ts +45 -0
- package/dist/esm/apis/MarketApi.js +89 -0
- package/dist/esm/apis/MetadataApi.d.ts +47 -0
- package/dist/esm/apis/MetadataApi.js +118 -0
- package/dist/esm/apis/SECFilingsApi.d.ts +117 -0
- package/dist/esm/apis/SECFilingsApi.js +280 -0
- package/dist/esm/apis/SegmentedFinancialsApi.d.ts +125 -0
- package/dist/esm/apis/SegmentedFinancialsApi.js +222 -0
- package/dist/esm/apis/StandardizedBalanceSheetApi.d.ts +146 -0
- package/dist/esm/apis/StandardizedBalanceSheetApi.js +284 -0
- package/dist/esm/apis/StandardizedCashFlowStatementApi.d.ts +146 -0
- package/dist/esm/apis/StandardizedCashFlowStatementApi.js +284 -0
- package/dist/esm/apis/StandardizedIncomeStatementApi.d.ts +146 -0
- package/dist/esm/apis/StandardizedIncomeStatementApi.js +284 -0
- package/dist/esm/apis/StandardizedSnapshotApi.d.ts +119 -0
- package/dist/esm/apis/StandardizedSnapshotApi.js +254 -0
- package/dist/esm/apis/StatusApi.d.ts +47 -0
- package/dist/esm/apis/StatusApi.js +104 -0
- package/dist/esm/apis/index.d.ts +21 -0
- package/dist/esm/apis/index.js +23 -0
- package/dist/esm/index.d.ts +3 -0
- package/dist/esm/index.js +5 -0
- package/dist/esm/models/AccountUsage200Response.d.ts +75 -0
- package/dist/esm/models/AccountUsage200Response.js +75 -0
- package/dist/esm/models/AccountUsage200ResponseByFamilyInner.d.ts +50 -0
- package/dist/esm/models/AccountUsage200ResponseByFamilyInner.js +55 -0
- package/dist/esm/models/AccountUsage200ResponseByKeyInner.d.ts +65 -0
- package/dist/esm/models/AccountUsage200ResponseByKeyInner.js +67 -0
- package/dist/esm/models/AccountUsage200ResponseDailyInner.d.ts +51 -0
- package/dist/esm/models/AccountUsage200ResponseDailyInner.js +56 -0
- package/dist/esm/models/AccountUsage200ResponseDailyInnerErrors.d.ts +56 -0
- package/dist/esm/models/AccountUsage200ResponseDailyInnerErrors.js +59 -0
- package/dist/esm/models/AccountUsage200ResponsePeriod.d.ts +67 -0
- package/dist/esm/models/AccountUsage200ResponsePeriod.js +69 -0
- package/dist/esm/models/AsReportedIncomeStatement200Response.d.ts +33 -0
- package/dist/esm/models/AsReportedIncomeStatement200Response.js +44 -0
- package/dist/esm/models/AsReportedIncomeStatement200ResponseCompaniesInner.d.ts +51 -0
- package/dist/esm/models/AsReportedIncomeStatement200ResponseCompaniesInner.js +54 -0
- package/dist/esm/models/AsReportedIncomeStatement200ResponseCompaniesInnerPeriodsInner.d.ts +70 -0
- package/dist/esm/models/AsReportedIncomeStatement200ResponseCompaniesInnerPeriodsInner.js +67 -0
- package/dist/esm/models/AsReportedIncomeStatementDetailed200Response.d.ts +33 -0
- package/dist/esm/models/AsReportedIncomeStatementDetailed200Response.js +44 -0
- package/dist/esm/models/AsReportedIncomeStatementDetailed200ResponseCompaniesInner.d.ts +51 -0
- package/dist/esm/models/AsReportedIncomeStatementDetailed200ResponseCompaniesInner.js +54 -0
- package/dist/esm/models/AsReportedIncomeStatementDetailed200ResponseCompaniesInnerPeriodsInner.d.ts +71 -0
- package/dist/esm/models/AsReportedIncomeStatementDetailed200ResponseCompaniesInnerPeriodsInner.js +69 -0
- package/dist/esm/models/AsReportedIncomeStatementDetailed200ResponseCompaniesInnerPeriodsInnerFactsValue.d.ts +57 -0
- package/dist/esm/models/AsReportedIncomeStatementDetailed200ResponseCompaniesInnerPeriodsInnerFactsValue.js +50 -0
- package/dist/esm/models/AsReportedIncomeStatementPresentation200Response.d.ts +33 -0
- package/dist/esm/models/AsReportedIncomeStatementPresentation200Response.js +44 -0
- package/dist/esm/models/AsReportedIncomeStatementPresentation200ResponseCompaniesInner.d.ts +51 -0
- package/dist/esm/models/AsReportedIncomeStatementPresentation200ResponseCompaniesInner.js +54 -0
- package/dist/esm/models/AsReportedIncomeStatementPresentation200ResponseCompaniesInnerPeriodsInner.d.ts +69 -0
- package/dist/esm/models/AsReportedIncomeStatementPresentation200ResponseCompaniesInnerPeriodsInner.js +68 -0
- package/dist/esm/models/AsReportedSnapshotDetailed200Response.d.ts +33 -0
- package/dist/esm/models/AsReportedSnapshotDetailed200Response.js +44 -0
- package/dist/esm/models/AsReportedSnapshotDetailed200ResponseCompaniesInner.d.ts +91 -0
- package/dist/esm/models/AsReportedSnapshotDetailed200ResponseCompaniesInner.js +85 -0
- package/dist/esm/models/AsReportedSnapshotDetailed200ResponseCompaniesInnerStatements.d.ts +45 -0
- package/dist/esm/models/AsReportedSnapshotDetailed200ResponseCompaniesInnerStatements.js +52 -0
- package/dist/esm/models/AsReportedSnapshotDetailed200ResponseCompaniesInnerStatementsIncomeStatement.d.ts +35 -0
- package/dist/esm/models/AsReportedSnapshotDetailed200ResponseCompaniesInnerStatementsIncomeStatement.js +43 -0
- package/dist/esm/models/AsReportedSnapshotPresentation200Response.d.ts +33 -0
- package/dist/esm/models/AsReportedSnapshotPresentation200Response.js +44 -0
- package/dist/esm/models/AsReportedSnapshotPresentation200ResponseCompaniesInner.d.ts +91 -0
- package/dist/esm/models/AsReportedSnapshotPresentation200ResponseCompaniesInner.js +85 -0
- package/dist/esm/models/AsReportedSnapshotPresentation200ResponseCompaniesInnerStatements.d.ts +45 -0
- package/dist/esm/models/AsReportedSnapshotPresentation200ResponseCompaniesInnerStatements.js +52 -0
- package/dist/esm/models/AsReportedSnapshotPresentation200ResponseCompaniesInnerStatementsIncomeStatement.d.ts +33 -0
- package/dist/esm/models/AsReportedSnapshotPresentation200ResponseCompaniesInnerStatementsIncomeStatement.js +42 -0
- package/dist/esm/models/BadRequestError.d.ts +38 -0
- package/dist/esm/models/BadRequestError.js +47 -0
- package/dist/esm/models/CompanyAvailableCompanies200Response.d.ts +39 -0
- package/dist/esm/models/CompanyAvailableCompanies200Response.js +48 -0
- package/dist/esm/models/CompanyAvailableCompanies200ResponseCompaniesInner.d.ts +44 -0
- package/dist/esm/models/CompanyAvailableCompanies200ResponseCompaniesInner.js +51 -0
- package/dist/esm/models/CompanyAvailableCompanies401Response.d.ts +38 -0
- package/dist/esm/models/CompanyAvailableCompanies401Response.js +47 -0
- package/dist/esm/models/CompanyDetails200Response.d.ts +33 -0
- package/dist/esm/models/CompanyDetails200Response.js +44 -0
- package/dist/esm/models/CompanyDetails200ResponseCompaniesInner.d.ts +242 -0
- package/dist/esm/models/CompanyDetails200ResponseCompaniesInner.js +183 -0
- package/dist/esm/models/CompanyDividends200Response.d.ts +33 -0
- package/dist/esm/models/CompanyDividends200Response.js +44 -0
- package/dist/esm/models/CompanyDividends200ResponseCompaniesInner.d.ts +51 -0
- package/dist/esm/models/CompanyDividends200ResponseCompaniesInner.js +54 -0
- package/dist/esm/models/CompanyDividends200ResponseCompaniesInnerDividendsInner.d.ts +68 -0
- package/dist/esm/models/CompanyDividends200ResponseCompaniesInnerDividendsInner.js +67 -0
- package/dist/esm/models/CompanyFiscalPeriods200Response.d.ts +33 -0
- package/dist/esm/models/CompanyFiscalPeriods200Response.js +44 -0
- package/dist/esm/models/CompanyFiscalPeriods200ResponseCompaniesInner.d.ts +51 -0
- package/dist/esm/models/CompanyFiscalPeriods200ResponseCompaniesInner.js +54 -0
- package/dist/esm/models/CompanyFiscalPeriods200ResponseCompaniesInnerPeriodsInner.d.ts +56 -0
- package/dist/esm/models/CompanyFiscalPeriods200ResponseCompaniesInnerPeriodsInner.js +59 -0
- package/dist/esm/models/CompanySearch200Response.d.ts +45 -0
- package/dist/esm/models/CompanySearch200Response.js +50 -0
- package/dist/esm/models/CompanySearch200ResponseCompaniesInner.d.ts +50 -0
- package/dist/esm/models/CompanySearch200ResponseCompaniesInner.js +55 -0
- package/dist/esm/models/CompanySplits200Response.d.ts +33 -0
- package/dist/esm/models/CompanySplits200Response.js +44 -0
- package/dist/esm/models/CompanySplits200ResponseCompaniesInner.d.ts +51 -0
- package/dist/esm/models/CompanySplits200ResponseCompaniesInner.js +54 -0
- package/dist/esm/models/CompanySplits200ResponseCompaniesInnerSplitsInner.d.ts +50 -0
- package/dist/esm/models/CompanySplits200ResponseCompaniesInnerSplitsInner.js +55 -0
- package/dist/esm/models/EarningsCallsAnalysts200Response.d.ts +51 -0
- package/dist/esm/models/EarningsCallsAnalysts200Response.js +54 -0
- package/dist/esm/models/EarningsCallsAnalysts200ResponseAnalystsInner.d.ts +80 -0
- package/dist/esm/models/EarningsCallsAnalysts200ResponseAnalystsInner.js +75 -0
- package/dist/esm/models/EarningsCallsAudio200Response.d.ts +80 -0
- package/dist/esm/models/EarningsCallsAudio200Response.js +78 -0
- package/dist/esm/models/EarningsCallsAudio202Response.d.ts +45 -0
- package/dist/esm/models/EarningsCallsAudio202Response.js +55 -0
- package/dist/esm/models/EarningsCallsCalendar200Response.d.ts +51 -0
- package/dist/esm/models/EarningsCallsCalendar200Response.js +54 -0
- package/dist/esm/models/EarningsCallsCalendar200ResponseEventsInner.d.ts +226 -0
- package/dist/esm/models/EarningsCallsCalendar200ResponseEventsInner.js +183 -0
- package/dist/esm/models/EarningsCallsCompanyDocument200Response.d.ts +40 -0
- package/dist/esm/models/EarningsCallsCompanyDocument200Response.js +49 -0
- package/dist/esm/models/EarningsCallsCompanyDocuments200Response.d.ts +46 -0
- package/dist/esm/models/EarningsCallsCompanyDocuments200Response.js +51 -0
- package/dist/esm/models/EarningsCallsCompanyDocuments200ResponseCompany.d.ts +44 -0
- package/dist/esm/models/EarningsCallsCompanyDocuments200ResponseCompany.js +51 -0
- package/dist/esm/models/EarningsCallsCompanyDocuments200ResponseDocumentsInner.d.ts +290 -0
- package/dist/esm/models/EarningsCallsCompanyDocuments200ResponseDocumentsInner.js +239 -0
- package/dist/esm/models/EarningsCallsDiff200Response.d.ts +106 -0
- package/dist/esm/models/EarningsCallsDiff200Response.js +96 -0
- package/dist/esm/models/EarningsCallsDiff200ResponseHedging.d.ts +38 -0
- package/dist/esm/models/EarningsCallsDiff200ResponseHedging.js +47 -0
- package/dist/esm/models/EarningsCallsDiff200ResponseNewTopicsInner.d.ts +44 -0
- package/dist/esm/models/EarningsCallsDiff200ResponseNewTopicsInner.js +51 -0
- package/dist/esm/models/EarningsCallsDiff200ResponsePriorEvent.d.ts +38 -0
- package/dist/esm/models/EarningsCallsDiff200ResponsePriorEvent.js +47 -0
- package/dist/esm/models/EarningsCallsDiff200ResponseSlideDiff.d.ts +62 -0
- package/dist/esm/models/EarningsCallsDiff200ResponseSlideDiff.js +63 -0
- package/dist/esm/models/EarningsCallsDocumentSearch200Response.d.ts +39 -0
- package/dist/esm/models/EarningsCallsDocumentSearch200Response.js +48 -0
- package/dist/esm/models/EarningsCallsDocumentSearch200ResponseHitsInner.d.ts +130 -0
- package/dist/esm/models/EarningsCallsDocumentSearch200ResponseHitsInner.js +110 -0
- package/dist/esm/models/EarningsCallsDocuments200Response.d.ts +46 -0
- package/dist/esm/models/EarningsCallsDocuments200Response.js +51 -0
- package/dist/esm/models/EarningsCallsDocuments200ResponseDocumentsInner.d.ts +171 -0
- package/dist/esm/models/EarningsCallsDocuments200ResponseDocumentsInner.js +146 -0
- package/dist/esm/models/EarningsCallsEvents200Response.d.ts +57 -0
- package/dist/esm/models/EarningsCallsEvents200Response.js +58 -0
- package/dist/esm/models/EarningsCallsEvents200ResponseEventsInner.d.ts +233 -0
- package/dist/esm/models/EarningsCallsEvents200ResponseEventsInner.js +186 -0
- package/dist/esm/models/EarningsCallsEvents200ResponseEventsInnerObservationsInner.d.ts +62 -0
- package/dist/esm/models/EarningsCallsEvents200ResponseEventsInnerObservationsInner.js +63 -0
- package/dist/esm/models/EarningsCallsExtractions200Response.d.ts +67 -0
- package/dist/esm/models/EarningsCallsExtractions200Response.js +63 -0
- package/dist/esm/models/EarningsCallsExtractions200ResponseGuidanceInner.d.ts +169 -0
- package/dist/esm/models/EarningsCallsExtractions200ResponseGuidanceInner.js +144 -0
- package/dist/esm/models/EarningsCallsExtractions200ResponseGuidanceInnerSourcesInner.d.ts +59 -0
- package/dist/esm/models/EarningsCallsExtractions200ResponseGuidanceInnerSourcesInner.js +63 -0
- package/dist/esm/models/EarningsCallsExtractions200ResponseGuidanceInnerSourcesInnerSpeaker.d.ts +44 -0
- package/dist/esm/models/EarningsCallsExtractions200ResponseGuidanceInnerSourcesInnerSpeaker.js +51 -0
- package/dist/esm/models/EarningsCallsExtractions200ResponseKpisInner.d.ts +108 -0
- package/dist/esm/models/EarningsCallsExtractions200ResponseKpisInner.js +96 -0
- package/dist/esm/models/EarningsCallsExtractions200ResponseKpisInnerFilingLink.d.ts +147 -0
- package/dist/esm/models/EarningsCallsExtractions200ResponseKpisInnerFilingLink.js +129 -0
- package/dist/esm/models/EarningsCallsExtractions200ResponseKpisInnerFilingLinkFactPeriod.d.ts +50 -0
- package/dist/esm/models/EarningsCallsExtractions200ResponseKpisInnerFilingLinkFactPeriod.js +55 -0
- package/dist/esm/models/EarningsCallsGuidanceHistory200Response.d.ts +51 -0
- package/dist/esm/models/EarningsCallsGuidanceHistory200Response.js +56 -0
- package/dist/esm/models/EarningsCallsGuidanceHistory200ResponseSeriesInner.d.ts +148 -0
- package/dist/esm/models/EarningsCallsGuidanceHistory200ResponseSeriesInner.js +128 -0
- package/dist/esm/models/EarningsCallsGuidanceHistory200ResponseSeriesInnerChangeVsPrior.d.ts +44 -0
- package/dist/esm/models/EarningsCallsGuidanceHistory200ResponseSeriesInnerChangeVsPrior.js +51 -0
- package/dist/esm/models/EarningsCallsLive200Response.d.ts +39 -0
- package/dist/esm/models/EarningsCallsLive200Response.js +48 -0
- package/dist/esm/models/EarningsCallsLive200ResponseEventsInner.d.ts +251 -0
- package/dist/esm/models/EarningsCallsLive200ResponseEventsInner.js +203 -0
- package/dist/esm/models/EarningsCallsLiveStream200Response.d.ts +93 -0
- package/dist/esm/models/EarningsCallsLiveStream200Response.js +93 -0
- package/dist/esm/models/EarningsCallsLiveStream200ResponseEvent.d.ts +50 -0
- package/dist/esm/models/EarningsCallsLiveStream200ResponseEvent.js +55 -0
- package/dist/esm/models/EarningsCallsMetrics200Response.d.ts +111 -0
- package/dist/esm/models/EarningsCallsMetrics200Response.js +96 -0
- package/dist/esm/models/EarningsCallsParticipants200Response.d.ts +46 -0
- package/dist/esm/models/EarningsCallsParticipants200Response.js +53 -0
- package/dist/esm/models/EarningsCallsParticipants200ResponseParticipantsInner.d.ts +81 -0
- package/dist/esm/models/EarningsCallsParticipants200ResponseParticipantsInner.js +74 -0
- package/dist/esm/models/EarningsCallsParticipants200ResponseParticipantsInnerEvidenceInner.d.ts +38 -0
- package/dist/esm/models/EarningsCallsParticipants200ResponseParticipantsInnerEvidenceInner.js +47 -0
- package/dist/esm/models/EarningsCallsParticipants200ResponseParticipationEventsInner.d.ts +52 -0
- package/dist/esm/models/EarningsCallsParticipants200ResponseParticipationEventsInner.js +55 -0
- package/dist/esm/models/EarningsCallsPerson200Response.d.ts +88 -0
- package/dist/esm/models/EarningsCallsPerson200Response.js +79 -0
- package/dist/esm/models/EarningsCallsPerson200ResponseAppearancesInner.d.ts +104 -0
- package/dist/esm/models/EarningsCallsPerson200ResponseAppearancesInner.js +91 -0
- package/dist/esm/models/EarningsCallsPressRelease200Response.d.ts +90 -0
- package/dist/esm/models/EarningsCallsPressRelease200Response.js +82 -0
- package/dist/esm/models/EarningsCallsPressRelease200ResponseParticipantsInner.d.ts +44 -0
- package/dist/esm/models/EarningsCallsPressRelease200ResponseParticipantsInner.js +51 -0
- package/dist/esm/models/EarningsCallsPriceAttribution200Response.d.ts +127 -0
- package/dist/esm/models/EarningsCallsPriceAttribution200Response.js +113 -0
- package/dist/esm/models/EarningsCallsPriceAttribution200ResponseBucketsInner.d.ts +57 -0
- package/dist/esm/models/EarningsCallsPriceAttribution200ResponseBucketsInner.js +60 -0
- package/dist/esm/models/EarningsCallsPriceAttribution200ResponseBucketsInnerUtteranceRefsInner.d.ts +44 -0
- package/dist/esm/models/EarningsCallsPriceAttribution200ResponseBucketsInnerUtteranceRefsInner.js +51 -0
- package/dist/esm/models/EarningsCallsPriceAttribution200ResponseTopMinutesInner.d.ts +45 -0
- package/dist/esm/models/EarningsCallsPriceAttribution200ResponseTopMinutesInner.js +52 -0
- package/dist/esm/models/EarningsCallsProsody200Response.d.ts +55 -0
- package/dist/esm/models/EarningsCallsProsody200Response.js +61 -0
- package/dist/esm/models/EarningsCallsProsody200ResponseSpeakersInner.d.ts +126 -0
- package/dist/esm/models/EarningsCallsProsody200ResponseSpeakersInner.js +108 -0
- package/dist/esm/models/EarningsCallsProsody200ResponseSpeakersInnerSpeaker.d.ts +50 -0
- package/dist/esm/models/EarningsCallsProsody200ResponseSpeakersInnerSpeaker.js +55 -0
- package/dist/esm/models/EarningsCallsQa200Response.d.ts +45 -0
- package/dist/esm/models/EarningsCallsQa200Response.js +50 -0
- package/dist/esm/models/EarningsCallsQa200ResponsePairsInner.d.ts +95 -0
- package/dist/esm/models/EarningsCallsQa200ResponsePairsInner.js +84 -0
- package/dist/esm/models/EarningsCallsQa200ResponsePairsInnerAnalyst.d.ts +50 -0
- package/dist/esm/models/EarningsCallsQa200ResponsePairsInnerAnalyst.js +55 -0
- package/dist/esm/models/EarningsCallsQa200ResponsePairsInnerAnswersInner.d.ts +50 -0
- package/dist/esm/models/EarningsCallsQa200ResponsePairsInnerAnswersInner.js +55 -0
- package/dist/esm/models/EarningsCallsQa200ResponsePairsInnerScores.d.ts +69 -0
- package/dist/esm/models/EarningsCallsQa200ResponsePairsInnerScores.js +68 -0
- package/dist/esm/models/EarningsCallsQa200ResponsePairsInnerScoresEvidence.d.ts +44 -0
- package/dist/esm/models/EarningsCallsQa200ResponsePairsInnerScoresEvidence.js +51 -0
- package/dist/esm/models/EarningsCallsSearch200Response.d.ts +39 -0
- package/dist/esm/models/EarningsCallsSearch200Response.js +48 -0
- package/dist/esm/models/EarningsCallsSearch200ResponseHitsInner.d.ts +122 -0
- package/dist/esm/models/EarningsCallsSearch200ResponseHitsInner.js +106 -0
- package/dist/esm/models/EarningsCallsSearch200ResponseHitsInnerSlide.d.ts +38 -0
- package/dist/esm/models/EarningsCallsSearch200ResponseHitsInnerSlide.js +47 -0
- package/dist/esm/models/EarningsCallsSlides200Response.d.ts +47 -0
- package/dist/esm/models/EarningsCallsSlides200Response.js +54 -0
- package/dist/esm/models/EarningsCallsSlides200ResponseDeck.d.ts +73 -0
- package/dist/esm/models/EarningsCallsSlides200ResponseDeck.js +73 -0
- package/dist/esm/models/EarningsCallsSlides200ResponseSlidesInner.d.ts +50 -0
- package/dist/esm/models/EarningsCallsSlides200ResponseSlidesInner.js +53 -0
- package/dist/esm/models/EarningsCallsTranscript200Response.d.ts +107 -0
- package/dist/esm/models/EarningsCallsTranscript200Response.js +98 -0
- package/dist/esm/models/EarningsCallsTranscript404Response.d.ts +44 -0
- package/dist/esm/models/EarningsCallsTranscript404Response.js +49 -0
- package/dist/esm/models/EarningsCallsTranscriptDiff200Response.d.ts +64 -0
- package/dist/esm/models/EarningsCallsTranscriptDiff200Response.js +65 -0
- package/dist/esm/models/EarningsCallsTranscriptDiff200ResponseChangesInner.d.ts +52 -0
- package/dist/esm/models/EarningsCallsTranscriptDiff200ResponseChangesInner.js +58 -0
- package/dist/esm/models/EarningsCallsTranscriptDiff200ResponseStats.d.ts +38 -0
- package/dist/esm/models/EarningsCallsTranscriptDiff200ResponseStats.js +47 -0
- package/dist/esm/models/EarningsCallsTranscriptVersions200Response.d.ts +45 -0
- package/dist/esm/models/EarningsCallsTranscriptVersions200Response.js +52 -0
- package/dist/esm/models/EarningsCallsTranscriptVersions200ResponseVersionsInner.d.ts +71 -0
- package/dist/esm/models/EarningsCallsTranscriptVersions200ResponseVersionsInner.js +71 -0
- package/dist/esm/models/EarningsCallsWebhooksCreate201Response.d.ts +111 -0
- package/dist/esm/models/EarningsCallsWebhooksCreate201Response.js +101 -0
- package/dist/esm/models/EarningsCallsWebhooksCreateRequest.d.ts +45 -0
- package/dist/esm/models/EarningsCallsWebhooksCreateRequest.js +50 -0
- package/dist/esm/models/EarningsCallsWebhooksCreateRequestFilters.d.ts +38 -0
- package/dist/esm/models/EarningsCallsWebhooksCreateRequestFilters.js +43 -0
- package/dist/esm/models/EarningsCallsWebhooksDeliveries200Response.d.ts +33 -0
- package/dist/esm/models/EarningsCallsWebhooksDeliveries200Response.js +44 -0
- package/dist/esm/models/EarningsCallsWebhooksDeliveries200ResponseDataInner.d.ts +104 -0
- package/dist/esm/models/EarningsCallsWebhooksDeliveries200ResponseDataInner.js +99 -0
- package/dist/esm/models/EarningsCallsWebhooksList200Response.d.ts +33 -0
- package/dist/esm/models/EarningsCallsWebhooksList200Response.js +44 -0
- package/dist/esm/models/EarningsCallsWebhooksList200ResponseDataInner.d.ts +105 -0
- package/dist/esm/models/EarningsCallsWebhooksList200ResponseDataInner.js +97 -0
- package/dist/esm/models/EarningsCallsWebhooksList200ResponseDataInnerFilters.d.ts +38 -0
- package/dist/esm/models/EarningsCallsWebhooksList200ResponseDataInnerFilters.js +47 -0
- package/dist/esm/models/EarningsCallsWebhooksRotateSecret200Response.d.ts +38 -0
- package/dist/esm/models/EarningsCallsWebhooksRotateSecret200Response.js +47 -0
- package/dist/esm/models/EarningsCallsWebhooksTest202Response.d.ts +45 -0
- package/dist/esm/models/EarningsCallsWebhooksTest202Response.js +55 -0
- package/dist/esm/models/EarningsCallsWebhooksUpdateRequest.d.ts +50 -0
- package/dist/esm/models/EarningsCallsWebhooksUpdateRequest.js +47 -0
- package/dist/esm/models/FinancialMetricsRatios200Response.d.ts +33 -0
- package/dist/esm/models/FinancialMetricsRatios200Response.js +44 -0
- package/dist/esm/models/FinancialMetricsRatios200ResponseCompaniesInner.d.ts +51 -0
- package/dist/esm/models/FinancialMetricsRatios200ResponseCompaniesInner.js +54 -0
- package/dist/esm/models/FinancialMetricsRatios200ResponseCompaniesInnerPeriodsInner.d.ts +82 -0
- package/dist/esm/models/FinancialMetricsRatios200ResponseCompaniesInnerPeriodsInner.js +76 -0
- package/dist/esm/models/ForbiddenError.d.ts +38 -0
- package/dist/esm/models/ForbiddenError.js +47 -0
- package/dist/esm/models/HealthGet200Response.d.ts +38 -0
- package/dist/esm/models/HealthGet200Response.js +47 -0
- package/dist/esm/models/InsiderTradesList200Response.d.ts +51 -0
- package/dist/esm/models/InsiderTradesList200Response.js +54 -0
- package/dist/esm/models/InsiderTradesList200ResponseTransactionsInner.d.ts +146 -0
- package/dist/esm/models/InsiderTradesList200ResponseTransactionsInner.js +111 -0
- package/dist/esm/models/InstitutionalOwnershipHoldingsByCompany200Response.d.ts +51 -0
- package/dist/esm/models/InstitutionalOwnershipHoldingsByCompany200Response.js +54 -0
- package/dist/esm/models/InstitutionalOwnershipHoldingsByInvestor200Response.d.ts +45 -0
- package/dist/esm/models/InstitutionalOwnershipHoldingsByInvestor200Response.js +50 -0
- package/dist/esm/models/InstitutionalOwnershipHoldingsByInvestor200ResponseHoldingsInner.d.ts +146 -0
- package/dist/esm/models/InstitutionalOwnershipHoldingsByInvestor200ResponseHoldingsInner.js +101 -0
- package/dist/esm/models/InstitutionalOwnershipInstitutions200Response.d.ts +39 -0
- package/dist/esm/models/InstitutionalOwnershipInstitutions200Response.js +46 -0
- package/dist/esm/models/InstitutionalOwnershipInstitutions200ResponseInstitutionsInner.d.ts +74 -0
- package/dist/esm/models/InstitutionalOwnershipInstitutions200ResponseInstitutionsInner.js +71 -0
- package/dist/esm/models/InstitutionalOwnershipTransactions200Response.d.ts +39 -0
- package/dist/esm/models/InstitutionalOwnershipTransactions200Response.js +46 -0
- package/dist/esm/models/InstitutionalOwnershipTransactions200ResponseTransactionsInner.d.ts +180 -0
- package/dist/esm/models/InstitutionalOwnershipTransactions200ResponseTransactionsInner.js +126 -0
- package/dist/esm/models/InternalServerError.d.ts +38 -0
- package/dist/esm/models/InternalServerError.js +47 -0
- package/dist/esm/models/IposList200Response.d.ts +39 -0
- package/dist/esm/models/IposList200Response.js +46 -0
- package/dist/esm/models/IposList200ResponseIposInner.d.ts +158 -0
- package/dist/esm/models/IposList200ResponseIposInner.js +127 -0
- package/dist/esm/models/MarketHolidays200Response.d.ts +39 -0
- package/dist/esm/models/MarketHolidays200Response.js +46 -0
- package/dist/esm/models/MarketHolidays200ResponseHolidaysInner.d.ts +50 -0
- package/dist/esm/models/MarketHolidays200ResponseHolidaysInner.js +55 -0
- package/dist/esm/models/MetadataAvailableMetrics200Response.d.ts +33 -0
- package/dist/esm/models/MetadataAvailableMetrics200Response.js +44 -0
- package/dist/esm/models/MetadataAvailableMetrics200ResponseMetricsInner.d.ts +38 -0
- package/dist/esm/models/MetadataAvailableMetrics200ResponseMetricsInner.js +47 -0
- package/dist/esm/models/MetadataAvailableSectionIds200Response.d.ts +33 -0
- package/dist/esm/models/MetadataAvailableSectionIds200Response.js +44 -0
- package/dist/esm/models/MetadataAvailableSectionIds200ResponseFormTypesInner.d.ts +48 -0
- package/dist/esm/models/MetadataAvailableSectionIds200ResponseFormTypesInner.js +56 -0
- package/dist/esm/models/MetadataAvailableSectionIds200ResponseFormTypesInnerSectionsInner.d.ts +50 -0
- package/dist/esm/models/MetadataAvailableSectionIds200ResponseFormTypesInnerSectionsInner.js +55 -0
- package/dist/esm/models/NotFoundError.d.ts +38 -0
- package/dist/esm/models/NotFoundError.js +47 -0
- package/dist/esm/models/PresentationFact.d.ts +62 -0
- package/dist/esm/models/PresentationFact.js +57 -0
- package/dist/esm/models/SecFilingsAvailableFormTypes200Response.d.ts +32 -0
- package/dist/esm/models/SecFilingsAvailableFormTypes200Response.js +43 -0
- package/dist/esm/models/SecFilingsList200Response.d.ts +33 -0
- package/dist/esm/models/SecFilingsList200Response.js +44 -0
- package/dist/esm/models/SecFilingsList200ResponseCompaniesInner.d.ts +51 -0
- package/dist/esm/models/SecFilingsList200ResponseCompaniesInner.js +54 -0
- package/dist/esm/models/SecFilingsList200ResponseCompaniesInnerFilingsInner.d.ts +86 -0
- package/dist/esm/models/SecFilingsList200ResponseCompaniesInnerFilingsInner.js +79 -0
- package/dist/esm/models/SecFilingsSearch200Response.d.ts +39 -0
- package/dist/esm/models/SecFilingsSearch200Response.js +48 -0
- package/dist/esm/models/SecFilingsSearch200ResponseSourcesInner.d.ts +62 -0
- package/dist/esm/models/SecFilingsSearch200ResponseSourcesInner.js +63 -0
- package/dist/esm/models/SecFilingsSections200Response.d.ts +33 -0
- package/dist/esm/models/SecFilingsSections200Response.js +44 -0
- package/dist/esm/models/SecFilingsSections200ResponseCompaniesInner.d.ts +45 -0
- package/dist/esm/models/SecFilingsSections200ResponseCompaniesInner.js +52 -0
- package/dist/esm/models/SecFilingsSections200ResponseCompaniesInnerSectionsInner.d.ts +116 -0
- package/dist/esm/models/SecFilingsSections200ResponseCompaniesInnerSectionsInner.js +99 -0
- package/dist/esm/models/SegmentedFinancials200Response.d.ts +33 -0
- package/dist/esm/models/SegmentedFinancials200Response.js +44 -0
- package/dist/esm/models/SegmentedFinancials200ResponseCompaniesInner.d.ts +51 -0
- package/dist/esm/models/SegmentedFinancials200ResponseCompaniesInner.js +54 -0
- package/dist/esm/models/SegmentedFinancials200ResponseCompaniesInnerPeriodsInner.d.ts +81 -0
- package/dist/esm/models/SegmentedFinancials200ResponseCompaniesInnerPeriodsInner.js +76 -0
- package/dist/esm/models/SegmentedFinancials200ResponseCompaniesInnerPeriodsInnerFactsValueInner.d.ts +50 -0
- package/dist/esm/models/SegmentedFinancials200ResponseCompaniesInnerPeriodsInnerFactsValueInner.js +51 -0
- package/dist/esm/models/SegmentedFinancialsDetailed200Response.d.ts +33 -0
- package/dist/esm/models/SegmentedFinancialsDetailed200Response.js +44 -0
- package/dist/esm/models/SegmentedFinancialsDetailed200ResponseCompaniesInner.d.ts +51 -0
- package/dist/esm/models/SegmentedFinancialsDetailed200ResponseCompaniesInner.js +54 -0
- package/dist/esm/models/SegmentedFinancialsDetailed200ResponseCompaniesInnerPeriodsInner.d.ts +81 -0
- package/dist/esm/models/SegmentedFinancialsDetailed200ResponseCompaniesInnerPeriodsInner.js +76 -0
- package/dist/esm/models/SegmentedFinancialsDetailed200ResponseCompaniesInnerPeriodsInnerFactsValueInner.d.ts +88 -0
- package/dist/esm/models/SegmentedFinancialsDetailed200ResponseCompaniesInnerPeriodsInnerFactsValueInner.js +63 -0
- package/dist/esm/models/ServiceUnavailableError.d.ts +38 -0
- package/dist/esm/models/ServiceUnavailableError.js +47 -0
- package/dist/esm/models/StandardizedIncomeStatement200Response.d.ts +33 -0
- package/dist/esm/models/StandardizedIncomeStatement200Response.js +44 -0
- package/dist/esm/models/StandardizedIncomeStatement200ResponseCompaniesInner.d.ts +51 -0
- package/dist/esm/models/StandardizedIncomeStatement200ResponseCompaniesInner.js +54 -0
- package/dist/esm/models/StandardizedIncomeStatement200ResponseCompaniesInnerPeriodsInner.d.ts +80 -0
- package/dist/esm/models/StandardizedIncomeStatement200ResponseCompaniesInnerPeriodsInner.js +76 -0
- package/dist/esm/models/StandardizedIncomeStatementDetailed200Response.d.ts +33 -0
- package/dist/esm/models/StandardizedIncomeStatementDetailed200Response.js +44 -0
- package/dist/esm/models/StandardizedIncomeStatementDetailed200ResponseCompaniesInner.d.ts +51 -0
- package/dist/esm/models/StandardizedIncomeStatementDetailed200ResponseCompaniesInner.js +54 -0
- package/dist/esm/models/StandardizedIncomeStatementDetailed200ResponseCompaniesInnerPeriodsInner.d.ts +81 -0
- package/dist/esm/models/StandardizedIncomeStatementDetailed200ResponseCompaniesInnerPeriodsInner.js +78 -0
- package/dist/esm/models/StandardizedIncomeStatementDetailed200ResponseCompaniesInnerPeriodsInnerFactsValue.d.ts +57 -0
- package/dist/esm/models/StandardizedIncomeStatementDetailed200ResponseCompaniesInnerPeriodsInnerFactsValue.js +52 -0
- package/dist/esm/models/StandardizedIncomeStatementDetailed200ResponseCompaniesInnerPeriodsInnerFactsValueFormula.d.ts +39 -0
- package/dist/esm/models/StandardizedIncomeStatementDetailed200ResponseCompaniesInnerPeriodsInnerFactsValueFormula.js +48 -0
- package/dist/esm/models/StandardizedIncomeStatementDetailed200ResponseCompaniesInnerPeriodsInnerFactsValueFormulaMembersInner.d.ts +23 -0
- package/dist/esm/models/StandardizedIncomeStatementDetailed200ResponseCompaniesInnerPeriodsInnerFactsValueFormulaMembersInner.js +51 -0
- package/dist/esm/models/StandardizedIncomeStatementDetailed200ResponseCompaniesInnerPeriodsInnerFactsValueFormulaMembersInnerOneOf.d.ts +83 -0
- package/dist/esm/models/StandardizedIncomeStatementDetailed200ResponseCompaniesInnerPeriodsInnerFactsValueFormulaMembersInnerOneOf.js +69 -0
- package/dist/esm/models/StandardizedIncomeStatementDetailed200ResponseCompaniesInnerPeriodsInnerFactsValueFormulaMembersInnerOneOf1.d.ts +69 -0
- package/dist/esm/models/StandardizedIncomeStatementDetailed200ResponseCompaniesInnerPeriodsInnerFactsValueFormulaMembersInnerOneOf1.js +65 -0
- package/dist/esm/models/StandardizedIncomeStatementPresentation200Response.d.ts +33 -0
- package/dist/esm/models/StandardizedIncomeStatementPresentation200Response.js +44 -0
- package/dist/esm/models/StandardizedIncomeStatementPresentation200ResponseCompaniesInner.d.ts +51 -0
- package/dist/esm/models/StandardizedIncomeStatementPresentation200ResponseCompaniesInner.js +54 -0
- package/dist/esm/models/StandardizedIncomeStatementPresentation200ResponseCompaniesInnerPeriodsInner.d.ts +79 -0
- package/dist/esm/models/StandardizedIncomeStatementPresentation200ResponseCompaniesInnerPeriodsInner.js +77 -0
- package/dist/esm/models/StandardizedPresentationFact.d.ts +44 -0
- package/dist/esm/models/StandardizedPresentationFact.js +49 -0
- package/dist/esm/models/StandardizedSnapshot200Response.d.ts +33 -0
- package/dist/esm/models/StandardizedSnapshot200Response.js +44 -0
- package/dist/esm/models/StandardizedSnapshot200ResponseCompaniesInner.d.ts +91 -0
- package/dist/esm/models/StandardizedSnapshot200ResponseCompaniesInner.js +85 -0
- package/dist/esm/models/StandardizedSnapshot200ResponseCompaniesInnerStatements.d.ts +45 -0
- package/dist/esm/models/StandardizedSnapshot200ResponseCompaniesInnerStatements.js +52 -0
- package/dist/esm/models/StandardizedSnapshot200ResponseCompaniesInnerStatementsIncomeStatement.d.ts +34 -0
- package/dist/esm/models/StandardizedSnapshot200ResponseCompaniesInnerStatementsIncomeStatement.js +41 -0
- package/dist/esm/models/StandardizedSnapshotDetailed200Response.d.ts +33 -0
- package/dist/esm/models/StandardizedSnapshotDetailed200Response.js +44 -0
- package/dist/esm/models/StandardizedSnapshotDetailed200ResponseCompaniesInner.d.ts +91 -0
- package/dist/esm/models/StandardizedSnapshotDetailed200ResponseCompaniesInner.js +85 -0
- package/dist/esm/models/StandardizedSnapshotDetailed200ResponseCompaniesInnerStatements.d.ts +45 -0
- package/dist/esm/models/StandardizedSnapshotDetailed200ResponseCompaniesInnerStatements.js +52 -0
- package/dist/esm/models/StandardizedSnapshotDetailed200ResponseCompaniesInnerStatementsIncomeStatement.d.ts +35 -0
- package/dist/esm/models/StandardizedSnapshotDetailed200ResponseCompaniesInnerStatementsIncomeStatement.js +43 -0
- package/dist/esm/models/StandardizedSnapshotPresentation200Response.d.ts +33 -0
- package/dist/esm/models/StandardizedSnapshotPresentation200Response.js +44 -0
- package/dist/esm/models/StandardizedSnapshotPresentation200ResponseCompaniesInner.d.ts +91 -0
- package/dist/esm/models/StandardizedSnapshotPresentation200ResponseCompaniesInner.js +85 -0
- package/dist/esm/models/StandardizedSnapshotPresentation200ResponseCompaniesInnerStatements.d.ts +45 -0
- package/dist/esm/models/StandardizedSnapshotPresentation200ResponseCompaniesInnerStatements.js +52 -0
- package/dist/esm/models/StandardizedSnapshotPresentation200ResponseCompaniesInnerStatementsIncomeStatement.d.ts +33 -0
- package/dist/esm/models/StandardizedSnapshotPresentation200ResponseCompaniesInnerStatementsIncomeStatement.js +42 -0
- package/dist/esm/models/StatusGet200Response.d.ts +46 -0
- package/dist/esm/models/StatusGet200Response.js +53 -0
- package/dist/esm/models/StatusGet200ResponseServicesInner.d.ts +80 -0
- package/dist/esm/models/StatusGet200ResponseServicesInner.js +81 -0
- package/dist/esm/models/StatusGet200ResponseUniverse.d.ts +39 -0
- package/dist/esm/models/StatusGet200ResponseUniverse.js +48 -0
- package/dist/esm/models/StatusGet200ResponseUniverseEarningsCalls.d.ts +38 -0
- package/dist/esm/models/StatusGet200ResponseUniverseEarningsCalls.js +47 -0
- package/dist/esm/models/StatusLicensing200Response.d.ts +90 -0
- package/dist/esm/models/StatusLicensing200Response.js +86 -0
- package/dist/esm/models/StatusLicensing200ResponseFamiliesInner.d.ts +56 -0
- package/dist/esm/models/StatusLicensing200ResponseFamiliesInner.js +64 -0
- package/dist/esm/models/StatusLicensing200ResponseFamiliesInnerRoutesInner.d.ts +64 -0
- package/dist/esm/models/StatusLicensing200ResponseFamiliesInnerRoutesInner.js +69 -0
- package/dist/esm/models/StatusLicensing200ResponseNotes.d.ts +62 -0
- package/dist/esm/models/StatusLicensing200ResponseNotes.js +63 -0
- package/dist/esm/models/StatusLicensing200ResponseTiers.d.ts +51 -0
- package/dist/esm/models/StatusLicensing200ResponseTiers.js +56 -0
- package/dist/esm/models/StatusLicensing200ResponseTiersFree.d.ts +62 -0
- package/dist/esm/models/StatusLicensing200ResponseTiersFree.js +63 -0
- package/dist/esm/models/UnauthorizedError.d.ts +38 -0
- package/dist/esm/models/UnauthorizedError.js +47 -0
- package/dist/esm/models/WebSocketCallLifecycleEvent.d.ts +85 -0
- package/dist/esm/models/WebSocketCallLifecycleEvent.js +73 -0
- package/dist/esm/models/WebSocketErrorEvent.d.ts +72 -0
- package/dist/esm/models/WebSocketErrorEvent.js +75 -0
- package/dist/esm/models/WebSocketFiling.d.ts +86 -0
- package/dist/esm/models/WebSocketFiling.js +79 -0
- package/dist/esm/models/WebSocketGapEvent.d.ts +63 -0
- package/dist/esm/models/WebSocketGapEvent.js +67 -0
- package/dist/esm/models/WebSocketGuidanceFlashEvent.d.ts +141 -0
- package/dist/esm/models/WebSocketGuidanceFlashEvent.js +119 -0
- package/dist/esm/models/WebSocketKeywordHitEvent.d.ts +143 -0
- package/dist/esm/models/WebSocketKeywordHitEvent.js +122 -0
- package/dist/esm/models/WebSocketNewFilingEvent.d.ts +46 -0
- package/dist/esm/models/WebSocketNewFilingEvent.js +56 -0
- package/dist/esm/models/WebSocketPingEvent.d.ts +39 -0
- package/dist/esm/models/WebSocketPingEvent.js +51 -0
- package/dist/esm/models/WebSocketPriceTickEvent.d.ts +155 -0
- package/dist/esm/models/WebSocketPriceTickEvent.js +130 -0
- package/dist/esm/models/WebSocketSpeakerNamesEvent.d.ts +64 -0
- package/dist/esm/models/WebSocketSpeakerNamesEvent.js +68 -0
- package/dist/esm/models/WebSocketSpeakerNamesEventAssignmentsInner.d.ts +80 -0
- package/dist/esm/models/WebSocketSpeakerNamesEventAssignmentsInner.js +75 -0
- package/dist/esm/models/WebSocketSubscribeEarningsCall.d.ts +151 -0
- package/dist/esm/models/WebSocketSubscribeEarningsCall.js +114 -0
- package/dist/esm/models/WebSocketSubscribedEvent.d.ts +115 -0
- package/dist/esm/models/WebSocketSubscribedEvent.js +87 -0
- package/dist/esm/models/WebSocketTranscriptSegmentEvent.d.ts +87 -0
- package/dist/esm/models/WebSocketTranscriptSegmentEvent.js +83 -0
- package/dist/esm/models/WebSocketUnsubscribe.d.ts +45 -0
- package/dist/esm/models/WebSocketUnsubscribe.js +55 -0
- package/dist/esm/models/WebSocketUnsubscribedEvent.d.ts +63 -0
- package/dist/esm/models/WebSocketUnsubscribedEvent.js +70 -0
- package/dist/esm/models/WebSocketWarningEvent.d.ts +64 -0
- package/dist/esm/models/WebSocketWarningEvent.js +71 -0
- package/dist/esm/models/WebhookEnvelope.d.ts +68 -0
- package/dist/esm/models/WebhookEnvelope.js +72 -0
- package/dist/esm/models/index.d.ts +223 -0
- package/dist/esm/models/index.js +225 -0
- package/dist/esm/runtime.d.ts +184 -0
- package/dist/esm/runtime.js +349 -0
- package/dist/index.d.ts +3 -0
- package/dist/index.js +21 -0
- package/dist/models/AccountUsage200Response.d.ts +75 -0
- package/dist/models/AccountUsage200Response.js +83 -0
- package/dist/models/AccountUsage200ResponseByFamilyInner.d.ts +50 -0
- package/dist/models/AccountUsage200ResponseByFamilyInner.js +62 -0
- package/dist/models/AccountUsage200ResponseByKeyInner.d.ts +65 -0
- package/dist/models/AccountUsage200ResponseByKeyInner.js +75 -0
- package/dist/models/AccountUsage200ResponseDailyInner.d.ts +51 -0
- package/dist/models/AccountUsage200ResponseDailyInner.js +63 -0
- package/dist/models/AccountUsage200ResponseDailyInnerErrors.d.ts +56 -0
- package/dist/models/AccountUsage200ResponseDailyInnerErrors.js +66 -0
- package/dist/models/AccountUsage200ResponsePeriod.d.ts +67 -0
- package/dist/models/AccountUsage200ResponsePeriod.js +77 -0
- package/dist/models/AsReportedIncomeStatement200Response.d.ts +33 -0
- package/dist/models/AsReportedIncomeStatement200Response.js +51 -0
- package/dist/models/AsReportedIncomeStatement200ResponseCompaniesInner.d.ts +51 -0
- package/dist/models/AsReportedIncomeStatement200ResponseCompaniesInner.js +61 -0
- package/dist/models/AsReportedIncomeStatement200ResponseCompaniesInnerPeriodsInner.d.ts +70 -0
- package/dist/models/AsReportedIncomeStatement200ResponseCompaniesInnerPeriodsInner.js +74 -0
- package/dist/models/AsReportedIncomeStatementDetailed200Response.d.ts +33 -0
- package/dist/models/AsReportedIncomeStatementDetailed200Response.js +51 -0
- package/dist/models/AsReportedIncomeStatementDetailed200ResponseCompaniesInner.d.ts +51 -0
- package/dist/models/AsReportedIncomeStatementDetailed200ResponseCompaniesInner.js +61 -0
- package/dist/models/AsReportedIncomeStatementDetailed200ResponseCompaniesInnerPeriodsInner.d.ts +71 -0
- package/dist/models/AsReportedIncomeStatementDetailed200ResponseCompaniesInnerPeriodsInner.js +76 -0
- package/dist/models/AsReportedIncomeStatementDetailed200ResponseCompaniesInnerPeriodsInnerFactsValue.d.ts +57 -0
- package/dist/models/AsReportedIncomeStatementDetailed200ResponseCompaniesInnerPeriodsInnerFactsValue.js +57 -0
- package/dist/models/AsReportedIncomeStatementPresentation200Response.d.ts +33 -0
- package/dist/models/AsReportedIncomeStatementPresentation200Response.js +51 -0
- package/dist/models/AsReportedIncomeStatementPresentation200ResponseCompaniesInner.d.ts +51 -0
- package/dist/models/AsReportedIncomeStatementPresentation200ResponseCompaniesInner.js +61 -0
- package/dist/models/AsReportedIncomeStatementPresentation200ResponseCompaniesInnerPeriodsInner.d.ts +69 -0
- package/dist/models/AsReportedIncomeStatementPresentation200ResponseCompaniesInnerPeriodsInner.js +75 -0
- package/dist/models/AsReportedSnapshotDetailed200Response.d.ts +33 -0
- package/dist/models/AsReportedSnapshotDetailed200Response.js +51 -0
- package/dist/models/AsReportedSnapshotDetailed200ResponseCompaniesInner.d.ts +91 -0
- package/dist/models/AsReportedSnapshotDetailed200ResponseCompaniesInner.js +93 -0
- package/dist/models/AsReportedSnapshotDetailed200ResponseCompaniesInnerStatements.d.ts +45 -0
- package/dist/models/AsReportedSnapshotDetailed200ResponseCompaniesInnerStatements.js +59 -0
- package/dist/models/AsReportedSnapshotDetailed200ResponseCompaniesInnerStatementsIncomeStatement.d.ts +35 -0
- package/dist/models/AsReportedSnapshotDetailed200ResponseCompaniesInnerStatementsIncomeStatement.js +50 -0
- package/dist/models/AsReportedSnapshotPresentation200Response.d.ts +33 -0
- package/dist/models/AsReportedSnapshotPresentation200Response.js +51 -0
- package/dist/models/AsReportedSnapshotPresentation200ResponseCompaniesInner.d.ts +91 -0
- package/dist/models/AsReportedSnapshotPresentation200ResponseCompaniesInner.js +93 -0
- package/dist/models/AsReportedSnapshotPresentation200ResponseCompaniesInnerStatements.d.ts +45 -0
- package/dist/models/AsReportedSnapshotPresentation200ResponseCompaniesInnerStatements.js +59 -0
- package/dist/models/AsReportedSnapshotPresentation200ResponseCompaniesInnerStatementsIncomeStatement.d.ts +33 -0
- package/dist/models/AsReportedSnapshotPresentation200ResponseCompaniesInnerStatementsIncomeStatement.js +49 -0
- package/dist/models/BadRequestError.d.ts +38 -0
- package/dist/models/BadRequestError.js +54 -0
- package/dist/models/CompanyAvailableCompanies200Response.d.ts +39 -0
- package/dist/models/CompanyAvailableCompanies200Response.js +55 -0
- package/dist/models/CompanyAvailableCompanies200ResponseCompaniesInner.d.ts +44 -0
- package/dist/models/CompanyAvailableCompanies200ResponseCompaniesInner.js +58 -0
- package/dist/models/CompanyAvailableCompanies401Response.d.ts +38 -0
- package/dist/models/CompanyAvailableCompanies401Response.js +54 -0
- package/dist/models/CompanyDetails200Response.d.ts +33 -0
- package/dist/models/CompanyDetails200Response.js +51 -0
- package/dist/models/CompanyDetails200ResponseCompaniesInner.d.ts +242 -0
- package/dist/models/CompanyDetails200ResponseCompaniesInner.js +190 -0
- package/dist/models/CompanyDividends200Response.d.ts +33 -0
- package/dist/models/CompanyDividends200Response.js +51 -0
- package/dist/models/CompanyDividends200ResponseCompaniesInner.d.ts +51 -0
- package/dist/models/CompanyDividends200ResponseCompaniesInner.js +61 -0
- package/dist/models/CompanyDividends200ResponseCompaniesInnerDividendsInner.d.ts +68 -0
- package/dist/models/CompanyDividends200ResponseCompaniesInnerDividendsInner.js +74 -0
- package/dist/models/CompanyFiscalPeriods200Response.d.ts +33 -0
- package/dist/models/CompanyFiscalPeriods200Response.js +51 -0
- package/dist/models/CompanyFiscalPeriods200ResponseCompaniesInner.d.ts +51 -0
- package/dist/models/CompanyFiscalPeriods200ResponseCompaniesInner.js +61 -0
- package/dist/models/CompanyFiscalPeriods200ResponseCompaniesInnerPeriodsInner.d.ts +56 -0
- package/dist/models/CompanyFiscalPeriods200ResponseCompaniesInnerPeriodsInner.js +66 -0
- package/dist/models/CompanySearch200Response.d.ts +45 -0
- package/dist/models/CompanySearch200Response.js +57 -0
- package/dist/models/CompanySearch200ResponseCompaniesInner.d.ts +50 -0
- package/dist/models/CompanySearch200ResponseCompaniesInner.js +62 -0
- package/dist/models/CompanySplits200Response.d.ts +33 -0
- package/dist/models/CompanySplits200Response.js +51 -0
- package/dist/models/CompanySplits200ResponseCompaniesInner.d.ts +51 -0
- package/dist/models/CompanySplits200ResponseCompaniesInner.js +61 -0
- package/dist/models/CompanySplits200ResponseCompaniesInnerSplitsInner.d.ts +50 -0
- package/dist/models/CompanySplits200ResponseCompaniesInnerSplitsInner.js +62 -0
- package/dist/models/EarningsCallsAnalysts200Response.d.ts +51 -0
- package/dist/models/EarningsCallsAnalysts200Response.js +61 -0
- package/dist/models/EarningsCallsAnalysts200ResponseAnalystsInner.d.ts +80 -0
- package/dist/models/EarningsCallsAnalysts200ResponseAnalystsInner.js +82 -0
- package/dist/models/EarningsCallsAudio200Response.d.ts +80 -0
- package/dist/models/EarningsCallsAudio200Response.js +86 -0
- package/dist/models/EarningsCallsAudio202Response.d.ts +45 -0
- package/dist/models/EarningsCallsAudio202Response.js +63 -0
- package/dist/models/EarningsCallsCalendar200Response.d.ts +51 -0
- package/dist/models/EarningsCallsCalendar200Response.js +61 -0
- package/dist/models/EarningsCallsCalendar200ResponseEventsInner.d.ts +226 -0
- package/dist/models/EarningsCallsCalendar200ResponseEventsInner.js +191 -0
- package/dist/models/EarningsCallsCompanyDocument200Response.d.ts +40 -0
- package/dist/models/EarningsCallsCompanyDocument200Response.js +56 -0
- package/dist/models/EarningsCallsCompanyDocuments200Response.d.ts +46 -0
- package/dist/models/EarningsCallsCompanyDocuments200Response.js +58 -0
- package/dist/models/EarningsCallsCompanyDocuments200ResponseCompany.d.ts +44 -0
- package/dist/models/EarningsCallsCompanyDocuments200ResponseCompany.js +58 -0
- package/dist/models/EarningsCallsCompanyDocuments200ResponseDocumentsInner.d.ts +290 -0
- package/dist/models/EarningsCallsCompanyDocuments200ResponseDocumentsInner.js +247 -0
- package/dist/models/EarningsCallsDiff200Response.d.ts +106 -0
- package/dist/models/EarningsCallsDiff200Response.js +104 -0
- package/dist/models/EarningsCallsDiff200ResponseHedging.d.ts +38 -0
- package/dist/models/EarningsCallsDiff200ResponseHedging.js +54 -0
- package/dist/models/EarningsCallsDiff200ResponseNewTopicsInner.d.ts +44 -0
- package/dist/models/EarningsCallsDiff200ResponseNewTopicsInner.js +58 -0
- package/dist/models/EarningsCallsDiff200ResponsePriorEvent.d.ts +38 -0
- package/dist/models/EarningsCallsDiff200ResponsePriorEvent.js +54 -0
- package/dist/models/EarningsCallsDiff200ResponseSlideDiff.d.ts +62 -0
- package/dist/models/EarningsCallsDiff200ResponseSlideDiff.js +70 -0
- package/dist/models/EarningsCallsDocumentSearch200Response.d.ts +39 -0
- package/dist/models/EarningsCallsDocumentSearch200Response.js +55 -0
- package/dist/models/EarningsCallsDocumentSearch200ResponseHitsInner.d.ts +130 -0
- package/dist/models/EarningsCallsDocumentSearch200ResponseHitsInner.js +118 -0
- package/dist/models/EarningsCallsDocuments200Response.d.ts +46 -0
- package/dist/models/EarningsCallsDocuments200Response.js +58 -0
- package/dist/models/EarningsCallsDocuments200ResponseDocumentsInner.d.ts +171 -0
- package/dist/models/EarningsCallsDocuments200ResponseDocumentsInner.js +154 -0
- package/dist/models/EarningsCallsEvents200Response.d.ts +57 -0
- package/dist/models/EarningsCallsEvents200Response.js +65 -0
- package/dist/models/EarningsCallsEvents200ResponseEventsInner.d.ts +233 -0
- package/dist/models/EarningsCallsEvents200ResponseEventsInner.js +194 -0
- package/dist/models/EarningsCallsEvents200ResponseEventsInnerObservationsInner.d.ts +62 -0
- package/dist/models/EarningsCallsEvents200ResponseEventsInnerObservationsInner.js +70 -0
- package/dist/models/EarningsCallsExtractions200Response.d.ts +67 -0
- package/dist/models/EarningsCallsExtractions200Response.js +71 -0
- package/dist/models/EarningsCallsExtractions200ResponseGuidanceInner.d.ts +169 -0
- package/dist/models/EarningsCallsExtractions200ResponseGuidanceInner.js +152 -0
- package/dist/models/EarningsCallsExtractions200ResponseGuidanceInnerSourcesInner.d.ts +59 -0
- package/dist/models/EarningsCallsExtractions200ResponseGuidanceInnerSourcesInner.js +71 -0
- package/dist/models/EarningsCallsExtractions200ResponseGuidanceInnerSourcesInnerSpeaker.d.ts +44 -0
- package/dist/models/EarningsCallsExtractions200ResponseGuidanceInnerSourcesInnerSpeaker.js +58 -0
- package/dist/models/EarningsCallsExtractions200ResponseKpisInner.d.ts +108 -0
- package/dist/models/EarningsCallsExtractions200ResponseKpisInner.js +104 -0
- package/dist/models/EarningsCallsExtractions200ResponseKpisInnerFilingLink.d.ts +147 -0
- package/dist/models/EarningsCallsExtractions200ResponseKpisInnerFilingLink.js +137 -0
- package/dist/models/EarningsCallsExtractions200ResponseKpisInnerFilingLinkFactPeriod.d.ts +50 -0
- package/dist/models/EarningsCallsExtractions200ResponseKpisInnerFilingLinkFactPeriod.js +62 -0
- package/dist/models/EarningsCallsGuidanceHistory200Response.d.ts +51 -0
- package/dist/models/EarningsCallsGuidanceHistory200Response.js +63 -0
- package/dist/models/EarningsCallsGuidanceHistory200ResponseSeriesInner.d.ts +148 -0
- package/dist/models/EarningsCallsGuidanceHistory200ResponseSeriesInner.js +136 -0
- package/dist/models/EarningsCallsGuidanceHistory200ResponseSeriesInnerChangeVsPrior.d.ts +44 -0
- package/dist/models/EarningsCallsGuidanceHistory200ResponseSeriesInnerChangeVsPrior.js +58 -0
- package/dist/models/EarningsCallsLive200Response.d.ts +39 -0
- package/dist/models/EarningsCallsLive200Response.js +55 -0
- package/dist/models/EarningsCallsLive200ResponseEventsInner.d.ts +251 -0
- package/dist/models/EarningsCallsLive200ResponseEventsInner.js +211 -0
- package/dist/models/EarningsCallsLiveStream200Response.d.ts +93 -0
- package/dist/models/EarningsCallsLiveStream200Response.js +101 -0
- package/dist/models/EarningsCallsLiveStream200ResponseEvent.d.ts +50 -0
- package/dist/models/EarningsCallsLiveStream200ResponseEvent.js +62 -0
- package/dist/models/EarningsCallsMetrics200Response.d.ts +111 -0
- package/dist/models/EarningsCallsMetrics200Response.js +103 -0
- package/dist/models/EarningsCallsParticipants200Response.d.ts +46 -0
- package/dist/models/EarningsCallsParticipants200Response.js +60 -0
- package/dist/models/EarningsCallsParticipants200ResponseParticipantsInner.d.ts +81 -0
- package/dist/models/EarningsCallsParticipants200ResponseParticipantsInner.js +81 -0
- package/dist/models/EarningsCallsParticipants200ResponseParticipantsInnerEvidenceInner.d.ts +38 -0
- package/dist/models/EarningsCallsParticipants200ResponseParticipantsInnerEvidenceInner.js +54 -0
- package/dist/models/EarningsCallsParticipants200ResponseParticipationEventsInner.d.ts +52 -0
- package/dist/models/EarningsCallsParticipants200ResponseParticipationEventsInner.js +62 -0
- package/dist/models/EarningsCallsPerson200Response.d.ts +88 -0
- package/dist/models/EarningsCallsPerson200Response.js +86 -0
- package/dist/models/EarningsCallsPerson200ResponseAppearancesInner.d.ts +104 -0
- package/dist/models/EarningsCallsPerson200ResponseAppearancesInner.js +98 -0
- package/dist/models/EarningsCallsPressRelease200Response.d.ts +90 -0
- package/dist/models/EarningsCallsPressRelease200Response.js +90 -0
- package/dist/models/EarningsCallsPressRelease200ResponseParticipantsInner.d.ts +44 -0
- package/dist/models/EarningsCallsPressRelease200ResponseParticipantsInner.js +58 -0
- package/dist/models/EarningsCallsPriceAttribution200Response.d.ts +127 -0
- package/dist/models/EarningsCallsPriceAttribution200Response.js +121 -0
- package/dist/models/EarningsCallsPriceAttribution200ResponseBucketsInner.d.ts +57 -0
- package/dist/models/EarningsCallsPriceAttribution200ResponseBucketsInner.js +67 -0
- package/dist/models/EarningsCallsPriceAttribution200ResponseBucketsInnerUtteranceRefsInner.d.ts +44 -0
- package/dist/models/EarningsCallsPriceAttribution200ResponseBucketsInnerUtteranceRefsInner.js +58 -0
- package/dist/models/EarningsCallsPriceAttribution200ResponseTopMinutesInner.d.ts +45 -0
- package/dist/models/EarningsCallsPriceAttribution200ResponseTopMinutesInner.js +59 -0
- package/dist/models/EarningsCallsProsody200Response.d.ts +55 -0
- package/dist/models/EarningsCallsProsody200Response.js +69 -0
- package/dist/models/EarningsCallsProsody200ResponseSpeakersInner.d.ts +126 -0
- package/dist/models/EarningsCallsProsody200ResponseSpeakersInner.js +116 -0
- package/dist/models/EarningsCallsProsody200ResponseSpeakersInnerSpeaker.d.ts +50 -0
- package/dist/models/EarningsCallsProsody200ResponseSpeakersInnerSpeaker.js +62 -0
- package/dist/models/EarningsCallsQa200Response.d.ts +45 -0
- package/dist/models/EarningsCallsQa200Response.js +57 -0
- package/dist/models/EarningsCallsQa200ResponsePairsInner.d.ts +95 -0
- package/dist/models/EarningsCallsQa200ResponsePairsInner.js +91 -0
- package/dist/models/EarningsCallsQa200ResponsePairsInnerAnalyst.d.ts +50 -0
- package/dist/models/EarningsCallsQa200ResponsePairsInnerAnalyst.js +62 -0
- package/dist/models/EarningsCallsQa200ResponsePairsInnerAnswersInner.d.ts +50 -0
- package/dist/models/EarningsCallsQa200ResponsePairsInnerAnswersInner.js +62 -0
- package/dist/models/EarningsCallsQa200ResponsePairsInnerScores.d.ts +69 -0
- package/dist/models/EarningsCallsQa200ResponsePairsInnerScores.js +75 -0
- package/dist/models/EarningsCallsQa200ResponsePairsInnerScoresEvidence.d.ts +44 -0
- package/dist/models/EarningsCallsQa200ResponsePairsInnerScoresEvidence.js +58 -0
- package/dist/models/EarningsCallsSearch200Response.d.ts +39 -0
- package/dist/models/EarningsCallsSearch200Response.js +55 -0
- package/dist/models/EarningsCallsSearch200ResponseHitsInner.d.ts +122 -0
- package/dist/models/EarningsCallsSearch200ResponseHitsInner.js +114 -0
- package/dist/models/EarningsCallsSearch200ResponseHitsInnerSlide.d.ts +38 -0
- package/dist/models/EarningsCallsSearch200ResponseHitsInnerSlide.js +54 -0
- package/dist/models/EarningsCallsSlides200Response.d.ts +47 -0
- package/dist/models/EarningsCallsSlides200Response.js +61 -0
- package/dist/models/EarningsCallsSlides200ResponseDeck.d.ts +73 -0
- package/dist/models/EarningsCallsSlides200ResponseDeck.js +81 -0
- package/dist/models/EarningsCallsSlides200ResponseSlidesInner.d.ts +50 -0
- package/dist/models/EarningsCallsSlides200ResponseSlidesInner.js +60 -0
- package/dist/models/EarningsCallsTranscript200Response.d.ts +107 -0
- package/dist/models/EarningsCallsTranscript200Response.js +106 -0
- package/dist/models/EarningsCallsTranscript404Response.d.ts +44 -0
- package/dist/models/EarningsCallsTranscript404Response.js +56 -0
- package/dist/models/EarningsCallsTranscriptDiff200Response.d.ts +64 -0
- package/dist/models/EarningsCallsTranscriptDiff200Response.js +72 -0
- package/dist/models/EarningsCallsTranscriptDiff200ResponseChangesInner.d.ts +52 -0
- package/dist/models/EarningsCallsTranscriptDiff200ResponseChangesInner.js +66 -0
- package/dist/models/EarningsCallsTranscriptDiff200ResponseStats.d.ts +38 -0
- package/dist/models/EarningsCallsTranscriptDiff200ResponseStats.js +54 -0
- package/dist/models/EarningsCallsTranscriptVersions200Response.d.ts +45 -0
- package/dist/models/EarningsCallsTranscriptVersions200Response.js +59 -0
- package/dist/models/EarningsCallsTranscriptVersions200ResponseVersionsInner.d.ts +71 -0
- package/dist/models/EarningsCallsTranscriptVersions200ResponseVersionsInner.js +79 -0
- package/dist/models/EarningsCallsWebhooksCreate201Response.d.ts +111 -0
- package/dist/models/EarningsCallsWebhooksCreate201Response.js +109 -0
- package/dist/models/EarningsCallsWebhooksCreateRequest.d.ts +45 -0
- package/dist/models/EarningsCallsWebhooksCreateRequest.js +57 -0
- package/dist/models/EarningsCallsWebhooksCreateRequestFilters.d.ts +38 -0
- package/dist/models/EarningsCallsWebhooksCreateRequestFilters.js +50 -0
- package/dist/models/EarningsCallsWebhooksDeliveries200Response.d.ts +33 -0
- package/dist/models/EarningsCallsWebhooksDeliveries200Response.js +51 -0
- package/dist/models/EarningsCallsWebhooksDeliveries200ResponseDataInner.d.ts +104 -0
- package/dist/models/EarningsCallsWebhooksDeliveries200ResponseDataInner.js +107 -0
- package/dist/models/EarningsCallsWebhooksList200Response.d.ts +33 -0
- package/dist/models/EarningsCallsWebhooksList200Response.js +51 -0
- package/dist/models/EarningsCallsWebhooksList200ResponseDataInner.d.ts +105 -0
- package/dist/models/EarningsCallsWebhooksList200ResponseDataInner.js +105 -0
- package/dist/models/EarningsCallsWebhooksList200ResponseDataInnerFilters.d.ts +38 -0
- package/dist/models/EarningsCallsWebhooksList200ResponseDataInnerFilters.js +54 -0
- package/dist/models/EarningsCallsWebhooksRotateSecret200Response.d.ts +38 -0
- package/dist/models/EarningsCallsWebhooksRotateSecret200Response.js +54 -0
- package/dist/models/EarningsCallsWebhooksTest202Response.d.ts +45 -0
- package/dist/models/EarningsCallsWebhooksTest202Response.js +63 -0
- package/dist/models/EarningsCallsWebhooksUpdateRequest.d.ts +50 -0
- package/dist/models/EarningsCallsWebhooksUpdateRequest.js +54 -0
- package/dist/models/FinancialMetricsRatios200Response.d.ts +33 -0
- package/dist/models/FinancialMetricsRatios200Response.js +51 -0
- package/dist/models/FinancialMetricsRatios200ResponseCompaniesInner.d.ts +51 -0
- package/dist/models/FinancialMetricsRatios200ResponseCompaniesInner.js +61 -0
- package/dist/models/FinancialMetricsRatios200ResponseCompaniesInnerPeriodsInner.d.ts +82 -0
- package/dist/models/FinancialMetricsRatios200ResponseCompaniesInnerPeriodsInner.js +84 -0
- package/dist/models/ForbiddenError.d.ts +38 -0
- package/dist/models/ForbiddenError.js +54 -0
- package/dist/models/HealthGet200Response.d.ts +38 -0
- package/dist/models/HealthGet200Response.js +54 -0
- package/dist/models/InsiderTradesList200Response.d.ts +51 -0
- package/dist/models/InsiderTradesList200Response.js +61 -0
- package/dist/models/InsiderTradesList200ResponseTransactionsInner.d.ts +146 -0
- package/dist/models/InsiderTradesList200ResponseTransactionsInner.js +118 -0
- package/dist/models/InstitutionalOwnershipHoldingsByCompany200Response.d.ts +51 -0
- package/dist/models/InstitutionalOwnershipHoldingsByCompany200Response.js +61 -0
- package/dist/models/InstitutionalOwnershipHoldingsByInvestor200Response.d.ts +45 -0
- package/dist/models/InstitutionalOwnershipHoldingsByInvestor200Response.js +57 -0
- package/dist/models/InstitutionalOwnershipHoldingsByInvestor200ResponseHoldingsInner.d.ts +146 -0
- package/dist/models/InstitutionalOwnershipHoldingsByInvestor200ResponseHoldingsInner.js +108 -0
- package/dist/models/InstitutionalOwnershipInstitutions200Response.d.ts +39 -0
- package/dist/models/InstitutionalOwnershipInstitutions200Response.js +53 -0
- package/dist/models/InstitutionalOwnershipInstitutions200ResponseInstitutionsInner.d.ts +74 -0
- package/dist/models/InstitutionalOwnershipInstitutions200ResponseInstitutionsInner.js +78 -0
- package/dist/models/InstitutionalOwnershipTransactions200Response.d.ts +39 -0
- package/dist/models/InstitutionalOwnershipTransactions200Response.js +53 -0
- package/dist/models/InstitutionalOwnershipTransactions200ResponseTransactionsInner.d.ts +180 -0
- package/dist/models/InstitutionalOwnershipTransactions200ResponseTransactionsInner.js +134 -0
- package/dist/models/InternalServerError.d.ts +38 -0
- package/dist/models/InternalServerError.js +54 -0
- package/dist/models/IposList200Response.d.ts +39 -0
- package/dist/models/IposList200Response.js +53 -0
- package/dist/models/IposList200ResponseIposInner.d.ts +158 -0
- package/dist/models/IposList200ResponseIposInner.js +134 -0
- package/dist/models/MarketHolidays200Response.d.ts +39 -0
- package/dist/models/MarketHolidays200Response.js +53 -0
- package/dist/models/MarketHolidays200ResponseHolidaysInner.d.ts +50 -0
- package/dist/models/MarketHolidays200ResponseHolidaysInner.js +62 -0
- package/dist/models/MetadataAvailableMetrics200Response.d.ts +33 -0
- package/dist/models/MetadataAvailableMetrics200Response.js +51 -0
- package/dist/models/MetadataAvailableMetrics200ResponseMetricsInner.d.ts +38 -0
- package/dist/models/MetadataAvailableMetrics200ResponseMetricsInner.js +54 -0
- package/dist/models/MetadataAvailableSectionIds200Response.d.ts +33 -0
- package/dist/models/MetadataAvailableSectionIds200Response.js +51 -0
- package/dist/models/MetadataAvailableSectionIds200ResponseFormTypesInner.d.ts +48 -0
- package/dist/models/MetadataAvailableSectionIds200ResponseFormTypesInner.js +64 -0
- package/dist/models/MetadataAvailableSectionIds200ResponseFormTypesInnerSectionsInner.d.ts +50 -0
- package/dist/models/MetadataAvailableSectionIds200ResponseFormTypesInnerSectionsInner.js +62 -0
- package/dist/models/NotFoundError.d.ts +38 -0
- package/dist/models/NotFoundError.js +54 -0
- package/dist/models/PresentationFact.d.ts +62 -0
- package/dist/models/PresentationFact.js +64 -0
- package/dist/models/SecFilingsAvailableFormTypes200Response.d.ts +32 -0
- package/dist/models/SecFilingsAvailableFormTypes200Response.js +50 -0
- package/dist/models/SecFilingsList200Response.d.ts +33 -0
- package/dist/models/SecFilingsList200Response.js +51 -0
- package/dist/models/SecFilingsList200ResponseCompaniesInner.d.ts +51 -0
- package/dist/models/SecFilingsList200ResponseCompaniesInner.js +61 -0
- package/dist/models/SecFilingsList200ResponseCompaniesInnerFilingsInner.d.ts +86 -0
- package/dist/models/SecFilingsList200ResponseCompaniesInnerFilingsInner.js +86 -0
- package/dist/models/SecFilingsSearch200Response.d.ts +39 -0
- package/dist/models/SecFilingsSearch200Response.js +55 -0
- package/dist/models/SecFilingsSearch200ResponseSourcesInner.d.ts +62 -0
- package/dist/models/SecFilingsSearch200ResponseSourcesInner.js +70 -0
- package/dist/models/SecFilingsSections200Response.d.ts +33 -0
- package/dist/models/SecFilingsSections200Response.js +51 -0
- package/dist/models/SecFilingsSections200ResponseCompaniesInner.d.ts +45 -0
- package/dist/models/SecFilingsSections200ResponseCompaniesInner.js +59 -0
- package/dist/models/SecFilingsSections200ResponseCompaniesInnerSectionsInner.d.ts +116 -0
- package/dist/models/SecFilingsSections200ResponseCompaniesInnerSectionsInner.js +106 -0
- package/dist/models/SegmentedFinancials200Response.d.ts +33 -0
- package/dist/models/SegmentedFinancials200Response.js +51 -0
- package/dist/models/SegmentedFinancials200ResponseCompaniesInner.d.ts +51 -0
- package/dist/models/SegmentedFinancials200ResponseCompaniesInner.js +61 -0
- package/dist/models/SegmentedFinancials200ResponseCompaniesInnerPeriodsInner.d.ts +81 -0
- package/dist/models/SegmentedFinancials200ResponseCompaniesInnerPeriodsInner.js +84 -0
- package/dist/models/SegmentedFinancials200ResponseCompaniesInnerPeriodsInnerFactsValueInner.d.ts +50 -0
- package/dist/models/SegmentedFinancials200ResponseCompaniesInnerPeriodsInnerFactsValueInner.js +58 -0
- package/dist/models/SegmentedFinancialsDetailed200Response.d.ts +33 -0
- package/dist/models/SegmentedFinancialsDetailed200Response.js +51 -0
- package/dist/models/SegmentedFinancialsDetailed200ResponseCompaniesInner.d.ts +51 -0
- package/dist/models/SegmentedFinancialsDetailed200ResponseCompaniesInner.js +61 -0
- package/dist/models/SegmentedFinancialsDetailed200ResponseCompaniesInnerPeriodsInner.d.ts +81 -0
- package/dist/models/SegmentedFinancialsDetailed200ResponseCompaniesInnerPeriodsInner.js +84 -0
- package/dist/models/SegmentedFinancialsDetailed200ResponseCompaniesInnerPeriodsInnerFactsValueInner.d.ts +88 -0
- package/dist/models/SegmentedFinancialsDetailed200ResponseCompaniesInnerPeriodsInnerFactsValueInner.js +70 -0
- package/dist/models/ServiceUnavailableError.d.ts +38 -0
- package/dist/models/ServiceUnavailableError.js +54 -0
- package/dist/models/StandardizedIncomeStatement200Response.d.ts +33 -0
- package/dist/models/StandardizedIncomeStatement200Response.js +51 -0
- package/dist/models/StandardizedIncomeStatement200ResponseCompaniesInner.d.ts +51 -0
- package/dist/models/StandardizedIncomeStatement200ResponseCompaniesInner.js +61 -0
- package/dist/models/StandardizedIncomeStatement200ResponseCompaniesInnerPeriodsInner.d.ts +80 -0
- package/dist/models/StandardizedIncomeStatement200ResponseCompaniesInnerPeriodsInner.js +84 -0
- package/dist/models/StandardizedIncomeStatementDetailed200Response.d.ts +33 -0
- package/dist/models/StandardizedIncomeStatementDetailed200Response.js +51 -0
- package/dist/models/StandardizedIncomeStatementDetailed200ResponseCompaniesInner.d.ts +51 -0
- package/dist/models/StandardizedIncomeStatementDetailed200ResponseCompaniesInner.js +61 -0
- package/dist/models/StandardizedIncomeStatementDetailed200ResponseCompaniesInnerPeriodsInner.d.ts +81 -0
- package/dist/models/StandardizedIncomeStatementDetailed200ResponseCompaniesInnerPeriodsInner.js +86 -0
- package/dist/models/StandardizedIncomeStatementDetailed200ResponseCompaniesInnerPeriodsInnerFactsValue.d.ts +57 -0
- package/dist/models/StandardizedIncomeStatementDetailed200ResponseCompaniesInnerPeriodsInnerFactsValue.js +59 -0
- package/dist/models/StandardizedIncomeStatementDetailed200ResponseCompaniesInnerPeriodsInnerFactsValueFormula.d.ts +39 -0
- package/dist/models/StandardizedIncomeStatementDetailed200ResponseCompaniesInnerPeriodsInnerFactsValueFormula.js +55 -0
- package/dist/models/StandardizedIncomeStatementDetailed200ResponseCompaniesInnerPeriodsInnerFactsValueFormulaMembersInner.d.ts +23 -0
- package/dist/models/StandardizedIncomeStatementDetailed200ResponseCompaniesInnerPeriodsInnerFactsValueFormulaMembersInner.js +57 -0
- package/dist/models/StandardizedIncomeStatementDetailed200ResponseCompaniesInnerPeriodsInnerFactsValueFormulaMembersInnerOneOf.d.ts +83 -0
- package/dist/models/StandardizedIncomeStatementDetailed200ResponseCompaniesInnerPeriodsInnerFactsValueFormulaMembersInnerOneOf.js +77 -0
- package/dist/models/StandardizedIncomeStatementDetailed200ResponseCompaniesInnerPeriodsInnerFactsValueFormulaMembersInnerOneOf1.d.ts +69 -0
- package/dist/models/StandardizedIncomeStatementDetailed200ResponseCompaniesInnerPeriodsInnerFactsValueFormulaMembersInnerOneOf1.js +73 -0
- package/dist/models/StandardizedIncomeStatementPresentation200Response.d.ts +33 -0
- package/dist/models/StandardizedIncomeStatementPresentation200Response.js +51 -0
- package/dist/models/StandardizedIncomeStatementPresentation200ResponseCompaniesInner.d.ts +51 -0
- package/dist/models/StandardizedIncomeStatementPresentation200ResponseCompaniesInner.js +61 -0
- package/dist/models/StandardizedIncomeStatementPresentation200ResponseCompaniesInnerPeriodsInner.d.ts +79 -0
- package/dist/models/StandardizedIncomeStatementPresentation200ResponseCompaniesInnerPeriodsInner.js +85 -0
- package/dist/models/StandardizedPresentationFact.d.ts +44 -0
- package/dist/models/StandardizedPresentationFact.js +56 -0
- package/dist/models/StandardizedSnapshot200Response.d.ts +33 -0
- package/dist/models/StandardizedSnapshot200Response.js +51 -0
- package/dist/models/StandardizedSnapshot200ResponseCompaniesInner.d.ts +91 -0
- package/dist/models/StandardizedSnapshot200ResponseCompaniesInner.js +93 -0
- package/dist/models/StandardizedSnapshot200ResponseCompaniesInnerStatements.d.ts +45 -0
- package/dist/models/StandardizedSnapshot200ResponseCompaniesInnerStatements.js +59 -0
- package/dist/models/StandardizedSnapshot200ResponseCompaniesInnerStatementsIncomeStatement.d.ts +34 -0
- package/dist/models/StandardizedSnapshot200ResponseCompaniesInnerStatementsIncomeStatement.js +48 -0
- package/dist/models/StandardizedSnapshotDetailed200Response.d.ts +33 -0
- package/dist/models/StandardizedSnapshotDetailed200Response.js +51 -0
- package/dist/models/StandardizedSnapshotDetailed200ResponseCompaniesInner.d.ts +91 -0
- package/dist/models/StandardizedSnapshotDetailed200ResponseCompaniesInner.js +93 -0
- package/dist/models/StandardizedSnapshotDetailed200ResponseCompaniesInnerStatements.d.ts +45 -0
- package/dist/models/StandardizedSnapshotDetailed200ResponseCompaniesInnerStatements.js +59 -0
- package/dist/models/StandardizedSnapshotDetailed200ResponseCompaniesInnerStatementsIncomeStatement.d.ts +35 -0
- package/dist/models/StandardizedSnapshotDetailed200ResponseCompaniesInnerStatementsIncomeStatement.js +50 -0
- package/dist/models/StandardizedSnapshotPresentation200Response.d.ts +33 -0
- package/dist/models/StandardizedSnapshotPresentation200Response.js +51 -0
- package/dist/models/StandardizedSnapshotPresentation200ResponseCompaniesInner.d.ts +91 -0
- package/dist/models/StandardizedSnapshotPresentation200ResponseCompaniesInner.js +93 -0
- package/dist/models/StandardizedSnapshotPresentation200ResponseCompaniesInnerStatements.d.ts +45 -0
- package/dist/models/StandardizedSnapshotPresentation200ResponseCompaniesInnerStatements.js +59 -0
- package/dist/models/StandardizedSnapshotPresentation200ResponseCompaniesInnerStatementsIncomeStatement.d.ts +33 -0
- package/dist/models/StandardizedSnapshotPresentation200ResponseCompaniesInnerStatementsIncomeStatement.js +49 -0
- package/dist/models/StatusGet200Response.d.ts +46 -0
- package/dist/models/StatusGet200Response.js +60 -0
- package/dist/models/StatusGet200ResponseServicesInner.d.ts +80 -0
- package/dist/models/StatusGet200ResponseServicesInner.js +89 -0
- package/dist/models/StatusGet200ResponseUniverse.d.ts +39 -0
- package/dist/models/StatusGet200ResponseUniverse.js +55 -0
- package/dist/models/StatusGet200ResponseUniverseEarningsCalls.d.ts +38 -0
- package/dist/models/StatusGet200ResponseUniverseEarningsCalls.js +54 -0
- package/dist/models/StatusLicensing200Response.d.ts +90 -0
- package/dist/models/StatusLicensing200Response.js +94 -0
- package/dist/models/StatusLicensing200ResponseFamiliesInner.d.ts +56 -0
- package/dist/models/StatusLicensing200ResponseFamiliesInner.js +72 -0
- package/dist/models/StatusLicensing200ResponseFamiliesInnerRoutesInner.d.ts +64 -0
- package/dist/models/StatusLicensing200ResponseFamiliesInnerRoutesInner.js +77 -0
- package/dist/models/StatusLicensing200ResponseNotes.d.ts +62 -0
- package/dist/models/StatusLicensing200ResponseNotes.js +70 -0
- package/dist/models/StatusLicensing200ResponseTiers.d.ts +51 -0
- package/dist/models/StatusLicensing200ResponseTiers.js +63 -0
- package/dist/models/StatusLicensing200ResponseTiersFree.d.ts +62 -0
- package/dist/models/StatusLicensing200ResponseTiersFree.js +70 -0
- package/dist/models/UnauthorizedError.d.ts +38 -0
- package/dist/models/UnauthorizedError.js +54 -0
- package/dist/models/WebSocketCallLifecycleEvent.d.ts +85 -0
- package/dist/models/WebSocketCallLifecycleEvent.js +81 -0
- package/dist/models/WebSocketErrorEvent.d.ts +72 -0
- package/dist/models/WebSocketErrorEvent.js +83 -0
- package/dist/models/WebSocketFiling.d.ts +86 -0
- package/dist/models/WebSocketFiling.js +86 -0
- package/dist/models/WebSocketGapEvent.d.ts +63 -0
- package/dist/models/WebSocketGapEvent.js +75 -0
- package/dist/models/WebSocketGuidanceFlashEvent.d.ts +141 -0
- package/dist/models/WebSocketGuidanceFlashEvent.js +127 -0
- package/dist/models/WebSocketKeywordHitEvent.d.ts +143 -0
- package/dist/models/WebSocketKeywordHitEvent.js +130 -0
- package/dist/models/WebSocketNewFilingEvent.d.ts +46 -0
- package/dist/models/WebSocketNewFilingEvent.js +64 -0
- package/dist/models/WebSocketPingEvent.d.ts +39 -0
- package/dist/models/WebSocketPingEvent.js +59 -0
- package/dist/models/WebSocketPriceTickEvent.d.ts +155 -0
- package/dist/models/WebSocketPriceTickEvent.js +138 -0
- package/dist/models/WebSocketSpeakerNamesEvent.d.ts +64 -0
- package/dist/models/WebSocketSpeakerNamesEvent.js +76 -0
- package/dist/models/WebSocketSpeakerNamesEventAssignmentsInner.d.ts +80 -0
- package/dist/models/WebSocketSpeakerNamesEventAssignmentsInner.js +82 -0
- package/dist/models/WebSocketSubscribeEarningsCall.d.ts +151 -0
- package/dist/models/WebSocketSubscribeEarningsCall.js +122 -0
- package/dist/models/WebSocketSubscribedEvent.d.ts +115 -0
- package/dist/models/WebSocketSubscribedEvent.js +95 -0
- package/dist/models/WebSocketTranscriptSegmentEvent.d.ts +87 -0
- package/dist/models/WebSocketTranscriptSegmentEvent.js +91 -0
- package/dist/models/WebSocketUnsubscribe.d.ts +45 -0
- package/dist/models/WebSocketUnsubscribe.js +63 -0
- package/dist/models/WebSocketUnsubscribedEvent.d.ts +63 -0
- package/dist/models/WebSocketUnsubscribedEvent.js +78 -0
- package/dist/models/WebSocketWarningEvent.d.ts +64 -0
- package/dist/models/WebSocketWarningEvent.js +79 -0
- package/dist/models/WebhookEnvelope.d.ts +68 -0
- package/dist/models/WebhookEnvelope.js +80 -0
- package/dist/models/index.d.ts +223 -0
- package/dist/models/index.js +241 -0
- package/dist/runtime.d.ts +184 -0
- package/dist/runtime.js +365 -0
- package/docs/AccountApi.md +85 -0
- package/docs/AccountUsage200Response.md +44 -0
- package/docs/AccountUsage200ResponseByFamilyInner.md +40 -0
- package/docs/AccountUsage200ResponseByKeyInner.md +42 -0
- package/docs/AccountUsage200ResponseDailyInner.md +40 -0
- package/docs/AccountUsage200ResponseDailyInnerErrors.md +43 -0
- package/docs/AccountUsage200ResponsePeriod.md +43 -0
- package/docs/AsReportedBalanceSheetApi.md +275 -0
- package/docs/AsReportedCashFlowStatementApi.md +275 -0
- package/docs/AsReportedIncomeStatement200Response.md +34 -0
- package/docs/AsReportedIncomeStatement200ResponseCompaniesInner.md +40 -0
- package/docs/AsReportedIncomeStatement200ResponseCompaniesInnerPeriodsInner.md +46 -0
- package/docs/AsReportedIncomeStatementApi.md +275 -0
- package/docs/AsReportedIncomeStatementDetailed200Response.md +34 -0
- package/docs/AsReportedIncomeStatementDetailed200ResponseCompaniesInner.md +40 -0
- package/docs/AsReportedIncomeStatementDetailed200ResponseCompaniesInnerPeriodsInner.md +46 -0
- package/docs/AsReportedIncomeStatementDetailed200ResponseCompaniesInnerPeriodsInnerFactsValue.md +42 -0
- package/docs/AsReportedIncomeStatementPresentation200Response.md +34 -0
- package/docs/AsReportedIncomeStatementPresentation200ResponseCompaniesInner.md +40 -0
- package/docs/AsReportedIncomeStatementPresentation200ResponseCompaniesInnerPeriodsInner.md +46 -0
- package/docs/AsReportedSnapshotApi.md +266 -0
- package/docs/AsReportedSnapshotDetailed200Response.md +34 -0
- package/docs/AsReportedSnapshotDetailed200ResponseCompaniesInner.md +50 -0
- package/docs/AsReportedSnapshotDetailed200ResponseCompaniesInnerStatements.md +38 -0
- package/docs/AsReportedSnapshotDetailed200ResponseCompaniesInnerStatementsIncomeStatement.md +35 -0
- package/docs/AsReportedSnapshotPresentation200Response.md +34 -0
- package/docs/AsReportedSnapshotPresentation200ResponseCompaniesInner.md +50 -0
- package/docs/AsReportedSnapshotPresentation200ResponseCompaniesInnerStatements.md +38 -0
- package/docs/AsReportedSnapshotPresentation200ResponseCompaniesInnerStatementsIncomeStatement.md +35 -0
- package/docs/BadRequestError.md +36 -0
- package/docs/CompanyApi.md +492 -0
- package/docs/CompanyAvailableCompanies200Response.md +36 -0
- package/docs/CompanyAvailableCompanies200ResponseCompaniesInner.md +38 -0
- package/docs/CompanyAvailableCompanies401Response.md +36 -0
- package/docs/CompanyDetails200Response.md +34 -0
- package/docs/CompanyDetails200ResponseCompaniesInner.md +104 -0
- package/docs/CompanyDividends200Response.md +34 -0
- package/docs/CompanyDividends200ResponseCompaniesInner.md +40 -0
- package/docs/CompanyDividends200ResponseCompaniesInnerDividendsInner.md +46 -0
- package/docs/CompanyFiscalPeriods200Response.md +34 -0
- package/docs/CompanyFiscalPeriods200ResponseCompaniesInner.md +40 -0
- package/docs/CompanyFiscalPeriods200ResponseCompaniesInnerPeriodsInner.md +42 -0
- package/docs/CompanySearch200Response.md +38 -0
- package/docs/CompanySearch200ResponseCompaniesInner.md +40 -0
- package/docs/CompanySplits200Response.md +34 -0
- package/docs/CompanySplits200ResponseCompaniesInner.md +40 -0
- package/docs/CompanySplits200ResponseCompaniesInnerSplitsInner.md +40 -0
- package/docs/EarningsCallsAnalysts200Response.md +40 -0
- package/docs/EarningsCallsAnalysts200ResponseAnalystsInner.md +50 -0
- package/docs/EarningsCallsApi.md +2960 -0
- package/docs/EarningsCallsAudio200Response.md +46 -0
- package/docs/EarningsCallsAudio202Response.md +37 -0
- package/docs/EarningsCallsCalendar200Response.md +40 -0
- package/docs/EarningsCallsCalendar200ResponseEventsInner.md +86 -0
- package/docs/EarningsCallsCompanyDocument200Response.md +36 -0
- package/docs/EarningsCallsCompanyDocuments200Response.md +38 -0
- package/docs/EarningsCallsCompanyDocuments200ResponseCompany.md +38 -0
- package/docs/EarningsCallsCompanyDocuments200ResponseDocumentsInner.md +84 -0
- package/docs/EarningsCallsDiff200Response.md +54 -0
- package/docs/EarningsCallsDiff200ResponseHedging.md +37 -0
- package/docs/EarningsCallsDiff200ResponseNewTopicsInner.md +38 -0
- package/docs/EarningsCallsDiff200ResponsePriorEvent.md +37 -0
- package/docs/EarningsCallsDiff200ResponseSlideDiff.md +45 -0
- package/docs/EarningsCallsDocumentSearch200Response.md +36 -0
- package/docs/EarningsCallsDocumentSearch200ResponseHitsInner.md +64 -0
- package/docs/EarningsCallsDocuments200Response.md +38 -0
- package/docs/EarningsCallsDocuments200ResponseDocumentsInner.md +64 -0
- package/docs/EarningsCallsEvents200Response.md +42 -0
- package/docs/EarningsCallsEvents200ResponseEventsInner.md +88 -0
- package/docs/EarningsCallsEvents200ResponseEventsInnerObservationsInner.md +44 -0
- package/docs/EarningsCallsExtractions200Response.md +42 -0
- package/docs/EarningsCallsExtractions200ResponseGuidanceInner.md +66 -0
- package/docs/EarningsCallsExtractions200ResponseGuidanceInnerSourcesInner.md +40 -0
- package/docs/EarningsCallsExtractions200ResponseGuidanceInnerSourcesInnerSpeaker.md +38 -0
- package/docs/EarningsCallsExtractions200ResponseKpisInner.md +56 -0
- package/docs/EarningsCallsExtractions200ResponseKpisInnerFilingLink.md +59 -0
- package/docs/EarningsCallsExtractions200ResponseKpisInnerFilingLinkFactPeriod.md +41 -0
- package/docs/EarningsCallsGuidanceHistory200Response.md +40 -0
- package/docs/EarningsCallsGuidanceHistory200ResponseSeriesInner.md +62 -0
- package/docs/EarningsCallsGuidanceHistory200ResponseSeriesInnerChangeVsPrior.md +39 -0
- package/docs/EarningsCallsLive200Response.md +36 -0
- package/docs/EarningsCallsLive200ResponseEventsInner.md +92 -0
- package/docs/EarningsCallsLiveStream200Response.md +46 -0
- package/docs/EarningsCallsLiveStream200ResponseEvent.md +40 -0
- package/docs/EarningsCallsMetrics200Response.md +60 -0
- package/docs/EarningsCallsParticipants200Response.md +38 -0
- package/docs/EarningsCallsParticipants200ResponseParticipantsInner.md +50 -0
- package/docs/EarningsCallsParticipants200ResponseParticipantsInnerEvidenceInner.md +36 -0
- package/docs/EarningsCallsParticipants200ResponseParticipationEventsInner.md +40 -0
- package/docs/EarningsCallsPerson200Response.md +52 -0
- package/docs/EarningsCallsPerson200ResponseAppearancesInner.md +58 -0
- package/docs/EarningsCallsPressRelease200Response.md +50 -0
- package/docs/EarningsCallsPressRelease200ResponseParticipantsInner.md +38 -0
- package/docs/EarningsCallsPriceAttribution200Response.md +56 -0
- package/docs/EarningsCallsPriceAttribution200ResponseBucketsInner.md +42 -0
- package/docs/EarningsCallsPriceAttribution200ResponseBucketsInnerUtteranceRefsInner.md +38 -0
- package/docs/EarningsCallsPriceAttribution200ResponseTopMinutesInner.md +38 -0
- package/docs/EarningsCallsProsody200Response.md +38 -0
- package/docs/EarningsCallsProsody200ResponseSpeakersInner.md +62 -0
- package/docs/EarningsCallsProsody200ResponseSpeakersInnerSpeaker.md +40 -0
- package/docs/EarningsCallsQa200Response.md +38 -0
- package/docs/EarningsCallsQa200ResponsePairsInner.md +54 -0
- package/docs/EarningsCallsQa200ResponsePairsInnerAnalyst.md +40 -0
- package/docs/EarningsCallsQa200ResponsePairsInnerAnswersInner.md +40 -0
- package/docs/EarningsCallsQa200ResponsePairsInnerScores.md +47 -0
- package/docs/EarningsCallsQa200ResponsePairsInnerScoresEvidence.md +39 -0
- package/docs/EarningsCallsSearch200Response.md +36 -0
- package/docs/EarningsCallsSearch200ResponseHitsInner.md +60 -0
- package/docs/EarningsCallsSearch200ResponseHitsInnerSlide.md +37 -0
- package/docs/EarningsCallsSlides200Response.md +38 -0
- package/docs/EarningsCallsSlides200ResponseDeck.md +45 -0
- package/docs/EarningsCallsSlides200ResponseSlidesInner.md +40 -0
- package/docs/EarningsCallsTranscript200Response.md +52 -0
- package/docs/EarningsCallsTranscript404Response.md +38 -0
- package/docs/EarningsCallsTranscriptDiff200Response.md +44 -0
- package/docs/EarningsCallsTranscriptDiff200ResponseChangesInner.md +38 -0
- package/docs/EarningsCallsTranscriptDiff200ResponseStats.md +36 -0
- package/docs/EarningsCallsTranscriptVersions200Response.md +38 -0
- package/docs/EarningsCallsTranscriptVersions200ResponseVersionsInner.md +44 -0
- package/docs/EarningsCallsWebhooksCreate201Response.md +54 -0
- package/docs/EarningsCallsWebhooksCreateRequest.md +38 -0
- package/docs/EarningsCallsWebhooksCreateRequestFilters.md +36 -0
- package/docs/EarningsCallsWebhooksDeliveries200Response.md +34 -0
- package/docs/EarningsCallsWebhooksDeliveries200ResponseDataInner.md +48 -0
- package/docs/EarningsCallsWebhooksList200Response.md +34 -0
- package/docs/EarningsCallsWebhooksList200ResponseDataInner.md +52 -0
- package/docs/EarningsCallsWebhooksList200ResponseDataInnerFilters.md +36 -0
- package/docs/EarningsCallsWebhooksRotateSecret200Response.md +36 -0
- package/docs/EarningsCallsWebhooksTest202Response.md +36 -0
- package/docs/EarningsCallsWebhooksUpdateRequest.md +41 -0
- package/docs/FinancialMetricsApi.md +278 -0
- package/docs/FinancialMetricsRatios200Response.md +34 -0
- package/docs/FinancialMetricsRatios200ResponseCompaniesInner.md +40 -0
- package/docs/FinancialMetricsRatios200ResponseCompaniesInnerPeriodsInner.md +46 -0
- package/docs/ForbiddenError.md +36 -0
- package/docs/HealthApi.md +68 -0
- package/docs/HealthGet200Response.md +37 -0
- package/docs/IPOsApi.md +95 -0
- package/docs/InsiderTradesApi.md +102 -0
- package/docs/InsiderTradesList200Response.md +40 -0
- package/docs/InsiderTradesList200ResponseTransactionsInner.md +72 -0
- package/docs/InstitutionalOwnershipApi.md +368 -0
- package/docs/InstitutionalOwnershipHoldingsByCompany200Response.md +40 -0
- package/docs/InstitutionalOwnershipHoldingsByInvestor200Response.md +38 -0
- package/docs/InstitutionalOwnershipHoldingsByInvestor200ResponseHoldingsInner.md +72 -0
- package/docs/InstitutionalOwnershipInstitutions200Response.md +36 -0
- package/docs/InstitutionalOwnershipInstitutions200ResponseInstitutionsInner.md +48 -0
- package/docs/InstitutionalOwnershipTransactions200Response.md +36 -0
- package/docs/InstitutionalOwnershipTransactions200ResponseTransactionsInner.md +80 -0
- package/docs/InternalServerError.md +36 -0
- package/docs/IposList200Response.md +36 -0
- package/docs/IposList200ResponseIposInner.md +76 -0
- package/docs/MarketApi.md +89 -0
- package/docs/MarketHolidays200Response.md +36 -0
- package/docs/MarketHolidays200ResponseHolidaysInner.md +40 -0
- package/docs/MetadataApi.md +140 -0
- package/docs/MetadataAvailableMetrics200Response.md +34 -0
- package/docs/MetadataAvailableMetrics200ResponseMetricsInner.md +36 -0
- package/docs/MetadataAvailableSectionIds200Response.md +34 -0
- package/docs/MetadataAvailableSectionIds200ResponseFormTypesInner.md +36 -0
- package/docs/MetadataAvailableSectionIds200ResponseFormTypesInnerSectionsInner.md +40 -0
- package/docs/NotFoundError.md +36 -0
- package/docs/PresentationFact.md +44 -0
- package/docs/SECFilingsApi.md +344 -0
- package/docs/SecFilingsAvailableFormTypes200Response.md +34 -0
- package/docs/SecFilingsList200Response.md +34 -0
- package/docs/SecFilingsList200ResponseCompaniesInner.md +40 -0
- package/docs/SecFilingsList200ResponseCompaniesInnerFilingsInner.md +52 -0
- package/docs/SecFilingsSearch200Response.md +36 -0
- package/docs/SecFilingsSearch200ResponseSourcesInner.md +44 -0
- package/docs/SecFilingsSections200Response.md +34 -0
- package/docs/SecFilingsSections200ResponseCompaniesInner.md +38 -0
- package/docs/SecFilingsSections200ResponseCompaniesInnerSectionsInner.md +62 -0
- package/docs/SegmentedFinancials200Response.md +34 -0
- package/docs/SegmentedFinancials200ResponseCompaniesInner.md +40 -0
- package/docs/SegmentedFinancials200ResponseCompaniesInnerPeriodsInner.md +46 -0
- package/docs/SegmentedFinancials200ResponseCompaniesInnerPeriodsInnerFactsValueInner.md +40 -0
- package/docs/SegmentedFinancialsApi.md +190 -0
- package/docs/SegmentedFinancialsDetailed200Response.md +34 -0
- package/docs/SegmentedFinancialsDetailed200ResponseCompaniesInner.md +40 -0
- package/docs/SegmentedFinancialsDetailed200ResponseCompaniesInnerPeriodsInner.md +46 -0
- package/docs/SegmentedFinancialsDetailed200ResponseCompaniesInnerPeriodsInnerFactsValueInner.md +52 -0
- package/docs/ServiceUnavailableError.md +36 -0
- package/docs/StandardizedBalanceSheetApi.md +275 -0
- package/docs/StandardizedCashFlowStatementApi.md +275 -0
- package/docs/StandardizedIncomeStatement200Response.md +34 -0
- package/docs/StandardizedIncomeStatement200ResponseCompaniesInner.md +40 -0
- package/docs/StandardizedIncomeStatement200ResponseCompaniesInnerPeriodsInner.md +46 -0
- package/docs/StandardizedIncomeStatementApi.md +275 -0
- package/docs/StandardizedIncomeStatementDetailed200Response.md +34 -0
- package/docs/StandardizedIncomeStatementDetailed200ResponseCompaniesInner.md +40 -0
- package/docs/StandardizedIncomeStatementDetailed200ResponseCompaniesInnerPeriodsInner.md +46 -0
- package/docs/StandardizedIncomeStatementDetailed200ResponseCompaniesInnerPeriodsInnerFactsValue.md +43 -0
- package/docs/StandardizedIncomeStatementDetailed200ResponseCompaniesInnerPeriodsInnerFactsValueFormula.md +37 -0
- package/docs/StandardizedIncomeStatementDetailed200ResponseCompaniesInnerPeriodsInnerFactsValueFormulaMembersInner.md +54 -0
- package/docs/StandardizedIncomeStatementDetailed200ResponseCompaniesInnerPeriodsInnerFactsValueFormulaMembersInnerOneOf.md +49 -0
- package/docs/StandardizedIncomeStatementDetailed200ResponseCompaniesInnerPeriodsInnerFactsValueFormulaMembersInnerOneOf1.md +45 -0
- package/docs/StandardizedIncomeStatementPresentation200Response.md +34 -0
- package/docs/StandardizedIncomeStatementPresentation200ResponseCompaniesInner.md +40 -0
- package/docs/StandardizedIncomeStatementPresentation200ResponseCompaniesInnerPeriodsInner.md +46 -0
- package/docs/StandardizedPresentationFact.md +38 -0
- package/docs/StandardizedSnapshot200Response.md +34 -0
- package/docs/StandardizedSnapshot200ResponseCompaniesInner.md +50 -0
- package/docs/StandardizedSnapshot200ResponseCompaniesInnerStatements.md +38 -0
- package/docs/StandardizedSnapshot200ResponseCompaniesInnerStatementsIncomeStatement.md +35 -0
- package/docs/StandardizedSnapshotApi.md +266 -0
- package/docs/StandardizedSnapshotDetailed200Response.md +34 -0
- package/docs/StandardizedSnapshotDetailed200ResponseCompaniesInner.md +50 -0
- package/docs/StandardizedSnapshotDetailed200ResponseCompaniesInnerStatements.md +38 -0
- package/docs/StandardizedSnapshotDetailed200ResponseCompaniesInnerStatementsIncomeStatement.md +35 -0
- package/docs/StandardizedSnapshotPresentation200Response.md +34 -0
- package/docs/StandardizedSnapshotPresentation200ResponseCompaniesInner.md +50 -0
- package/docs/StandardizedSnapshotPresentation200ResponseCompaniesInnerStatements.md +38 -0
- package/docs/StandardizedSnapshotPresentation200ResponseCompaniesInnerStatementsIncomeStatement.md +35 -0
- package/docs/StatusApi.md +131 -0
- package/docs/StatusGet200Response.md +38 -0
- package/docs/StatusGet200ResponseServicesInner.md +42 -0
- package/docs/StatusGet200ResponseUniverse.md +37 -0
- package/docs/StatusGet200ResponseUniverseEarningsCalls.md +36 -0
- package/docs/StatusLicensing200Response.md +48 -0
- package/docs/StatusLicensing200ResponseFamiliesInner.md +36 -0
- package/docs/StatusLicensing200ResponseFamiliesInnerRoutesInner.md +38 -0
- package/docs/StatusLicensing200ResponseNotes.md +44 -0
- package/docs/StatusLicensing200ResponseTiers.md +40 -0
- package/docs/StatusLicensing200ResponseTiersFree.md +44 -0
- package/docs/UnauthorizedError.md +36 -0
- package/docs/WebSocketCallLifecycleEvent.md +49 -0
- package/docs/WebSocketErrorEvent.md +41 -0
- package/docs/WebSocketFiling.md +52 -0
- package/docs/WebSocketGapEvent.md +43 -0
- package/docs/WebSocketGuidanceFlashEvent.md +69 -0
- package/docs/WebSocketKeywordHitEvent.md +67 -0
- package/docs/WebSocketNewFilingEvent.md +37 -0
- package/docs/WebSocketPingEvent.md +35 -0
- package/docs/WebSocketPriceTickEvent.md +71 -0
- package/docs/WebSocketSpeakerNamesEvent.md +43 -0
- package/docs/WebSocketSpeakerNamesEventAssignmentsInner.md +50 -0
- package/docs/WebSocketSubscribeEarningsCall.md +59 -0
- package/docs/WebSocketSubscribedEvent.md +55 -0
- package/docs/WebSocketTranscriptSegmentEvent.md +51 -0
- package/docs/WebSocketUnsubscribe.md +37 -0
- package/docs/WebSocketUnsubscribedEvent.md +39 -0
- package/docs/WebSocketWarningEvent.md +41 -0
- package/docs/WebhookEnvelope.md +40 -0
- package/package.json +24 -4
- package/src/apis/AccountApi.ts +97 -0
- package/src/apis/AsReportedBalanceSheetApi.ts +377 -0
- package/src/apis/AsReportedCashFlowStatementApi.ts +377 -0
- package/src/apis/AsReportedIncomeStatementApi.ts +377 -0
- package/src/apis/AsReportedSnapshotApi.ts +338 -0
- package/src/apis/CompanyApi.ts +504 -0
- package/src/apis/EarningsCallsApi.ts +3144 -0
- package/src/apis/FinancialMetricsApi.ts +374 -0
- package/src/apis/HealthApi.ts +66 -0
- package/src/apis/IPOsApi.ts +116 -0
- package/src/apis/InsiderTradesApi.ts +141 -0
- package/src/apis/InstitutionalOwnershipApi.ts +419 -0
- package/src/apis/MarketApi.ts +106 -0
- package/src/apis/MetadataApi.ts +131 -0
- package/src/apis/SECFilingsApi.ts +368 -0
- package/src/apis/SegmentedFinancialsApi.ts +288 -0
- package/src/apis/StandardizedBalanceSheetApi.ts +377 -0
- package/src/apis/StandardizedCashFlowStatementApi.ts +377 -0
- package/src/apis/StandardizedIncomeStatementApi.ts +377 -0
- package/src/apis/StandardizedSnapshotApi.ts +338 -0
- package/src/apis/StatusApi.ts +115 -0
- package/src/apis/index.ts +23 -0
- package/src/index.ts +5 -0
- package/src/models/AccountUsage200Response.ts +152 -0
- package/src/models/AccountUsage200ResponseByFamilyInner.ts +93 -0
- package/src/models/AccountUsage200ResponseByKeyInner.ts +114 -0
- package/src/models/AccountUsage200ResponseDailyInner.ts +101 -0
- package/src/models/AccountUsage200ResponseDailyInnerErrors.ts +102 -0
- package/src/models/AccountUsage200ResponsePeriod.ts +116 -0
- package/src/models/AsReportedIncomeStatement200Response.ts +74 -0
- package/src/models/AsReportedIncomeStatement200ResponseCompaniesInner.ts +100 -0
- package/src/models/AsReportedIncomeStatement200ResponseCompaniesInnerPeriodsInner.ts +120 -0
- package/src/models/AsReportedIncomeStatementDetailed200Response.ts +74 -0
- package/src/models/AsReportedIncomeStatementDetailed200ResponseCompaniesInner.ts +100 -0
- package/src/models/AsReportedIncomeStatementDetailed200ResponseCompaniesInnerPeriodsInner.ts +128 -0
- package/src/models/AsReportedIncomeStatementDetailed200ResponseCompaniesInnerPeriodsInnerFactsValue.ts +105 -0
- package/src/models/AsReportedIncomeStatementPresentation200Response.ts +74 -0
- package/src/models/AsReportedIncomeStatementPresentation200ResponseCompaniesInner.ts +100 -0
- package/src/models/AsReportedIncomeStatementPresentation200ResponseCompaniesInnerPeriodsInner.ts +128 -0
- package/src/models/AsReportedSnapshotDetailed200Response.ts +74 -0
- package/src/models/AsReportedSnapshotDetailed200ResponseCompaniesInner.ts +159 -0
- package/src/models/AsReportedSnapshotDetailed200ResponseCompaniesInnerStatements.ts +92 -0
- package/src/models/AsReportedSnapshotDetailed200ResponseCompaniesInnerStatementsIncomeStatement.ts +73 -0
- package/src/models/AsReportedSnapshotPresentation200Response.ts +74 -0
- package/src/models/AsReportedSnapshotPresentation200ResponseCompaniesInner.ts +159 -0
- package/src/models/AsReportedSnapshotPresentation200ResponseCompaniesInnerStatements.ts +92 -0
- package/src/models/AsReportedSnapshotPresentation200ResponseCompaniesInnerStatementsIncomeStatement.ts +73 -0
- package/src/models/BadRequestError.ts +75 -0
- package/src/models/CompanyAvailableCompanies200Response.ts +83 -0
- package/src/models/CompanyAvailableCompanies200ResponseCompaniesInner.ts +84 -0
- package/src/models/CompanyAvailableCompanies401Response.ts +75 -0
- package/src/models/CompanyDetails200Response.ts +74 -0
- package/src/models/CompanyDetails200ResponseCompaniesInner.ts +381 -0
- package/src/models/CompanyDividends200Response.ts +74 -0
- package/src/models/CompanyDividends200ResponseCompaniesInner.ts +100 -0
- package/src/models/CompanyDividends200ResponseCompaniesInnerDividendsInner.ts +120 -0
- package/src/models/CompanyFiscalPeriods200Response.ts +74 -0
- package/src/models/CompanyFiscalPeriods200ResponseCompaniesInner.ts +100 -0
- package/src/models/CompanyFiscalPeriods200ResponseCompaniesInnerPeriodsInner.ts +102 -0
- package/src/models/CompanySearch200Response.ts +91 -0
- package/src/models/CompanySearch200ResponseCompaniesInner.ts +93 -0
- package/src/models/CompanySplits200Response.ts +74 -0
- package/src/models/CompanySplits200ResponseCompaniesInner.ts +100 -0
- package/src/models/CompanySplits200ResponseCompaniesInnerSplitsInner.ts +93 -0
- package/src/models/EarningsCallsAnalysts200Response.ts +100 -0
- package/src/models/EarningsCallsAnalysts200ResponseAnalystsInner.ts +138 -0
- package/src/models/EarningsCallsAudio200Response.ts +142 -0
- package/src/models/EarningsCallsAudio202Response.ts +87 -0
- package/src/models/EarningsCallsCalendar200Response.ts +100 -0
- package/src/models/EarningsCallsCalendar200ResponseEventsInner.ts +346 -0
- package/src/models/EarningsCallsCompanyDocument200Response.ts +90 -0
- package/src/models/EarningsCallsCompanyDocuments200Response.ts +98 -0
- package/src/models/EarningsCallsCompanyDocuments200ResponseCompany.ts +84 -0
- package/src/models/EarningsCallsCompanyDocuments200ResponseDocumentsInner.ts +406 -0
- package/src/models/EarningsCallsDiff200Response.ts +204 -0
- package/src/models/EarningsCallsDiff200ResponseHedging.ts +75 -0
- package/src/models/EarningsCallsDiff200ResponseNewTopicsInner.ts +84 -0
- package/src/models/EarningsCallsDiff200ResponsePriorEvent.ts +75 -0
- package/src/models/EarningsCallsDiff200ResponseSlideDiff.ts +111 -0
- package/src/models/EarningsCallsDocumentSearch200Response.ts +83 -0
- package/src/models/EarningsCallsDocumentSearch200ResponseHitsInner.ts +212 -0
- package/src/models/EarningsCallsDocuments200Response.ts +98 -0
- package/src/models/EarningsCallsDocuments200ResponseDocumentsInner.ts +255 -0
- package/src/models/EarningsCallsEvents200Response.ts +109 -0
- package/src/models/EarningsCallsEvents200ResponseEventsInner.ts +362 -0
- package/src/models/EarningsCallsEvents200ResponseEventsInnerObservationsInner.ts +111 -0
- package/src/models/EarningsCallsExtractions200Response.ts +132 -0
- package/src/models/EarningsCallsExtractions200ResponseGuidanceInner.ts +264 -0
- package/src/models/EarningsCallsExtractions200ResponseGuidanceInnerSourcesInner.ts +112 -0
- package/src/models/EarningsCallsExtractions200ResponseGuidanceInnerSourcesInnerSpeaker.ts +84 -0
- package/src/models/EarningsCallsExtractions200ResponseKpisInner.ts +191 -0
- package/src/models/EarningsCallsExtractions200ResponseKpisInnerFilingLink.ts +231 -0
- package/src/models/EarningsCallsExtractions200ResponseKpisInnerFilingLinkFactPeriod.ts +93 -0
- package/src/models/EarningsCallsGuidanceHistory200Response.ts +101 -0
- package/src/models/EarningsCallsGuidanceHistory200ResponseSeriesInner.ts +236 -0
- package/src/models/EarningsCallsGuidanceHistory200ResponseSeriesInnerChangeVsPrior.ts +84 -0
- package/src/models/EarningsCallsLive200Response.ts +83 -0
- package/src/models/EarningsCallsLive200ResponseEventsInner.ts +383 -0
- package/src/models/EarningsCallsLiveStream200Response.ts +161 -0
- package/src/models/EarningsCallsLiveStream200ResponseEvent.ts +93 -0
- package/src/models/EarningsCallsMetrics200Response.ts +191 -0
- package/src/models/EarningsCallsParticipants200Response.ts +99 -0
- package/src/models/EarningsCallsParticipants200ResponseParticipantsInner.ts +145 -0
- package/src/models/EarningsCallsParticipants200ResponseParticipantsInnerEvidenceInner.ts +75 -0
- package/src/models/EarningsCallsParticipants200ResponseParticipationEventsInner.ts +93 -0
- package/src/models/EarningsCallsPerson200Response.ts +161 -0
- package/src/models/EarningsCallsPerson200ResponseAppearancesInner.ts +174 -0
- package/src/models/EarningsCallsPressRelease200Response.ts +157 -0
- package/src/models/EarningsCallsPressRelease200ResponseParticipantsInner.ts +84 -0
- package/src/models/EarningsCallsPriceAttribution200Response.ts +218 -0
- package/src/models/EarningsCallsPriceAttribution200ResponseBucketsInner.ts +110 -0
- package/src/models/EarningsCallsPriceAttribution200ResponseBucketsInnerUtteranceRefsInner.ts +84 -0
- package/src/models/EarningsCallsPriceAttribution200ResponseTopMinutesInner.ts +92 -0
- package/src/models/EarningsCallsProsody200Response.ts +111 -0
- package/src/models/EarningsCallsProsody200ResponseSpeakersInner.ts +212 -0
- package/src/models/EarningsCallsProsody200ResponseSpeakersInnerSpeaker.ts +93 -0
- package/src/models/EarningsCallsQa200Response.ts +91 -0
- package/src/models/EarningsCallsQa200ResponsePairsInner.ts +177 -0
- package/src/models/EarningsCallsQa200ResponsePairsInnerAnalyst.ts +93 -0
- package/src/models/EarningsCallsQa200ResponsePairsInnerAnswersInner.ts +93 -0
- package/src/models/EarningsCallsQa200ResponsePairsInnerScores.ts +128 -0
- package/src/models/EarningsCallsQa200ResponsePairsInnerScoresEvidence.ts +84 -0
- package/src/models/EarningsCallsSearch200Response.ts +83 -0
- package/src/models/EarningsCallsSearch200ResponseHitsInner.ts +211 -0
- package/src/models/EarningsCallsSearch200ResponseHitsInnerSlide.ts +75 -0
- package/src/models/EarningsCallsSlides200Response.ts +106 -0
- package/src/models/EarningsCallsSlides200ResponseDeck.ts +125 -0
- package/src/models/EarningsCallsSlides200ResponseSlidesInner.ts +92 -0
- package/src/models/EarningsCallsTranscript200Response.ts +179 -0
- package/src/models/EarningsCallsTranscript404Response.ts +83 -0
- package/src/models/EarningsCallsTranscriptDiff200Response.ts +126 -0
- package/src/models/EarningsCallsTranscriptDiff200ResponseChangesInner.ts +95 -0
- package/src/models/EarningsCallsTranscriptDiff200ResponseStats.ts +75 -0
- package/src/models/EarningsCallsTranscriptVersions200Response.ts +92 -0
- package/src/models/EarningsCallsTranscriptVersions200ResponseVersionsInner.ts +123 -0
- package/src/models/EarningsCallsWebhooksCreate201Response.ts +185 -0
- package/src/models/EarningsCallsWebhooksCreateRequest.ts +91 -0
- package/src/models/EarningsCallsWebhooksCreateRequestFilters.ts +73 -0
- package/src/models/EarningsCallsWebhooksDeliveries200Response.ts +74 -0
- package/src/models/EarningsCallsWebhooksDeliveries200ResponseDataInner.ts +163 -0
- package/src/models/EarningsCallsWebhooksList200Response.ts +74 -0
- package/src/models/EarningsCallsWebhooksList200ResponseDataInner.ts +176 -0
- package/src/models/EarningsCallsWebhooksList200ResponseDataInnerFilters.ts +75 -0
- package/src/models/EarningsCallsWebhooksRotateSecret200Response.ts +75 -0
- package/src/models/EarningsCallsWebhooksTest202Response.ts +87 -0
- package/src/models/EarningsCallsWebhooksUpdateRequest.ts +89 -0
- package/src/models/FinancialMetricsRatios200Response.ts +74 -0
- package/src/models/FinancialMetricsRatios200ResponseCompaniesInner.ts +100 -0
- package/src/models/FinancialMetricsRatios200ResponseCompaniesInnerPeriodsInner.ts +133 -0
- package/src/models/ForbiddenError.ts +75 -0
- package/src/models/HealthGet200Response.ts +75 -0
- package/src/models/InsiderTradesList200Response.ts +100 -0
- package/src/models/InsiderTradesList200ResponseTransactionsInner.ts +233 -0
- package/src/models/InstitutionalOwnershipHoldingsByCompany200Response.ts +100 -0
- package/src/models/InstitutionalOwnershipHoldingsByInvestor200Response.ts +91 -0
- package/src/models/InstitutionalOwnershipHoldingsByInvestor200ResponseHoldingsInner.ts +228 -0
- package/src/models/InstitutionalOwnershipInstitutions200Response.ts +82 -0
- package/src/models/InstitutionalOwnershipInstitutions200ResponseInstitutionsInner.ts +129 -0
- package/src/models/InstitutionalOwnershipTransactions200Response.ts +82 -0
- package/src/models/InstitutionalOwnershipTransactions200ResponseTransactionsInner.ts +277 -0
- package/src/models/InternalServerError.ts +75 -0
- package/src/models/IposList200Response.ts +82 -0
- package/src/models/IposList200ResponseIposInner.ts +255 -0
- package/src/models/MarketHolidays200Response.ts +82 -0
- package/src/models/MarketHolidays200ResponseHolidaysInner.ts +93 -0
- package/src/models/MetadataAvailableMetrics200Response.ts +74 -0
- package/src/models/MetadataAvailableMetrics200ResponseMetricsInner.ts +75 -0
- package/src/models/MetadataAvailableSectionIds200Response.ts +74 -0
- package/src/models/MetadataAvailableSectionIds200ResponseFormTypesInner.ts +95 -0
- package/src/models/MetadataAvailableSectionIds200ResponseFormTypesInnerSectionsInner.ts +93 -0
- package/src/models/NotFoundError.ts +75 -0
- package/src/models/PresentationFact.ts +108 -0
- package/src/models/SecFilingsAvailableFormTypes200Response.ts +66 -0
- package/src/models/SecFilingsList200Response.ts +74 -0
- package/src/models/SecFilingsList200ResponseCompaniesInner.ts +100 -0
- package/src/models/SecFilingsList200ResponseCompaniesInnerFilingsInner.ts +147 -0
- package/src/models/SecFilingsSearch200Response.ts +83 -0
- package/src/models/SecFilingsSearch200ResponseSourcesInner.ts +111 -0
- package/src/models/SecFilingsSections200Response.ts +74 -0
- package/src/models/SecFilingsSections200ResponseCompaniesInner.ts +92 -0
- package/src/models/SecFilingsSections200ResponseCompaniesInnerSectionsInner.ts +192 -0
- package/src/models/SegmentedFinancials200Response.ts +74 -0
- package/src/models/SegmentedFinancials200ResponseCompaniesInner.ts +100 -0
- package/src/models/SegmentedFinancials200ResponseCompaniesInnerPeriodsInner.ts +141 -0
- package/src/models/SegmentedFinancials200ResponseCompaniesInnerPeriodsInnerFactsValueInner.ts +91 -0
- package/src/models/SegmentedFinancialsDetailed200Response.ts +74 -0
- package/src/models/SegmentedFinancialsDetailed200ResponseCompaniesInner.ts +100 -0
- package/src/models/SegmentedFinancialsDetailed200ResponseCompaniesInnerPeriodsInner.ts +141 -0
- package/src/models/SegmentedFinancialsDetailed200ResponseCompaniesInnerPeriodsInnerFactsValueInner.ts +139 -0
- package/src/models/ServiceUnavailableError.ts +75 -0
- package/src/models/StandardizedIncomeStatement200Response.ts +74 -0
- package/src/models/StandardizedIncomeStatement200ResponseCompaniesInner.ts +100 -0
- package/src/models/StandardizedIncomeStatement200ResponseCompaniesInnerPeriodsInner.ts +133 -0
- package/src/models/StandardizedIncomeStatementDetailed200Response.ts +74 -0
- package/src/models/StandardizedIncomeStatementDetailed200ResponseCompaniesInner.ts +100 -0
- package/src/models/StandardizedIncomeStatementDetailed200ResponseCompaniesInnerPeriodsInner.ts +141 -0
- package/src/models/StandardizedIncomeStatementDetailed200ResponseCompaniesInnerPeriodsInnerFactsValue.ts +106 -0
- package/src/models/StandardizedIncomeStatementDetailed200ResponseCompaniesInnerPeriodsInnerFactsValueFormula.ts +83 -0
- package/src/models/StandardizedIncomeStatementDetailed200ResponseCompaniesInnerPeriodsInnerFactsValueFormulaMembersInner.ts +76 -0
- package/src/models/StandardizedIncomeStatementDetailed200ResponseCompaniesInnerPeriodsInnerFactsValueFormulaMembersInnerOneOf.ts +136 -0
- package/src/models/StandardizedIncomeStatementDetailed200ResponseCompaniesInnerPeriodsInnerFactsValueFormulaMembersInnerOneOf1.ts +120 -0
- package/src/models/StandardizedIncomeStatementPresentation200Response.ts +74 -0
- package/src/models/StandardizedIncomeStatementPresentation200ResponseCompaniesInner.ts +100 -0
- package/src/models/StandardizedIncomeStatementPresentation200ResponseCompaniesInnerPeriodsInner.ts +141 -0
- package/src/models/StandardizedPresentationFact.ts +83 -0
- package/src/models/StandardizedSnapshot200Response.ts +74 -0
- package/src/models/StandardizedSnapshot200ResponseCompaniesInner.ts +159 -0
- package/src/models/StandardizedSnapshot200ResponseCompaniesInnerStatements.ts +92 -0
- package/src/models/StandardizedSnapshot200ResponseCompaniesInnerStatementsIncomeStatement.ts +65 -0
- package/src/models/StandardizedSnapshotDetailed200Response.ts +74 -0
- package/src/models/StandardizedSnapshotDetailed200ResponseCompaniesInner.ts +159 -0
- package/src/models/StandardizedSnapshotDetailed200ResponseCompaniesInnerStatements.ts +92 -0
- package/src/models/StandardizedSnapshotDetailed200ResponseCompaniesInnerStatementsIncomeStatement.ts +73 -0
- package/src/models/StandardizedSnapshotPresentation200Response.ts +74 -0
- package/src/models/StandardizedSnapshotPresentation200ResponseCompaniesInner.ts +159 -0
- package/src/models/StandardizedSnapshotPresentation200ResponseCompaniesInnerStatements.ts +92 -0
- package/src/models/StandardizedSnapshotPresentation200ResponseCompaniesInnerStatementsIncomeStatement.ts +73 -0
- package/src/models/StatusGet200Response.ts +99 -0
- package/src/models/StatusGet200ResponseServicesInner.ts +130 -0
- package/src/models/StatusGet200ResponseUniverse.ts +83 -0
- package/src/models/StatusGet200ResponseUniverseEarningsCalls.ts +75 -0
- package/src/models/StatusLicensing200Response.ts +173 -0
- package/src/models/StatusLicensing200ResponseFamiliesInner.ts +103 -0
- package/src/models/StatusLicensing200ResponseFamiliesInnerRoutesInner.ts +108 -0
- package/src/models/StatusLicensing200ResponseNotes.ts +111 -0
- package/src/models/StatusLicensing200ResponseTiers.ts +101 -0
- package/src/models/StatusLicensing200ResponseTiersFree.ts +111 -0
- package/src/models/UnauthorizedError.ts +75 -0
- package/src/models/WebSocketCallLifecycleEvent.ts +139 -0
- package/src/models/WebSocketErrorEvent.ts +120 -0
- package/src/models/WebSocketFiling.ts +147 -0
- package/src/models/WebSocketGapEvent.ts +114 -0
- package/src/models/WebSocketGuidanceFlashEvent.ts +231 -0
- package/src/models/WebSocketKeywordHitEvent.ts +231 -0
- package/src/models/WebSocketNewFilingEvent.ts +95 -0
- package/src/models/WebSocketPingEvent.ts +78 -0
- package/src/models/WebSocketPriceTickEvent.ts +249 -0
- package/src/models/WebSocketSpeakerNamesEvent.ts +122 -0
- package/src/models/WebSocketSpeakerNamesEventAssignmentsInner.ts +138 -0
- package/src/models/WebSocketSubscribeEarningsCall.ts +222 -0
- package/src/models/WebSocketSubscribedEvent.ts +177 -0
- package/src/models/WebSocketTranscriptSegmentEvent.ts +150 -0
- package/src/models/WebSocketUnsubscribe.ts +87 -0
- package/src/models/WebSocketUnsubscribedEvent.ts +109 -0
- package/src/models/WebSocketWarningEvent.ts +115 -0
- package/src/models/WebhookEnvelope.ts +114 -0
- package/src/models/index.ts +225 -0
- package/src/runtime.ts +449 -0
- package/tsconfig.esm.json +7 -0
- package/tsconfig.json +16 -0
|
@@ -0,0 +1,2960 @@
|
|
|
1
|
+
# EarningsCallsApi
|
|
2
|
+
|
|
3
|
+
All URIs are relative to *https://api.data.invinite.com*
|
|
4
|
+
|
|
5
|
+
| Method | HTTP request | Description |
|
|
6
|
+
|------------- | ------------- | -------------|
|
|
7
|
+
| [**earningsCallsAnalysts**](EarningsCallsApi.md#earningscallsanalysts) | **GET** /v1/earnings-calls/analysts | Analysts of a company |
|
|
8
|
+
| [**earningsCallsAudio**](EarningsCallsApi.md#earningscallsaudio) | **GET** /v1/earnings-calls/audio | Earnings call audio |
|
|
9
|
+
| [**earningsCallsCalendar**](EarningsCallsApi.md#earningscallscalendar) | **GET** /v1/earnings-calls/calendar | Earnings call calendar |
|
|
10
|
+
| [**earningsCallsCompanyDocument**](EarningsCallsApi.md#earningscallscompanydocument) | **GET** /v1/earnings-calls/company-documents/{document_id} | Company document by ID |
|
|
11
|
+
| [**earningsCallsCompanyDocuments**](EarningsCallsApi.md#earningscallscompanydocuments) | **GET** /v1/earnings-calls/company-documents | Company documents |
|
|
12
|
+
| [**earningsCallsDiff**](EarningsCallsApi.md#earningscallsdiff) | **GET** /v1/earnings-calls/diff | Call-over-call diff |
|
|
13
|
+
| [**earningsCallsDocumentSearch**](EarningsCallsApi.md#earningscallsdocumentsearch) | **GET** /v1/earnings-calls/documents/search | Search investor documents |
|
|
14
|
+
| [**earningsCallsDocuments**](EarningsCallsApi.md#earningscallsdocuments) | **GET** /v1/earnings-calls/documents | Earnings call documents |
|
|
15
|
+
| [**earningsCallsEvent**](EarningsCallsApi.md#earningscallsevent) | **GET** /v1/earnings-calls/event/{event_id} | Earnings call by ID |
|
|
16
|
+
| [**earningsCallsEvents**](EarningsCallsApi.md#earningscallsevents) | **GET** /v1/earnings-calls/events | Event history of a company |
|
|
17
|
+
| [**earningsCallsExtractions**](EarningsCallsApi.md#earningscallsextractions) | **GET** /v1/earnings-calls/extractions | Guidance and KPI extractions |
|
|
18
|
+
| [**earningsCallsGuidanceHistory**](EarningsCallsApi.md#earningscallsguidancehistory) | **GET** /v1/earnings-calls/guidance/history | Guidance history |
|
|
19
|
+
| [**earningsCallsLive**](EarningsCallsApi.md#earningscallslive) | **GET** /v1/earnings-calls/live | Live earnings calls |
|
|
20
|
+
| [**earningsCallsLiveStream**](EarningsCallsApi.md#earningscallslivestream) | **GET** /v1/earnings-calls/live/stream | Live audio stream URL |
|
|
21
|
+
| [**earningsCallsMetrics**](EarningsCallsApi.md#earningscallsmetrics) | **GET** /v1/earnings-calls/metrics | Earnings call metrics |
|
|
22
|
+
| [**earningsCallsParticipants**](EarningsCallsApi.md#earningscallsparticipants) | **GET** /v1/earnings-calls/participants | Earnings call participants |
|
|
23
|
+
| [**earningsCallsPerson**](EarningsCallsApi.md#earningscallsperson) | **GET** /v1/earnings-calls/people/{person_id} | Person across earnings calls |
|
|
24
|
+
| [**earningsCallsPressRelease**](EarningsCallsApi.md#earningscallspressrelease) | **GET** /v1/earnings-calls/press-release | Results press release |
|
|
25
|
+
| [**earningsCallsPriceAttribution**](EarningsCallsApi.md#earningscallspriceattribution) | **GET** /v1/earnings-calls/price-attribution | Price moves during a call |
|
|
26
|
+
| [**earningsCallsProsody**](EarningsCallsApi.md#earningscallsprosody) | **GET** /v1/earnings-calls/prosody | Speaker prosody |
|
|
27
|
+
| [**earningsCallsQa**](EarningsCallsApi.md#earningscallsqa) | **GET** /v1/earnings-calls/qa | Earnings call Q&A |
|
|
28
|
+
| [**earningsCallsSearch**](EarningsCallsApi.md#earningscallssearch) | **GET** /v1/earnings-calls/search | Search earnings calls |
|
|
29
|
+
| [**earningsCallsSlides**](EarningsCallsApi.md#earningscallsslides) | **GET** /v1/earnings-calls/slides | Earnings call slides |
|
|
30
|
+
| [**earningsCallsTranscript**](EarningsCallsApi.md#earningscallstranscript) | **GET** /v1/earnings-calls/transcript | Earnings call transcript |
|
|
31
|
+
| [**earningsCallsTranscriptDiff**](EarningsCallsApi.md#earningscallstranscriptdiff) | **GET** /v1/earnings-calls/transcript/diff | Transcript version diff |
|
|
32
|
+
| [**earningsCallsTranscriptVersions**](EarningsCallsApi.md#earningscallstranscriptversions) | **GET** /v1/earnings-calls/transcript/versions | Transcript versions |
|
|
33
|
+
| [**earningsCallsWebhooksCreate**](EarningsCallsApi.md#earningscallswebhookscreateoperation) | **POST** /v1/earnings-calls/webhooks | Create a webhook |
|
|
34
|
+
| [**earningsCallsWebhooksDelete**](EarningsCallsApi.md#earningscallswebhooksdelete) | **DELETE** /v1/earnings-calls/webhooks/{id} | Delete a webhook |
|
|
35
|
+
| [**earningsCallsWebhooksDeliveries**](EarningsCallsApi.md#earningscallswebhooksdeliveries) | **GET** /v1/earnings-calls/webhooks/{id}/deliveries | Webhook delivery attempts |
|
|
36
|
+
| [**earningsCallsWebhooksList**](EarningsCallsApi.md#earningscallswebhookslist) | **GET** /v1/earnings-calls/webhooks | List webhooks |
|
|
37
|
+
| [**earningsCallsWebhooksRotateSecret**](EarningsCallsApi.md#earningscallswebhooksrotatesecret) | **POST** /v1/earnings-calls/webhooks/{id}/rotate-secret | Rotate a webhook signing secret |
|
|
38
|
+
| [**earningsCallsWebhooksTest**](EarningsCallsApi.md#earningscallswebhookstest) | **POST** /v1/earnings-calls/webhooks/{id}/test | Send a test delivery |
|
|
39
|
+
| [**earningsCallsWebhooksUpdate**](EarningsCallsApi.md#earningscallswebhooksupdateoperation) | **PATCH** /v1/earnings-calls/webhooks/{id} | Update a webhook |
|
|
40
|
+
|
|
41
|
+
|
|
42
|
+
|
|
43
|
+
## earningsCallsAnalysts
|
|
44
|
+
|
|
45
|
+
> EarningsCallsAnalysts200Response earningsCallsAnalysts(identifier, limit, offset)
|
|
46
|
+
|
|
47
|
+
Analysts of a company
|
|
48
|
+
|
|
49
|
+
Sell-side analysts who asked questions on one US company\'s earnings calls, with appearance and question counts and the mean difficulty of their scored questions (a descriptive feature, not a rating). An out-of-scope company answers an empty list. ### Freshness and coverage - Data is replicated from the capture pipeline with a lag of about a minute. - Only US earnings calls captured by Invinite are served. Minimum tier for rag: STANDARD.
|
|
50
|
+
|
|
51
|
+
### Example
|
|
52
|
+
|
|
53
|
+
```ts
|
|
54
|
+
import {
|
|
55
|
+
Configuration,
|
|
56
|
+
EarningsCallsApi,
|
|
57
|
+
} from '@invinite-org/data-api-client';
|
|
58
|
+
import type { EarningsCallsAnalystsRequest } from '@invinite-org/data-api-client';
|
|
59
|
+
|
|
60
|
+
async function example() {
|
|
61
|
+
console.log("🚀 Testing @invinite-org/data-api-client SDK...");
|
|
62
|
+
const config = new Configuration({
|
|
63
|
+
// Configure HTTP bearer authorization: bearerAuth
|
|
64
|
+
accessToken: "YOUR BEARER TOKEN",
|
|
65
|
+
});
|
|
66
|
+
const api = new EarningsCallsApi(config);
|
|
67
|
+
|
|
68
|
+
const body = {
|
|
69
|
+
// string | Company ticker symbol or CIK (US companies only)
|
|
70
|
+
identifier: identifier_example,
|
|
71
|
+
// number | Maximum number of analysts to return (optional)
|
|
72
|
+
limit: 56,
|
|
73
|
+
// number | Number of analysts to skip for pagination (optional)
|
|
74
|
+
offset: 56,
|
|
75
|
+
} satisfies EarningsCallsAnalystsRequest;
|
|
76
|
+
|
|
77
|
+
try {
|
|
78
|
+
const data = await api.earningsCallsAnalysts(body);
|
|
79
|
+
console.log(data);
|
|
80
|
+
} catch (error) {
|
|
81
|
+
console.error(error);
|
|
82
|
+
}
|
|
83
|
+
}
|
|
84
|
+
|
|
85
|
+
// Run the test
|
|
86
|
+
example().catch(console.error);
|
|
87
|
+
```
|
|
88
|
+
|
|
89
|
+
### Parameters
|
|
90
|
+
|
|
91
|
+
|
|
92
|
+
| Name | Type | Description | Notes |
|
|
93
|
+
|------------- | ------------- | ------------- | -------------|
|
|
94
|
+
| **identifier** | `string` | Company ticker symbol or CIK (US companies only) | [Defaults to `undefined`] |
|
|
95
|
+
| **limit** | `number` | Maximum number of analysts to return | [Optional] [Defaults to `25`] |
|
|
96
|
+
| **offset** | `number` | Number of analysts to skip for pagination | [Optional] [Defaults to `0`] |
|
|
97
|
+
|
|
98
|
+
### Return type
|
|
99
|
+
|
|
100
|
+
[**EarningsCallsAnalysts200Response**](EarningsCallsAnalysts200Response.md)
|
|
101
|
+
|
|
102
|
+
### Authorization
|
|
103
|
+
|
|
104
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
105
|
+
|
|
106
|
+
### HTTP request headers
|
|
107
|
+
|
|
108
|
+
- **Content-Type**: Not defined
|
|
109
|
+
- **Accept**: `application/json`
|
|
110
|
+
|
|
111
|
+
|
|
112
|
+
### HTTP response details
|
|
113
|
+
| Status code | Description | Response headers |
|
|
114
|
+
|-------------|-------------|------------------|
|
|
115
|
+
| **200** | Default Response | - |
|
|
116
|
+
| **400** | Bad Request - Invalid request parameters | - |
|
|
117
|
+
| **401** | Unauthorized - Missing or invalid API key | - |
|
|
118
|
+
| **404** | Not Found - Resource not found | - |
|
|
119
|
+
| **500** | Internal Server Error - Server error occurred | - |
|
|
120
|
+
|
|
121
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
122
|
+
|
|
123
|
+
|
|
124
|
+
## earningsCallsAudio
|
|
125
|
+
|
|
126
|
+
> EarningsCallsAudio200Response earningsCallsAudio(eventId, identifier, year, quarter, date, eventType)
|
|
127
|
+
|
|
128
|
+
Earnings call audio
|
|
129
|
+
|
|
130
|
+
The recording of one earnings call as a signed download URL (PRO). Audio files are forensically watermarked per customer: every account gets its own copy. ### Getting the file - An account\'s first request for a call answers `202` `{ status: \"preparing\", retry_after_seconds }` with `Retry-After` while that copy is prepared (not billed). Repeat the request after it. - Files are served as short-lived signed URLs (see `expires_at`), never proxied; request a fresh response after expiry. ### Errors - `403 audio_unavailable` when the company\'s audio is not licensed for delivery or no recording exists (one answer for both). - `429 audio_quota_exceeded` when the account requested too many new audio files today. - `503 audio_temporarily_unavailable` while audio cannot be prepared. - `503 media_unavailable` while media signing is not configured. ### Choose the call - By `event_id`, or - by `identifier` with `year` + `quarter` (fiscal), or - by `identifier` with `date` (a calendar day in New York time (America/New_York); a call without a confirmed time is listed on its announced date). With `date`, `event_type` (default `earnings_call`) also addresses an investor day, conference or shareholder meeting. ### Freshness and coverage - Data is replicated from the capture pipeline with a lag of about a minute. - Only US earnings calls captured by Invinite are served. Minimum tier for display: FREE.
|
|
131
|
+
|
|
132
|
+
### Example
|
|
133
|
+
|
|
134
|
+
```ts
|
|
135
|
+
import {
|
|
136
|
+
Configuration,
|
|
137
|
+
EarningsCallsApi,
|
|
138
|
+
} from '@invinite-org/data-api-client';
|
|
139
|
+
import type { EarningsCallsAudioRequest } from '@invinite-org/data-api-client';
|
|
140
|
+
|
|
141
|
+
async function example() {
|
|
142
|
+
console.log("🚀 Testing @invinite-org/data-api-client SDK...");
|
|
143
|
+
const config = new Configuration({
|
|
144
|
+
// Configure HTTP bearer authorization: bearerAuth
|
|
145
|
+
accessToken: "YOUR BEARER TOKEN",
|
|
146
|
+
});
|
|
147
|
+
const api = new EarningsCallsApi(config);
|
|
148
|
+
|
|
149
|
+
const body = {
|
|
150
|
+
// string | Event identifier (event_id of any earnings-calls response); wins over the other selectors (optional)
|
|
151
|
+
eventId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
|
|
152
|
+
// string | Company ticker symbol or CIK (US companies only), with year+quarter or date (optional)
|
|
153
|
+
identifier: identifier_example,
|
|
154
|
+
// number | Fiscal year of the call (with quarter) (optional)
|
|
155
|
+
year: 56,
|
|
156
|
+
// number | Fiscal quarter of the call (with year) (optional)
|
|
157
|
+
quarter: 56,
|
|
158
|
+
// Date | Day of the call (YYYY-MM-DD): a calendar day in New York time (America/New_York); a call without a confirmed time is listed on its announced date (optional)
|
|
159
|
+
date: 2013-10-20,
|
|
160
|
+
// 'earnings_call' | 'investor_day' | 'conference' | 'agm' | 'other' | Event type the date selector matches (default earnings_call): investor_day, conference, agm or other address a non-earnings event by its date; year+quarter select earnings calls only (optional)
|
|
161
|
+
eventType: eventType_example,
|
|
162
|
+
} satisfies EarningsCallsAudioRequest;
|
|
163
|
+
|
|
164
|
+
try {
|
|
165
|
+
const data = await api.earningsCallsAudio(body);
|
|
166
|
+
console.log(data);
|
|
167
|
+
} catch (error) {
|
|
168
|
+
console.error(error);
|
|
169
|
+
}
|
|
170
|
+
}
|
|
171
|
+
|
|
172
|
+
// Run the test
|
|
173
|
+
example().catch(console.error);
|
|
174
|
+
```
|
|
175
|
+
|
|
176
|
+
### Parameters
|
|
177
|
+
|
|
178
|
+
|
|
179
|
+
| Name | Type | Description | Notes |
|
|
180
|
+
|------------- | ------------- | ------------- | -------------|
|
|
181
|
+
| **eventId** | `string` | Event identifier (event_id of any earnings-calls response); wins over the other selectors | [Optional] [Defaults to `undefined`] |
|
|
182
|
+
| **identifier** | `string` | Company ticker symbol or CIK (US companies only), with year+quarter or date | [Optional] [Defaults to `undefined`] |
|
|
183
|
+
| **year** | `number` | Fiscal year of the call (with quarter) | [Optional] [Defaults to `undefined`] |
|
|
184
|
+
| **quarter** | `number` | Fiscal quarter of the call (with year) | [Optional] [Defaults to `undefined`] |
|
|
185
|
+
| **date** | `Date` | Day of the call (YYYY-MM-DD): a calendar day in New York time (America/New_York); a call without a confirmed time is listed on its announced date | [Optional] [Defaults to `undefined`] |
|
|
186
|
+
| **eventType** | `earnings_call`, `investor_day`, `conference`, `agm`, `other` | Event type the date selector matches (default earnings_call): investor_day, conference, agm or other address a non-earnings event by its date; year+quarter select earnings calls only | [Optional] [Defaults to `undefined`] [Enum: earnings_call, investor_day, conference, agm, other] |
|
|
187
|
+
|
|
188
|
+
### Return type
|
|
189
|
+
|
|
190
|
+
[**EarningsCallsAudio200Response**](EarningsCallsAudio200Response.md)
|
|
191
|
+
|
|
192
|
+
### Authorization
|
|
193
|
+
|
|
194
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
195
|
+
|
|
196
|
+
### HTTP request headers
|
|
197
|
+
|
|
198
|
+
- **Content-Type**: Not defined
|
|
199
|
+
- **Accept**: `application/json`
|
|
200
|
+
|
|
201
|
+
|
|
202
|
+
### HTTP response details
|
|
203
|
+
| Status code | Description | Response headers |
|
|
204
|
+
|-------------|-------------|------------------|
|
|
205
|
+
| **200** | Default Response | - |
|
|
206
|
+
| **202** | The calling account\'s watermarked copy is being prepared; repeat the request after Retry-After (not billed) | - |
|
|
207
|
+
| **400** | Bad Request - Invalid request parameters | - |
|
|
208
|
+
| **401** | Unauthorized - Missing or invalid API key | - |
|
|
209
|
+
| **403** | Forbidden - Not available under the current licence | - |
|
|
210
|
+
| **404** | Not Found - Resource not found | - |
|
|
211
|
+
| **429** | Too many new audio files for this account (daily quota of new watermarked copies) | - |
|
|
212
|
+
| **500** | Internal Server Error - Server error occurred | - |
|
|
213
|
+
| **503** | Service Unavailable - Temporarily unavailable or switched off | - |
|
|
214
|
+
|
|
215
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
216
|
+
|
|
217
|
+
|
|
218
|
+
## earningsCallsCalendar
|
|
219
|
+
|
|
220
|
+
> EarningsCallsCalendar200Response earningsCallsCalendar(from, to, status, session, exchange, eventType, sort, limit, offset)
|
|
221
|
+
|
|
222
|
+
Earnings call calendar
|
|
223
|
+
|
|
224
|
+
Upcoming and past earnings calls of all covered US companies in a window of days (default today + 14 days, at most 92). Each day is a calendar day in New York time (America/New_York); a call without a confirmed time is listed on its announced date. `event_type=all` returns every event type. ### Freshness and coverage - Data is replicated from the capture pipeline with a lag of about a minute. - Only US earnings calls captured by Invinite are served. Minimum tier for display: FREE.
|
|
225
|
+
|
|
226
|
+
### Example
|
|
227
|
+
|
|
228
|
+
```ts
|
|
229
|
+
import {
|
|
230
|
+
Configuration,
|
|
231
|
+
EarningsCallsApi,
|
|
232
|
+
} from '@invinite-org/data-api-client';
|
|
233
|
+
import type { EarningsCallsCalendarRequest } from '@invinite-org/data-api-client';
|
|
234
|
+
|
|
235
|
+
async function example() {
|
|
236
|
+
console.log("🚀 Testing @invinite-org/data-api-client SDK...");
|
|
237
|
+
const config = new Configuration({
|
|
238
|
+
// Configure HTTP bearer authorization: bearerAuth
|
|
239
|
+
accessToken: "YOUR BEARER TOKEN",
|
|
240
|
+
});
|
|
241
|
+
const api = new EarningsCallsApi(config);
|
|
242
|
+
|
|
243
|
+
const body = {
|
|
244
|
+
// Date | First day (YYYY-MM-DD): a calendar day in New York time (America/New_York); a call without a confirmed time is listed on its announced date. Default: today (optional)
|
|
245
|
+
from: 2013-10-20,
|
|
246
|
+
// Date | Last day (YYYY-MM-DD), at most 92 days after `from`: a calendar day in New York time (America/New_York); a call without a confirmed time is listed on its announced date. Default: `from` + 14 days (optional)
|
|
247
|
+
to: 2013-10-20,
|
|
248
|
+
// Array<'estimated' | 'unconfirmed' | 'confirmed' | 'postponed' | 'cancelled'> | Filter by date status (repeatable). Default: every status except `cancelled` (optional)
|
|
249
|
+
status: ...,
|
|
250
|
+
// 'bmo' | 'amc' | 'intraday' | Filter by market session (optional)
|
|
251
|
+
session: session_example,
|
|
252
|
+
// string | Filter by listing exchange (e.g. NASDAQ, NYSE) (optional)
|
|
253
|
+
exchange: exchange_example,
|
|
254
|
+
// string | Event types as a comma list (e.g. `investor_day,conference`) of earnings_call, investor_day, conference, agm, other; `all` = every event type (optional)
|
|
255
|
+
eventType: eventType_example,
|
|
256
|
+
// 'asc' | 'desc' | Sort direction by scheduled start (optional)
|
|
257
|
+
sort: sort_example,
|
|
258
|
+
// number | Maximum number of events to return (optional)
|
|
259
|
+
limit: 56,
|
|
260
|
+
// number | Number of events to skip for pagination (optional)
|
|
261
|
+
offset: 56,
|
|
262
|
+
} satisfies EarningsCallsCalendarRequest;
|
|
263
|
+
|
|
264
|
+
try {
|
|
265
|
+
const data = await api.earningsCallsCalendar(body);
|
|
266
|
+
console.log(data);
|
|
267
|
+
} catch (error) {
|
|
268
|
+
console.error(error);
|
|
269
|
+
}
|
|
270
|
+
}
|
|
271
|
+
|
|
272
|
+
// Run the test
|
|
273
|
+
example().catch(console.error);
|
|
274
|
+
```
|
|
275
|
+
|
|
276
|
+
### Parameters
|
|
277
|
+
|
|
278
|
+
|
|
279
|
+
| Name | Type | Description | Notes |
|
|
280
|
+
|------------- | ------------- | ------------- | -------------|
|
|
281
|
+
| **from** | `Date` | First day (YYYY-MM-DD): a calendar day in New York time (America/New_York); a call without a confirmed time is listed on its announced date. Default: today | [Optional] [Defaults to `undefined`] |
|
|
282
|
+
| **to** | `Date` | Last day (YYYY-MM-DD), at most 92 days after `from`: a calendar day in New York time (America/New_York); a call without a confirmed time is listed on its announced date. Default: `from` + 14 days | [Optional] [Defaults to `undefined`] |
|
|
283
|
+
| **status** | `estimated`, `unconfirmed`, `confirmed`, `postponed`, `cancelled` | Filter by date status (repeatable). Default: every status except `cancelled` | [Optional] [Enum: estimated, unconfirmed, confirmed, postponed, cancelled] |
|
|
284
|
+
| **session** | `bmo`, `amc`, `intraday` | Filter by market session | [Optional] [Defaults to `undefined`] [Enum: bmo, amc, intraday] |
|
|
285
|
+
| **exchange** | `string` | Filter by listing exchange (e.g. NASDAQ, NYSE) | [Optional] [Defaults to `undefined`] |
|
|
286
|
+
| **eventType** | `string` | Event types as a comma list (e.g. `investor_day,conference`) of earnings_call, investor_day, conference, agm, other; `all` = every event type | [Optional] [Defaults to `'earnings_call'`] |
|
|
287
|
+
| **sort** | `asc`, `desc` | Sort direction by scheduled start | [Optional] [Defaults to `'asc'`] [Enum: asc, desc] |
|
|
288
|
+
| **limit** | `number` | Maximum number of events to return | [Optional] [Defaults to `100`] |
|
|
289
|
+
| **offset** | `number` | Number of events to skip for pagination | [Optional] [Defaults to `0`] |
|
|
290
|
+
|
|
291
|
+
### Return type
|
|
292
|
+
|
|
293
|
+
[**EarningsCallsCalendar200Response**](EarningsCallsCalendar200Response.md)
|
|
294
|
+
|
|
295
|
+
### Authorization
|
|
296
|
+
|
|
297
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
298
|
+
|
|
299
|
+
### HTTP request headers
|
|
300
|
+
|
|
301
|
+
- **Content-Type**: Not defined
|
|
302
|
+
- **Accept**: `application/json`
|
|
303
|
+
|
|
304
|
+
|
|
305
|
+
### HTTP response details
|
|
306
|
+
| Status code | Description | Response headers |
|
|
307
|
+
|-------------|-------------|------------------|
|
|
308
|
+
| **200** | Default Response | - |
|
|
309
|
+
| **400** | Bad Request - Invalid request parameters | - |
|
|
310
|
+
| **401** | Unauthorized - Missing or invalid API key | - |
|
|
311
|
+
| **404** | Not Found - Resource not found | - |
|
|
312
|
+
| **500** | Internal Server Error - Server error occurred | - |
|
|
313
|
+
|
|
314
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
315
|
+
|
|
316
|
+
|
|
317
|
+
## earningsCallsCompanyDocument
|
|
318
|
+
|
|
319
|
+
> EarningsCallsCompanyDocument200Response earningsCallsCompanyDocument(documentId, include)
|
|
320
|
+
|
|
321
|
+
Company document by ID
|
|
322
|
+
|
|
323
|
+
One company document by `document_id` (from `/v1/earnings-calls/company-documents` or a document search hit with `table` `company_documents`): signed URLs of the file and its per-page text. ### What you get - `include=pages` returns the per-page text inline when it is at most 2 MB (else only `pages_url`). - Company-published material, not verified facts. - Files are served as short-lived signed URLs (see `expires_at`), never proxied; request a fresh response after expiry. ### Errors - `503 media_unavailable` while media signing is not configured. ### Freshness and coverage - Data is replicated from the capture pipeline with a lag of about a minute. - Only US earnings calls captured by Invinite are served. Minimum tier for display: FREE.
|
|
324
|
+
|
|
325
|
+
### Example
|
|
326
|
+
|
|
327
|
+
```ts
|
|
328
|
+
import {
|
|
329
|
+
Configuration,
|
|
330
|
+
EarningsCallsApi,
|
|
331
|
+
} from '@invinite-org/data-api-client';
|
|
332
|
+
import type { EarningsCallsCompanyDocumentRequest } from '@invinite-org/data-api-client';
|
|
333
|
+
|
|
334
|
+
async function example() {
|
|
335
|
+
console.log("🚀 Testing @invinite-org/data-api-client SDK...");
|
|
336
|
+
const config = new Configuration({
|
|
337
|
+
// Configure HTTP bearer authorization: bearerAuth
|
|
338
|
+
accessToken: "YOUR BEARER TOKEN",
|
|
339
|
+
});
|
|
340
|
+
const api = new EarningsCallsApi(config);
|
|
341
|
+
|
|
342
|
+
const body = {
|
|
343
|
+
// string | document_id of a company-documents response
|
|
344
|
+
documentId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
|
|
345
|
+
// Array<string> | Extra data: `pages` = the per-page text inline (files ≤ 2 MB; else use pages_url) (optional)
|
|
346
|
+
include: ...,
|
|
347
|
+
} satisfies EarningsCallsCompanyDocumentRequest;
|
|
348
|
+
|
|
349
|
+
try {
|
|
350
|
+
const data = await api.earningsCallsCompanyDocument(body);
|
|
351
|
+
console.log(data);
|
|
352
|
+
} catch (error) {
|
|
353
|
+
console.error(error);
|
|
354
|
+
}
|
|
355
|
+
}
|
|
356
|
+
|
|
357
|
+
// Run the test
|
|
358
|
+
example().catch(console.error);
|
|
359
|
+
```
|
|
360
|
+
|
|
361
|
+
### Parameters
|
|
362
|
+
|
|
363
|
+
|
|
364
|
+
| Name | Type | Description | Notes |
|
|
365
|
+
|------------- | ------------- | ------------- | -------------|
|
|
366
|
+
| **documentId** | `string` | document_id of a company-documents response | [Defaults to `undefined`] |
|
|
367
|
+
| **include** | `Array<string>` | Extra data: `pages` = the per-page text inline (files ≤ 2 MB; else use pages_url) | [Optional] |
|
|
368
|
+
|
|
369
|
+
### Return type
|
|
370
|
+
|
|
371
|
+
[**EarningsCallsCompanyDocument200Response**](EarningsCallsCompanyDocument200Response.md)
|
|
372
|
+
|
|
373
|
+
### Authorization
|
|
374
|
+
|
|
375
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
376
|
+
|
|
377
|
+
### HTTP request headers
|
|
378
|
+
|
|
379
|
+
- **Content-Type**: Not defined
|
|
380
|
+
- **Accept**: `application/json`
|
|
381
|
+
|
|
382
|
+
|
|
383
|
+
### HTTP response details
|
|
384
|
+
| Status code | Description | Response headers |
|
|
385
|
+
|-------------|-------------|------------------|
|
|
386
|
+
| **200** | Default Response | - |
|
|
387
|
+
| **400** | Bad Request - Invalid request parameters | - |
|
|
388
|
+
| **401** | Unauthorized - Missing or invalid API key | - |
|
|
389
|
+
| **404** | Not Found - Resource not found | - |
|
|
390
|
+
| **500** | Internal Server Error - Server error occurred | - |
|
|
391
|
+
| **503** | Service Unavailable - Temporarily unavailable or switched off | - |
|
|
392
|
+
|
|
393
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
394
|
+
|
|
395
|
+
|
|
396
|
+
## earningsCallsCompanyDocuments
|
|
397
|
+
|
|
398
|
+
> EarningsCallsCompanyDocuments200Response earningsCallsCompanyDocuments(identifier, section, kind, year, period, eventId, limit, offset)
|
|
399
|
+
|
|
400
|
+
Company documents
|
|
401
|
+
|
|
402
|
+
A company\'s investor-relations documents outside its earnings calls\' folders, newest year first: annual reports, proxy statements, ESG / governance documents, investor-day and conference decks, shareholder letters, fact sheets, and link-only webcast replay pages. Filter by IR section, kind, year, period or event. Documents of one earnings call are on `/v1/earnings-calls/documents`. ### What you get - Company-published material: displayed as published, not verified facts. - Stored files come as signed URLs; `pages_url` is the per-page text (JSON). A link-only row (webcast) has `url` null and `link_status`. - Files are served as short-lived signed URLs (see `expires_at`), never proxied; request a fresh response after expiry. ### Errors - `503 media_unavailable` while media signing is not configured. ### Freshness and coverage - Data is replicated from the capture pipeline with a lag of about a minute. - Only US earnings calls captured by Invinite are served. Minimum tier for display: FREE.
|
|
403
|
+
|
|
404
|
+
### Example
|
|
405
|
+
|
|
406
|
+
```ts
|
|
407
|
+
import {
|
|
408
|
+
Configuration,
|
|
409
|
+
EarningsCallsApi,
|
|
410
|
+
} from '@invinite-org/data-api-client';
|
|
411
|
+
import type { EarningsCallsCompanyDocumentsRequest } from '@invinite-org/data-api-client';
|
|
412
|
+
|
|
413
|
+
async function example() {
|
|
414
|
+
console.log("🚀 Testing @invinite-org/data-api-client SDK...");
|
|
415
|
+
const config = new Configuration({
|
|
416
|
+
// Configure HTTP bearer authorization: bearerAuth
|
|
417
|
+
accessToken: "YOUR BEARER TOKEN",
|
|
418
|
+
});
|
|
419
|
+
const api = new EarningsCallsApi(config);
|
|
420
|
+
|
|
421
|
+
const body = {
|
|
422
|
+
// string | Company ticker symbol or CIK (US companies only)
|
|
423
|
+
identifier: identifier_example,
|
|
424
|
+
// Array<string> | Only these IR site sections, comma-separated or repeated: quarterly_results, events_archive, presentations_archive, annual_reports, proxy, sec_filings, press_releases, esg, governance, faq, other (optional)
|
|
425
|
+
section: ...,
|
|
426
|
+
// Array<string> | Only these document kinds, comma-separated or repeated: annual_report, ceo_letter, proxy_statement, proxy_supplement, esg_report, conference_presentation, investor_day_deck, earnings_deck, fact_sheet, financial_data, shareholder_letter, company_transcript, cfo_commentary, governance, press_release, infographic, webcast, other, prepared_remarks (optional)
|
|
427
|
+
kind: ...,
|
|
428
|
+
// number | Year the document belongs to (optional)
|
|
429
|
+
year: 56,
|
|
430
|
+
// 'Q1' | 'Q2' | 'Q3' | 'Q4' | 'H1' | 'H2' | 'FY' | Period within the year (optional)
|
|
431
|
+
period: period_example,
|
|
432
|
+
// string | Only documents of this event (an investor day, a conference, a shareholder meeting) (optional)
|
|
433
|
+
eventId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
|
|
434
|
+
// number | Maximum number of documents to return (optional)
|
|
435
|
+
limit: 56,
|
|
436
|
+
// number | Number of documents to skip for pagination (optional)
|
|
437
|
+
offset: 56,
|
|
438
|
+
} satisfies EarningsCallsCompanyDocumentsRequest;
|
|
439
|
+
|
|
440
|
+
try {
|
|
441
|
+
const data = await api.earningsCallsCompanyDocuments(body);
|
|
442
|
+
console.log(data);
|
|
443
|
+
} catch (error) {
|
|
444
|
+
console.error(error);
|
|
445
|
+
}
|
|
446
|
+
}
|
|
447
|
+
|
|
448
|
+
// Run the test
|
|
449
|
+
example().catch(console.error);
|
|
450
|
+
```
|
|
451
|
+
|
|
452
|
+
### Parameters
|
|
453
|
+
|
|
454
|
+
|
|
455
|
+
| Name | Type | Description | Notes |
|
|
456
|
+
|------------- | ------------- | ------------- | -------------|
|
|
457
|
+
| **identifier** | `string` | Company ticker symbol or CIK (US companies only) | [Defaults to `undefined`] |
|
|
458
|
+
| **section** | `Array<string>` | Only these IR site sections, comma-separated or repeated: quarterly_results, events_archive, presentations_archive, annual_reports, proxy, sec_filings, press_releases, esg, governance, faq, other | [Optional] |
|
|
459
|
+
| **kind** | `Array<string>` | Only these document kinds, comma-separated or repeated: annual_report, ceo_letter, proxy_statement, proxy_supplement, esg_report, conference_presentation, investor_day_deck, earnings_deck, fact_sheet, financial_data, shareholder_letter, company_transcript, cfo_commentary, governance, press_release, infographic, webcast, other, prepared_remarks | [Optional] |
|
|
460
|
+
| **year** | `number` | Year the document belongs to | [Optional] [Defaults to `undefined`] |
|
|
461
|
+
| **period** | `Q1`, `Q2`, `Q3`, `Q4`, `H1`, `H2`, `FY` | Period within the year | [Optional] [Defaults to `undefined`] [Enum: Q1, Q2, Q3, Q4, H1, H2, FY] |
|
|
462
|
+
| **eventId** | `string` | Only documents of this event (an investor day, a conference, a shareholder meeting) | [Optional] [Defaults to `undefined`] |
|
|
463
|
+
| **limit** | `number` | Maximum number of documents to return | [Optional] [Defaults to `50`] |
|
|
464
|
+
| **offset** | `number` | Number of documents to skip for pagination | [Optional] [Defaults to `0`] |
|
|
465
|
+
|
|
466
|
+
### Return type
|
|
467
|
+
|
|
468
|
+
[**EarningsCallsCompanyDocuments200Response**](EarningsCallsCompanyDocuments200Response.md)
|
|
469
|
+
|
|
470
|
+
### Authorization
|
|
471
|
+
|
|
472
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
473
|
+
|
|
474
|
+
### HTTP request headers
|
|
475
|
+
|
|
476
|
+
- **Content-Type**: Not defined
|
|
477
|
+
- **Accept**: `application/json`
|
|
478
|
+
|
|
479
|
+
|
|
480
|
+
### HTTP response details
|
|
481
|
+
| Status code | Description | Response headers |
|
|
482
|
+
|-------------|-------------|------------------|
|
|
483
|
+
| **200** | Default Response | - |
|
|
484
|
+
| **400** | Bad Request - Invalid request parameters | - |
|
|
485
|
+
| **401** | Unauthorized - Missing or invalid API key | - |
|
|
486
|
+
| **404** | Not Found - Resource not found | - |
|
|
487
|
+
| **500** | Internal Server Error - Server error occurred | - |
|
|
488
|
+
| **503** | Service Unavailable - Temporarily unavailable or switched off | - |
|
|
489
|
+
|
|
490
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
491
|
+
|
|
492
|
+
|
|
493
|
+
## earningsCallsDiff
|
|
494
|
+
|
|
495
|
+
> EarningsCallsDiff200Response earningsCallsDiff(eventId, identifier, year, quarter, date, eventType, vs)
|
|
496
|
+
|
|
497
|
+
Call-over-call diff
|
|
498
|
+
|
|
499
|
+
How one earnings call differs from the company\'s prior call: semantic similarity, new and dropped topics with verbatim evidence, hedging / uncertainty / numeric-specificity levels and their change, tone shift and the slide-deck diff. ### Reading the signals - Levels (hedging, uncertainty, numeric specificity) are the better-supported signal; the literature finds the *change* from the prior call is a weaker predictor. Both are provided; do not over-weight the change. ### Choose the call - By `event_id`, or - by `identifier` alone (latest call with a diff), or - by `identifier` with `year` + `quarter` or `date`. ### Errors - `404 diff_unavailable` for a company\'s first call or a call not derived yet. ### Freshness and coverage - Data is replicated from the capture pipeline with a lag of about a minute. - Only US earnings calls captured by Invinite are served. Minimum tier for display: FREE.
|
|
500
|
+
|
|
501
|
+
### Example
|
|
502
|
+
|
|
503
|
+
```ts
|
|
504
|
+
import {
|
|
505
|
+
Configuration,
|
|
506
|
+
EarningsCallsApi,
|
|
507
|
+
} from '@invinite-org/data-api-client';
|
|
508
|
+
import type { EarningsCallsDiffRequest } from '@invinite-org/data-api-client';
|
|
509
|
+
|
|
510
|
+
async function example() {
|
|
511
|
+
console.log("🚀 Testing @invinite-org/data-api-client SDK...");
|
|
512
|
+
const config = new Configuration({
|
|
513
|
+
// Configure HTTP bearer authorization: bearerAuth
|
|
514
|
+
accessToken: "YOUR BEARER TOKEN",
|
|
515
|
+
});
|
|
516
|
+
const api = new EarningsCallsApi(config);
|
|
517
|
+
|
|
518
|
+
const body = {
|
|
519
|
+
// string | Event identifier (event_id of any earnings-calls response); wins over the other selectors (optional)
|
|
520
|
+
eventId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
|
|
521
|
+
// string | Company ticker symbol or CIK (US companies only); alone = the latest call with a diff, else with year+quarter or date (optional)
|
|
522
|
+
identifier: identifier_example,
|
|
523
|
+
// number | Fiscal year of the call (with quarter) (optional)
|
|
524
|
+
year: 56,
|
|
525
|
+
// number | Fiscal quarter of the call (with year) (optional)
|
|
526
|
+
quarter: 56,
|
|
527
|
+
// Date | Day of the call (YYYY-MM-DD): a calendar day in New York time (America/New_York); a call without a confirmed time is listed on its announced date (optional)
|
|
528
|
+
date: 2013-10-20,
|
|
529
|
+
// 'earnings_call' | 'investor_day' | 'conference' | 'agm' | 'other' | Event type the date selector matches (default earnings_call): investor_day, conference, agm or other address a non-earnings event by its date; year+quarter select earnings calls only (optional)
|
|
530
|
+
eventType: eventType_example,
|
|
531
|
+
// 'prior' | Comparison base: the company\'s prior call (optional)
|
|
532
|
+
vs: vs_example,
|
|
533
|
+
} satisfies EarningsCallsDiffRequest;
|
|
534
|
+
|
|
535
|
+
try {
|
|
536
|
+
const data = await api.earningsCallsDiff(body);
|
|
537
|
+
console.log(data);
|
|
538
|
+
} catch (error) {
|
|
539
|
+
console.error(error);
|
|
540
|
+
}
|
|
541
|
+
}
|
|
542
|
+
|
|
543
|
+
// Run the test
|
|
544
|
+
example().catch(console.error);
|
|
545
|
+
```
|
|
546
|
+
|
|
547
|
+
### Parameters
|
|
548
|
+
|
|
549
|
+
|
|
550
|
+
| Name | Type | Description | Notes |
|
|
551
|
+
|------------- | ------------- | ------------- | -------------|
|
|
552
|
+
| **eventId** | `string` | Event identifier (event_id of any earnings-calls response); wins over the other selectors | [Optional] [Defaults to `undefined`] |
|
|
553
|
+
| **identifier** | `string` | Company ticker symbol or CIK (US companies only); alone = the latest call with a diff, else with year+quarter or date | [Optional] [Defaults to `undefined`] |
|
|
554
|
+
| **year** | `number` | Fiscal year of the call (with quarter) | [Optional] [Defaults to `undefined`] |
|
|
555
|
+
| **quarter** | `number` | Fiscal quarter of the call (with year) | [Optional] [Defaults to `undefined`] |
|
|
556
|
+
| **date** | `Date` | Day of the call (YYYY-MM-DD): a calendar day in New York time (America/New_York); a call without a confirmed time is listed on its announced date | [Optional] [Defaults to `undefined`] |
|
|
557
|
+
| **eventType** | `earnings_call`, `investor_day`, `conference`, `agm`, `other` | Event type the date selector matches (default earnings_call): investor_day, conference, agm or other address a non-earnings event by its date; year+quarter select earnings calls only | [Optional] [Defaults to `undefined`] [Enum: earnings_call, investor_day, conference, agm, other] |
|
|
558
|
+
| **vs** | `prior` | Comparison base: the company\'s prior call | [Optional] [Defaults to `'prior'`] [Enum: prior] |
|
|
559
|
+
|
|
560
|
+
### Return type
|
|
561
|
+
|
|
562
|
+
[**EarningsCallsDiff200Response**](EarningsCallsDiff200Response.md)
|
|
563
|
+
|
|
564
|
+
### Authorization
|
|
565
|
+
|
|
566
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
567
|
+
|
|
568
|
+
### HTTP request headers
|
|
569
|
+
|
|
570
|
+
- **Content-Type**: Not defined
|
|
571
|
+
- **Accept**: `application/json`
|
|
572
|
+
|
|
573
|
+
|
|
574
|
+
### HTTP response details
|
|
575
|
+
| Status code | Description | Response headers |
|
|
576
|
+
|-------------|-------------|------------------|
|
|
577
|
+
| **200** | Default Response | - |
|
|
578
|
+
| **400** | Bad Request - Invalid request parameters | - |
|
|
579
|
+
| **401** | Unauthorized - Missing or invalid API key | - |
|
|
580
|
+
| **404** | Not Found - Resource not found | - |
|
|
581
|
+
| **500** | Internal Server Error - Server error occurred | - |
|
|
582
|
+
|
|
583
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
584
|
+
|
|
585
|
+
|
|
586
|
+
## earningsCallsDocumentSearch
|
|
587
|
+
|
|
588
|
+
> EarningsCallsDocumentSearch200Response earningsCallsDocumentSearch(q, identifier, kind, section, year, table, limit)
|
|
589
|
+
|
|
590
|
+
Search investor documents
|
|
591
|
+
|
|
592
|
+
Semantic search over the page text of investor documents: the documents of earnings calls (CFO commentary, shareholder letters, data sheets, the company\'s own transcripts) and companies\' IR libraries (annual reports, proxy statements, ESG reports, investor-day decks). ### What you get - Up to 20 passages from company-published documents, with page numbers — not verified facts — and a signed URL of the file (open it at `#page=<page>`). - Filter by company (`identifier`), kind, IR section, year or table. ### Errors - `429 upstream_rate_limited` and `503 search_unavailable` carry `Retry-After`. - `503 search_disabled` while search is switched off. ### Freshness and coverage - Data is replicated from the capture pipeline with a lag of about a minute. - Only US earnings calls captured by Invinite are served. Minimum tier for display: FREE.
|
|
593
|
+
|
|
594
|
+
### Example
|
|
595
|
+
|
|
596
|
+
```ts
|
|
597
|
+
import {
|
|
598
|
+
Configuration,
|
|
599
|
+
EarningsCallsApi,
|
|
600
|
+
} from '@invinite-org/data-api-client';
|
|
601
|
+
import type { EarningsCallsDocumentSearchRequest } from '@invinite-org/data-api-client';
|
|
602
|
+
|
|
603
|
+
async function example() {
|
|
604
|
+
console.log("🚀 Testing @invinite-org/data-api-client SDK...");
|
|
605
|
+
const config = new Configuration({
|
|
606
|
+
// Configure HTTP bearer authorization: bearerAuth
|
|
607
|
+
accessToken: "YOUR BEARER TOKEN",
|
|
608
|
+
});
|
|
609
|
+
const api = new EarningsCallsApi(config);
|
|
610
|
+
|
|
611
|
+
const body = {
|
|
612
|
+
// string | The question or phrase to search for
|
|
613
|
+
q: q_example,
|
|
614
|
+
// string | Search one company\'s documents (ticker or CIK, US only) (optional)
|
|
615
|
+
identifier: identifier_example,
|
|
616
|
+
// Array<string> | Only these document kinds, comma-separated or repeated: annual_report, ceo_letter, proxy_statement, proxy_supplement, esg_report, conference_presentation, investor_day_deck, earnings_deck, fact_sheet, financial_data, shareholder_letter, company_transcript, cfo_commentary, governance, press_release, infographic, webcast, other, prepared_remarks, sec_filing (optional)
|
|
617
|
+
kind: ...,
|
|
618
|
+
// Array<string> | Only company documents of these IR sections: quarterly_results, events_archive, presentations_archive, annual_reports, proxy, sec_filings, press_releases, esg, governance, faq, other (optional)
|
|
619
|
+
section: ...,
|
|
620
|
+
// number | Only documents of this year (optional)
|
|
621
|
+
year: 56,
|
|
622
|
+
// 'event_documents' | 'company_documents' | event_documents (a call\'s documents) or company_documents (the company\'s IR library) (optional)
|
|
623
|
+
table: table_example,
|
|
624
|
+
// number | Maximum number of passages (at most 20) (optional)
|
|
625
|
+
limit: 56,
|
|
626
|
+
} satisfies EarningsCallsDocumentSearchRequest;
|
|
627
|
+
|
|
628
|
+
try {
|
|
629
|
+
const data = await api.earningsCallsDocumentSearch(body);
|
|
630
|
+
console.log(data);
|
|
631
|
+
} catch (error) {
|
|
632
|
+
console.error(error);
|
|
633
|
+
}
|
|
634
|
+
}
|
|
635
|
+
|
|
636
|
+
// Run the test
|
|
637
|
+
example().catch(console.error);
|
|
638
|
+
```
|
|
639
|
+
|
|
640
|
+
### Parameters
|
|
641
|
+
|
|
642
|
+
|
|
643
|
+
| Name | Type | Description | Notes |
|
|
644
|
+
|------------- | ------------- | ------------- | -------------|
|
|
645
|
+
| **q** | `string` | The question or phrase to search for | [Defaults to `undefined`] |
|
|
646
|
+
| **identifier** | `string` | Search one company\'s documents (ticker or CIK, US only) | [Optional] [Defaults to `undefined`] |
|
|
647
|
+
| **kind** | `Array<string>` | Only these document kinds, comma-separated or repeated: annual_report, ceo_letter, proxy_statement, proxy_supplement, esg_report, conference_presentation, investor_day_deck, earnings_deck, fact_sheet, financial_data, shareholder_letter, company_transcript, cfo_commentary, governance, press_release, infographic, webcast, other, prepared_remarks, sec_filing | [Optional] |
|
|
648
|
+
| **section** | `Array<string>` | Only company documents of these IR sections: quarterly_results, events_archive, presentations_archive, annual_reports, proxy, sec_filings, press_releases, esg, governance, faq, other | [Optional] |
|
|
649
|
+
| **year** | `number` | Only documents of this year | [Optional] [Defaults to `undefined`] |
|
|
650
|
+
| **table** | `event_documents`, `company_documents` | event_documents (a call\'s documents) or company_documents (the company\'s IR library) | [Optional] [Defaults to `undefined`] [Enum: event_documents, company_documents] |
|
|
651
|
+
| **limit** | `number` | Maximum number of passages (at most 20) | [Optional] [Defaults to `10`] |
|
|
652
|
+
|
|
653
|
+
### Return type
|
|
654
|
+
|
|
655
|
+
[**EarningsCallsDocumentSearch200Response**](EarningsCallsDocumentSearch200Response.md)
|
|
656
|
+
|
|
657
|
+
### Authorization
|
|
658
|
+
|
|
659
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
660
|
+
|
|
661
|
+
### HTTP request headers
|
|
662
|
+
|
|
663
|
+
- **Content-Type**: Not defined
|
|
664
|
+
- **Accept**: `application/json`
|
|
665
|
+
|
|
666
|
+
|
|
667
|
+
### HTTP response details
|
|
668
|
+
| Status code | Description | Response headers |
|
|
669
|
+
|-------------|-------------|------------------|
|
|
670
|
+
| **200** | Default Response | - |
|
|
671
|
+
| **400** | Bad Request - Invalid request parameters | - |
|
|
672
|
+
| **401** | Unauthorized - Missing or invalid API key | - |
|
|
673
|
+
| **404** | Not Found - Resource not found | - |
|
|
674
|
+
| **429** | Rate limited (Retry-After) | - |
|
|
675
|
+
| **500** | Internal Server Error - Server error occurred | - |
|
|
676
|
+
| **503** | Service Unavailable - Temporarily unavailable or switched off | - |
|
|
677
|
+
|
|
678
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
679
|
+
|
|
680
|
+
|
|
681
|
+
## earningsCallsDocuments
|
|
682
|
+
|
|
683
|
+
> EarningsCallsDocuments200Response earningsCallsDocuments(eventId, identifier, year, quarter, date, eventType, kind, include, limit, offset)
|
|
684
|
+
|
|
685
|
+
Earnings call documents
|
|
686
|
+
|
|
687
|
+
Further investor documents of one earnings call, ordered by kind: CFO commentary, financial data sheets, shareholder letters, fact sheets, the company\'s own transcript, its prepared remarks / call script, 10-Q / 10-K links. Infographics are stored as fact sheets. ### What you get - Stored files come as signed URLs; link-only rows (`sec_filing`) have `url` null and point to EDGAR through `source_url`. - Files are served as short-lived signed URLs (see `expires_at`), never proxied; request a fresh response after expiry. - Each document carries its `trust_tier`. - `documents` is `[]` for a call without further documents (`has_documents` tells ahead). ### Errors - `503 media_unavailable` while media signing is not configured. ### Choose the call - By `event_id`, or - by `identifier` with `year` + `quarter` (fiscal), or - by `identifier` with `date` (a calendar day in New York time (America/New_York); a call without a confirmed time is listed on its announced date). With `date`, `event_type` (default `earnings_call`) also addresses an investor day, conference or shareholder meeting. ### Freshness and coverage - Data is replicated from the capture pipeline with a lag of about a minute. - Only US earnings calls captured by Invinite are served. Minimum tier for display: FREE.
|
|
688
|
+
|
|
689
|
+
### Example
|
|
690
|
+
|
|
691
|
+
```ts
|
|
692
|
+
import {
|
|
693
|
+
Configuration,
|
|
694
|
+
EarningsCallsApi,
|
|
695
|
+
} from '@invinite-org/data-api-client';
|
|
696
|
+
import type { EarningsCallsDocumentsRequest } from '@invinite-org/data-api-client';
|
|
697
|
+
|
|
698
|
+
async function example() {
|
|
699
|
+
console.log("🚀 Testing @invinite-org/data-api-client SDK...");
|
|
700
|
+
const config = new Configuration({
|
|
701
|
+
// Configure HTTP bearer authorization: bearerAuth
|
|
702
|
+
accessToken: "YOUR BEARER TOKEN",
|
|
703
|
+
});
|
|
704
|
+
const api = new EarningsCallsApi(config);
|
|
705
|
+
|
|
706
|
+
const body = {
|
|
707
|
+
// string | Event identifier (event_id of any earnings-calls response); wins over the other selectors (optional)
|
|
708
|
+
eventId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
|
|
709
|
+
// string | Company ticker symbol or CIK (US companies only), with year+quarter or date (optional)
|
|
710
|
+
identifier: identifier_example,
|
|
711
|
+
// number | Fiscal year of the call (with quarter) (optional)
|
|
712
|
+
year: 56,
|
|
713
|
+
// number | Fiscal quarter of the call (with year) (optional)
|
|
714
|
+
quarter: 56,
|
|
715
|
+
// Date | Day of the call (YYYY-MM-DD): a calendar day in New York time (America/New_York); a call without a confirmed time is listed on its announced date (optional)
|
|
716
|
+
date: 2013-10-20,
|
|
717
|
+
// 'earnings_call' | 'investor_day' | 'conference' | 'agm' | 'other' | Event type the date selector matches (default earnings_call): investor_day, conference, agm or other address a non-earnings event by its date; year+quarter select earnings calls only (optional)
|
|
718
|
+
eventType: eventType_example,
|
|
719
|
+
// Array<string> | Only these kinds, comma-separated or repeated: cfo_commentary, financial_data, shareholder_letter, fact_sheet, company_transcript, prepared_remarks, sec_filing, infographic, other (optional)
|
|
720
|
+
kind: ...,
|
|
721
|
+
// Array<string> | Extra data, comma-separated or repeated: `body` = the extracted text (optional)
|
|
722
|
+
include: ...,
|
|
723
|
+
// number | Maximum number of documents to return (optional)
|
|
724
|
+
limit: 56,
|
|
725
|
+
// number | Number of documents to skip for pagination (optional)
|
|
726
|
+
offset: 56,
|
|
727
|
+
} satisfies EarningsCallsDocumentsRequest;
|
|
728
|
+
|
|
729
|
+
try {
|
|
730
|
+
const data = await api.earningsCallsDocuments(body);
|
|
731
|
+
console.log(data);
|
|
732
|
+
} catch (error) {
|
|
733
|
+
console.error(error);
|
|
734
|
+
}
|
|
735
|
+
}
|
|
736
|
+
|
|
737
|
+
// Run the test
|
|
738
|
+
example().catch(console.error);
|
|
739
|
+
```
|
|
740
|
+
|
|
741
|
+
### Parameters
|
|
742
|
+
|
|
743
|
+
|
|
744
|
+
| Name | Type | Description | Notes |
|
|
745
|
+
|------------- | ------------- | ------------- | -------------|
|
|
746
|
+
| **eventId** | `string` | Event identifier (event_id of any earnings-calls response); wins over the other selectors | [Optional] [Defaults to `undefined`] |
|
|
747
|
+
| **identifier** | `string` | Company ticker symbol or CIK (US companies only), with year+quarter or date | [Optional] [Defaults to `undefined`] |
|
|
748
|
+
| **year** | `number` | Fiscal year of the call (with quarter) | [Optional] [Defaults to `undefined`] |
|
|
749
|
+
| **quarter** | `number` | Fiscal quarter of the call (with year) | [Optional] [Defaults to `undefined`] |
|
|
750
|
+
| **date** | `Date` | Day of the call (YYYY-MM-DD): a calendar day in New York time (America/New_York); a call without a confirmed time is listed on its announced date | [Optional] [Defaults to `undefined`] |
|
|
751
|
+
| **eventType** | `earnings_call`, `investor_day`, `conference`, `agm`, `other` | Event type the date selector matches (default earnings_call): investor_day, conference, agm or other address a non-earnings event by its date; year+quarter select earnings calls only | [Optional] [Defaults to `undefined`] [Enum: earnings_call, investor_day, conference, agm, other] |
|
|
752
|
+
| **kind** | `Array<string>` | Only these kinds, comma-separated or repeated: cfo_commentary, financial_data, shareholder_letter, fact_sheet, company_transcript, prepared_remarks, sec_filing, infographic, other | [Optional] |
|
|
753
|
+
| **include** | `Array<string>` | Extra data, comma-separated or repeated: `body` = the extracted text | [Optional] |
|
|
754
|
+
| **limit** | `number` | Maximum number of documents to return | [Optional] [Defaults to `50`] |
|
|
755
|
+
| **offset** | `number` | Number of documents to skip for pagination | [Optional] [Defaults to `0`] |
|
|
756
|
+
|
|
757
|
+
### Return type
|
|
758
|
+
|
|
759
|
+
[**EarningsCallsDocuments200Response**](EarningsCallsDocuments200Response.md)
|
|
760
|
+
|
|
761
|
+
### Authorization
|
|
762
|
+
|
|
763
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
764
|
+
|
|
765
|
+
### HTTP request headers
|
|
766
|
+
|
|
767
|
+
- **Content-Type**: Not defined
|
|
768
|
+
- **Accept**: `application/json`
|
|
769
|
+
|
|
770
|
+
|
|
771
|
+
### HTTP response details
|
|
772
|
+
| Status code | Description | Response headers |
|
|
773
|
+
|-------------|-------------|------------------|
|
|
774
|
+
| **200** | Default Response | - |
|
|
775
|
+
| **400** | Bad Request - Invalid request parameters | - |
|
|
776
|
+
| **401** | Unauthorized - Missing or invalid API key | - |
|
|
777
|
+
| **404** | Not Found - Resource not found | - |
|
|
778
|
+
| **500** | Internal Server Error - Server error occurred | - |
|
|
779
|
+
| **503** | Service Unavailable - Temporarily unavailable or switched off | - |
|
|
780
|
+
|
|
781
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
782
|
+
|
|
783
|
+
|
|
784
|
+
## earningsCallsEvent
|
|
785
|
+
|
|
786
|
+
> EarningsCallsEvents200ResponseEventsInner earningsCallsEvent(eventId, include)
|
|
787
|
+
|
|
788
|
+
Earnings call by ID
|
|
789
|
+
|
|
790
|
+
One earnings call by `event_id`; `include=observations` adds the date / time observations behind its call time. ### Freshness and coverage - Data is replicated from the capture pipeline with a lag of about a minute. - Only US earnings calls captured by Invinite are served. Minimum tier for display: FREE.
|
|
791
|
+
|
|
792
|
+
### Example
|
|
793
|
+
|
|
794
|
+
```ts
|
|
795
|
+
import {
|
|
796
|
+
Configuration,
|
|
797
|
+
EarningsCallsApi,
|
|
798
|
+
} from '@invinite-org/data-api-client';
|
|
799
|
+
import type { EarningsCallsEventRequest } from '@invinite-org/data-api-client';
|
|
800
|
+
|
|
801
|
+
async function example() {
|
|
802
|
+
console.log("🚀 Testing @invinite-org/data-api-client SDK...");
|
|
803
|
+
const config = new Configuration({
|
|
804
|
+
// Configure HTTP bearer authorization: bearerAuth
|
|
805
|
+
accessToken: "YOUR BEARER TOKEN",
|
|
806
|
+
});
|
|
807
|
+
const api = new EarningsCallsApi(config);
|
|
808
|
+
|
|
809
|
+
const body = {
|
|
810
|
+
// string | Event identifier (event_id of any earnings-calls response)
|
|
811
|
+
eventId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
|
|
812
|
+
// Array<'observations'> | Extra data (repeatable): `observations` = the date / time observations behind the call time (optional)
|
|
813
|
+
include: ...,
|
|
814
|
+
} satisfies EarningsCallsEventRequest;
|
|
815
|
+
|
|
816
|
+
try {
|
|
817
|
+
const data = await api.earningsCallsEvent(body);
|
|
818
|
+
console.log(data);
|
|
819
|
+
} catch (error) {
|
|
820
|
+
console.error(error);
|
|
821
|
+
}
|
|
822
|
+
}
|
|
823
|
+
|
|
824
|
+
// Run the test
|
|
825
|
+
example().catch(console.error);
|
|
826
|
+
```
|
|
827
|
+
|
|
828
|
+
### Parameters
|
|
829
|
+
|
|
830
|
+
|
|
831
|
+
| Name | Type | Description | Notes |
|
|
832
|
+
|------------- | ------------- | ------------- | -------------|
|
|
833
|
+
| **eventId** | `string` | Event identifier (event_id of any earnings-calls response) | [Defaults to `undefined`] |
|
|
834
|
+
| **include** | `observations` | Extra data (repeatable): `observations` = the date / time observations behind the call time | [Optional] [Enum: observations] |
|
|
835
|
+
|
|
836
|
+
### Return type
|
|
837
|
+
|
|
838
|
+
[**EarningsCallsEvents200ResponseEventsInner**](EarningsCallsEvents200ResponseEventsInner.md)
|
|
839
|
+
|
|
840
|
+
### Authorization
|
|
841
|
+
|
|
842
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
843
|
+
|
|
844
|
+
### HTTP request headers
|
|
845
|
+
|
|
846
|
+
- **Content-Type**: Not defined
|
|
847
|
+
- **Accept**: `application/json`
|
|
848
|
+
|
|
849
|
+
|
|
850
|
+
### HTTP response details
|
|
851
|
+
| Status code | Description | Response headers |
|
|
852
|
+
|-------------|-------------|------------------|
|
|
853
|
+
| **200** | Default Response | - |
|
|
854
|
+
| **400** | Bad Request - Invalid request parameters | - |
|
|
855
|
+
| **401** | Unauthorized - Missing or invalid API key | - |
|
|
856
|
+
| **404** | Not Found - Resource not found | - |
|
|
857
|
+
| **500** | Internal Server Error - Server error occurred | - |
|
|
858
|
+
|
|
859
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
860
|
+
|
|
861
|
+
|
|
862
|
+
## earningsCallsEvents
|
|
863
|
+
|
|
864
|
+
> EarningsCallsEvents200Response earningsCallsEvents(identifier, from, to, include, eventType, sort, limit, offset)
|
|
865
|
+
|
|
866
|
+
Event history of a company
|
|
867
|
+
|
|
868
|
+
Event history of one US company (ticker or CIK): every event type unless `event_type` narrows it. An out-of-scope company answers `covered: false`. ### Freshness and coverage - Data is replicated from the capture pipeline with a lag of about a minute. - Only US earnings calls captured by Invinite are served. Minimum tier for display: FREE.
|
|
869
|
+
|
|
870
|
+
### Example
|
|
871
|
+
|
|
872
|
+
```ts
|
|
873
|
+
import {
|
|
874
|
+
Configuration,
|
|
875
|
+
EarningsCallsApi,
|
|
876
|
+
} from '@invinite-org/data-api-client';
|
|
877
|
+
import type { EarningsCallsEventsRequest } from '@invinite-org/data-api-client';
|
|
878
|
+
|
|
879
|
+
async function example() {
|
|
880
|
+
console.log("🚀 Testing @invinite-org/data-api-client SDK...");
|
|
881
|
+
const config = new Configuration({
|
|
882
|
+
// Configure HTTP bearer authorization: bearerAuth
|
|
883
|
+
accessToken: "YOUR BEARER TOKEN",
|
|
884
|
+
});
|
|
885
|
+
const api = new EarningsCallsApi(config);
|
|
886
|
+
|
|
887
|
+
const body = {
|
|
888
|
+
// string | Company ticker symbol or CIK (US companies only)
|
|
889
|
+
identifier: identifier_example,
|
|
890
|
+
// Date | Only calls on or after this day (YYYY-MM-DD): a calendar day in New York time (America/New_York); a call without a confirmed time is listed on its announced date (optional)
|
|
891
|
+
from: 2013-10-20,
|
|
892
|
+
// Date | Only calls on or before this day (YYYY-MM-DD): a calendar day in New York time (America/New_York); a call without a confirmed time is listed on its announced date (optional)
|
|
893
|
+
to: 2013-10-20,
|
|
894
|
+
// Array<'observations'> | Extra data per event (repeatable): `observations` = the date / time observations (optional)
|
|
895
|
+
include: ...,
|
|
896
|
+
// string | Only events of these types, a comma list (e.g. `investor_day,conference`) of earnings_call, investor_day, conference, agm, other; `all` (default) = every event type (optional)
|
|
897
|
+
eventType: eventType_example,
|
|
898
|
+
// 'asc' | 'desc' | Sort direction by scheduled start (optional)
|
|
899
|
+
sort: sort_example,
|
|
900
|
+
// number | Maximum number of events to return (optional)
|
|
901
|
+
limit: 56,
|
|
902
|
+
// number | Number of events to skip for pagination (optional)
|
|
903
|
+
offset: 56,
|
|
904
|
+
} satisfies EarningsCallsEventsRequest;
|
|
905
|
+
|
|
906
|
+
try {
|
|
907
|
+
const data = await api.earningsCallsEvents(body);
|
|
908
|
+
console.log(data);
|
|
909
|
+
} catch (error) {
|
|
910
|
+
console.error(error);
|
|
911
|
+
}
|
|
912
|
+
}
|
|
913
|
+
|
|
914
|
+
// Run the test
|
|
915
|
+
example().catch(console.error);
|
|
916
|
+
```
|
|
917
|
+
|
|
918
|
+
### Parameters
|
|
919
|
+
|
|
920
|
+
|
|
921
|
+
| Name | Type | Description | Notes |
|
|
922
|
+
|------------- | ------------- | ------------- | -------------|
|
|
923
|
+
| **identifier** | `string` | Company ticker symbol or CIK (US companies only) | [Defaults to `undefined`] |
|
|
924
|
+
| **from** | `Date` | Only calls on or after this day (YYYY-MM-DD): a calendar day in New York time (America/New_York); a call without a confirmed time is listed on its announced date | [Optional] [Defaults to `undefined`] |
|
|
925
|
+
| **to** | `Date` | Only calls on or before this day (YYYY-MM-DD): a calendar day in New York time (America/New_York); a call without a confirmed time is listed on its announced date | [Optional] [Defaults to `undefined`] |
|
|
926
|
+
| **include** | `observations` | Extra data per event (repeatable): `observations` = the date / time observations | [Optional] [Enum: observations] |
|
|
927
|
+
| **eventType** | `string` | Only events of these types, a comma list (e.g. `investor_day,conference`) of earnings_call, investor_day, conference, agm, other; `all` (default) = every event type | [Optional] [Defaults to `'all'`] |
|
|
928
|
+
| **sort** | `asc`, `desc` | Sort direction by scheduled start | [Optional] [Defaults to `'desc'`] [Enum: asc, desc] |
|
|
929
|
+
| **limit** | `number` | Maximum number of events to return | [Optional] [Defaults to `50`] |
|
|
930
|
+
| **offset** | `number` | Number of events to skip for pagination | [Optional] [Defaults to `0`] |
|
|
931
|
+
|
|
932
|
+
### Return type
|
|
933
|
+
|
|
934
|
+
[**EarningsCallsEvents200Response**](EarningsCallsEvents200Response.md)
|
|
935
|
+
|
|
936
|
+
### Authorization
|
|
937
|
+
|
|
938
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
939
|
+
|
|
940
|
+
### HTTP request headers
|
|
941
|
+
|
|
942
|
+
- **Content-Type**: Not defined
|
|
943
|
+
- **Accept**: `application/json`
|
|
944
|
+
|
|
945
|
+
|
|
946
|
+
### HTTP response details
|
|
947
|
+
| Status code | Description | Response headers |
|
|
948
|
+
|-------------|-------------|------------------|
|
|
949
|
+
| **200** | Default Response | - |
|
|
950
|
+
| **400** | Bad Request - Invalid request parameters | - |
|
|
951
|
+
| **401** | Unauthorized - Missing or invalid API key | - |
|
|
952
|
+
| **404** | Not Found - Resource not found | - |
|
|
953
|
+
| **500** | Internal Server Error - Server error occurred | - |
|
|
954
|
+
|
|
955
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
956
|
+
|
|
957
|
+
|
|
958
|
+
## earningsCallsExtractions
|
|
959
|
+
|
|
960
|
+
> EarningsCallsExtractions200Response earningsCallsExtractions(eventId, identifier, year, quarter, date, eventType, kind, review, limit, offset)
|
|
961
|
+
|
|
962
|
+
Guidance and KPI extractions
|
|
963
|
+
|
|
964
|
+
Forward guidance or every reported KPI figure of one earnings call. ### What you get - `kind=guidance`: one consolidated item per metric, period and basis, with verbatim citations. - `kind=kpi`: every reported KPI figure. - The list is empty until the call has been derived. ### How far to trust it - Guidance items are cross-validated between the call and the press release; `cross_validated=false` items come from one source only. - `confidence` is calibrated on large-cap spot checks, not a probability. ### Links to SEC filings - `filing_link` points at the SEC filing that carries the same figure: the results 8-K\'s press release (`target=press_release`, matched on the text) or, once the 10-Q / 10-K is on EDGAR, its XBRL fact (`target=periodic_filing`, `concept`), which replaces the 8-K link. - `match_kind=rounded` means the filing\'s value rounds to the figure as spoken. ### Paging - A page can hold fewer than `limit` items while `next_url` is still set: items (and KPI mentions) that only a press release no longer served supports are dropped after paging. - Follow `next_url` until it is null. ### Choose the call - By `event_id`, or - by `identifier` with `year` + `quarter` (fiscal), or - by `identifier` with `date` (a calendar day in New York time (America/New_York); a call without a confirmed time is listed on its announced date). With `date`, `event_type` (default `earnings_call`) also addresses an investor day, conference or shareholder meeting. ### Freshness and coverage - Data is replicated from the capture pipeline with a lag of about a minute. - Only US earnings calls captured by Invinite are served. Minimum tier for redistribute: PRO.
|
|
965
|
+
|
|
966
|
+
### Example
|
|
967
|
+
|
|
968
|
+
```ts
|
|
969
|
+
import {
|
|
970
|
+
Configuration,
|
|
971
|
+
EarningsCallsApi,
|
|
972
|
+
} from '@invinite-org/data-api-client';
|
|
973
|
+
import type { EarningsCallsExtractionsRequest } from '@invinite-org/data-api-client';
|
|
974
|
+
|
|
975
|
+
async function example() {
|
|
976
|
+
console.log("🚀 Testing @invinite-org/data-api-client SDK...");
|
|
977
|
+
const config = new Configuration({
|
|
978
|
+
// Configure HTTP bearer authorization: bearerAuth
|
|
979
|
+
accessToken: "YOUR BEARER TOKEN",
|
|
980
|
+
});
|
|
981
|
+
const api = new EarningsCallsApi(config);
|
|
982
|
+
|
|
983
|
+
const body = {
|
|
984
|
+
// string | Event identifier (event_id of any earnings-calls response); wins over the other selectors (optional)
|
|
985
|
+
eventId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
|
|
986
|
+
// string | Company ticker symbol or CIK (US companies only), with year+quarter or date (optional)
|
|
987
|
+
identifier: identifier_example,
|
|
988
|
+
// number | Fiscal year of the call (with quarter) (optional)
|
|
989
|
+
year: 56,
|
|
990
|
+
// number | Fiscal quarter of the call (with year) (optional)
|
|
991
|
+
quarter: 56,
|
|
992
|
+
// Date | Day of the call (YYYY-MM-DD): a calendar day in New York time (America/New_York); a call without a confirmed time is listed on its announced date (optional)
|
|
993
|
+
date: 2013-10-20,
|
|
994
|
+
// 'earnings_call' | 'investor_day' | 'conference' | 'agm' | 'other' | Event type the date selector matches (default earnings_call): investor_day, conference, agm or other address a non-earnings event by its date; year+quarter select earnings calls only (optional)
|
|
995
|
+
eventType: eventType_example,
|
|
996
|
+
// 'guidance' | 'kpi' | guidance = consolidated forward guidance; kpi = every reported KPI figure (optional)
|
|
997
|
+
kind: kind_example,
|
|
998
|
+
// 'approved' | 'auto' | 'all' | Guidance review filter: approved (human-approved only), auto, or all (auto + needs_review + approved) (optional)
|
|
999
|
+
review: review_example,
|
|
1000
|
+
// number | Maximum number of items to return (optional)
|
|
1001
|
+
limit: 56,
|
|
1002
|
+
// number | Number of items to skip for pagination (optional)
|
|
1003
|
+
offset: 56,
|
|
1004
|
+
} satisfies EarningsCallsExtractionsRequest;
|
|
1005
|
+
|
|
1006
|
+
try {
|
|
1007
|
+
const data = await api.earningsCallsExtractions(body);
|
|
1008
|
+
console.log(data);
|
|
1009
|
+
} catch (error) {
|
|
1010
|
+
console.error(error);
|
|
1011
|
+
}
|
|
1012
|
+
}
|
|
1013
|
+
|
|
1014
|
+
// Run the test
|
|
1015
|
+
example().catch(console.error);
|
|
1016
|
+
```
|
|
1017
|
+
|
|
1018
|
+
### Parameters
|
|
1019
|
+
|
|
1020
|
+
|
|
1021
|
+
| Name | Type | Description | Notes |
|
|
1022
|
+
|------------- | ------------- | ------------- | -------------|
|
|
1023
|
+
| **eventId** | `string` | Event identifier (event_id of any earnings-calls response); wins over the other selectors | [Optional] [Defaults to `undefined`] |
|
|
1024
|
+
| **identifier** | `string` | Company ticker symbol or CIK (US companies only), with year+quarter or date | [Optional] [Defaults to `undefined`] |
|
|
1025
|
+
| **year** | `number` | Fiscal year of the call (with quarter) | [Optional] [Defaults to `undefined`] |
|
|
1026
|
+
| **quarter** | `number` | Fiscal quarter of the call (with year) | [Optional] [Defaults to `undefined`] |
|
|
1027
|
+
| **date** | `Date` | Day of the call (YYYY-MM-DD): a calendar day in New York time (America/New_York); a call without a confirmed time is listed on its announced date | [Optional] [Defaults to `undefined`] |
|
|
1028
|
+
| **eventType** | `earnings_call`, `investor_day`, `conference`, `agm`, `other` | Event type the date selector matches (default earnings_call): investor_day, conference, agm or other address a non-earnings event by its date; year+quarter select earnings calls only | [Optional] [Defaults to `undefined`] [Enum: earnings_call, investor_day, conference, agm, other] |
|
|
1029
|
+
| **kind** | `guidance`, `kpi` | guidance = consolidated forward guidance; kpi = every reported KPI figure | [Optional] [Defaults to `'guidance'`] [Enum: guidance, kpi] |
|
|
1030
|
+
| **review** | `approved`, `auto`, `all` | Guidance review filter: approved (human-approved only), auto, or all (auto + needs_review + approved) | [Optional] [Defaults to `'all'`] [Enum: approved, auto, all] |
|
|
1031
|
+
| **limit** | `number` | Maximum number of items to return | [Optional] [Defaults to `200`] |
|
|
1032
|
+
| **offset** | `number` | Number of items to skip for pagination | [Optional] [Defaults to `0`] |
|
|
1033
|
+
|
|
1034
|
+
### Return type
|
|
1035
|
+
|
|
1036
|
+
[**EarningsCallsExtractions200Response**](EarningsCallsExtractions200Response.md)
|
|
1037
|
+
|
|
1038
|
+
### Authorization
|
|
1039
|
+
|
|
1040
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
1041
|
+
|
|
1042
|
+
### HTTP request headers
|
|
1043
|
+
|
|
1044
|
+
- **Content-Type**: Not defined
|
|
1045
|
+
- **Accept**: `application/json`
|
|
1046
|
+
|
|
1047
|
+
|
|
1048
|
+
### HTTP response details
|
|
1049
|
+
| Status code | Description | Response headers |
|
|
1050
|
+
|-------------|-------------|------------------|
|
|
1051
|
+
| **200** | Default Response | - |
|
|
1052
|
+
| **400** | Bad Request - Invalid request parameters | - |
|
|
1053
|
+
| **401** | Unauthorized - Missing or invalid API key | - |
|
|
1054
|
+
| **404** | Not Found - Resource not found | - |
|
|
1055
|
+
| **500** | Internal Server Error - Server error occurred | - |
|
|
1056
|
+
|
|
1057
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
1058
|
+
|
|
1059
|
+
|
|
1060
|
+
## earningsCallsGuidanceHistory
|
|
1061
|
+
|
|
1062
|
+
> EarningsCallsGuidanceHistory200Response earningsCallsGuidanceHistory(identifier, metric, periodKind, basis, limit)
|
|
1063
|
+
|
|
1064
|
+
Guidance history
|
|
1065
|
+
|
|
1066
|
+
How a company\'s guidance for one metric evolved across its earnings calls: one entry per guidance item (a call usually guides several periods), newest call first, with the change versus the prior call\'s item. ### Metrics - `metric` is matched against the normalized vocabulary: `revenue`, `eps_gaap`, `eps_non_gaap`, `operating_margin`, `operating_income`, `gross_margin`, `opex`, `capex`, `fcf`, `tax_rate`, `share_count`, `ebitda`, `net_income`, `other`, plus dynamic `segment:<slug>` metrics. - An unknown metric returns an empty series. ### How far to trust it - Guidance items are cross-validated between the call and the press release; `cross_validated=false` items come from one source only. - `confidence` is calibrated on large-cap spot checks, not a probability. ### Freshness and coverage - Data is replicated from the capture pipeline with a lag of about a minute. - Only US earnings calls captured by Invinite are served. Minimum tier for redistribute: PRO.
|
|
1067
|
+
|
|
1068
|
+
### Example
|
|
1069
|
+
|
|
1070
|
+
```ts
|
|
1071
|
+
import {
|
|
1072
|
+
Configuration,
|
|
1073
|
+
EarningsCallsApi,
|
|
1074
|
+
} from '@invinite-org/data-api-client';
|
|
1075
|
+
import type { EarningsCallsGuidanceHistoryRequest } from '@invinite-org/data-api-client';
|
|
1076
|
+
|
|
1077
|
+
async function example() {
|
|
1078
|
+
console.log("🚀 Testing @invinite-org/data-api-client SDK...");
|
|
1079
|
+
const config = new Configuration({
|
|
1080
|
+
// Configure HTTP bearer authorization: bearerAuth
|
|
1081
|
+
accessToken: "YOUR BEARER TOKEN",
|
|
1082
|
+
});
|
|
1083
|
+
const api = new EarningsCallsApi(config);
|
|
1084
|
+
|
|
1085
|
+
const body = {
|
|
1086
|
+
// string | Company ticker symbol or CIK (US companies only)
|
|
1087
|
+
identifier: identifier_example,
|
|
1088
|
+
// string | Normalized metric (e.g. revenue, eps_non_gaap, segment:iphone)
|
|
1089
|
+
metric: metric_example,
|
|
1090
|
+
// 'quarter' | 'fiscal_year' | 'half' | 'other' | Only this kind of guided period (optional)
|
|
1091
|
+
periodKind: periodKind_example,
|
|
1092
|
+
// 'gaap' | 'non_gaap' | 'unknown' | Only this accounting basis (optional)
|
|
1093
|
+
basis: basis_example,
|
|
1094
|
+
// number | Maximum number of series entries to return (optional)
|
|
1095
|
+
limit: 56,
|
|
1096
|
+
} satisfies EarningsCallsGuidanceHistoryRequest;
|
|
1097
|
+
|
|
1098
|
+
try {
|
|
1099
|
+
const data = await api.earningsCallsGuidanceHistory(body);
|
|
1100
|
+
console.log(data);
|
|
1101
|
+
} catch (error) {
|
|
1102
|
+
console.error(error);
|
|
1103
|
+
}
|
|
1104
|
+
}
|
|
1105
|
+
|
|
1106
|
+
// Run the test
|
|
1107
|
+
example().catch(console.error);
|
|
1108
|
+
```
|
|
1109
|
+
|
|
1110
|
+
### Parameters
|
|
1111
|
+
|
|
1112
|
+
|
|
1113
|
+
| Name | Type | Description | Notes |
|
|
1114
|
+
|------------- | ------------- | ------------- | -------------|
|
|
1115
|
+
| **identifier** | `string` | Company ticker symbol or CIK (US companies only) | [Defaults to `undefined`] |
|
|
1116
|
+
| **metric** | `string` | Normalized metric (e.g. revenue, eps_non_gaap, segment:iphone) | [Defaults to `undefined`] |
|
|
1117
|
+
| **periodKind** | `quarter`, `fiscal_year`, `half`, `other` | Only this kind of guided period | [Optional] [Defaults to `undefined`] [Enum: quarter, fiscal_year, half, other] |
|
|
1118
|
+
| **basis** | `gaap`, `non_gaap`, `unknown` | Only this accounting basis | [Optional] [Defaults to `undefined`] [Enum: gaap, non_gaap, unknown] |
|
|
1119
|
+
| **limit** | `number` | Maximum number of series entries to return | [Optional] [Defaults to `12`] |
|
|
1120
|
+
|
|
1121
|
+
### Return type
|
|
1122
|
+
|
|
1123
|
+
[**EarningsCallsGuidanceHistory200Response**](EarningsCallsGuidanceHistory200Response.md)
|
|
1124
|
+
|
|
1125
|
+
### Authorization
|
|
1126
|
+
|
|
1127
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
1128
|
+
|
|
1129
|
+
### HTTP request headers
|
|
1130
|
+
|
|
1131
|
+
- **Content-Type**: Not defined
|
|
1132
|
+
- **Accept**: `application/json`
|
|
1133
|
+
|
|
1134
|
+
|
|
1135
|
+
### HTTP response details
|
|
1136
|
+
| Status code | Description | Response headers |
|
|
1137
|
+
|-------------|-------------|------------------|
|
|
1138
|
+
| **200** | Default Response | - |
|
|
1139
|
+
| **400** | Bad Request - Invalid request parameters | - |
|
|
1140
|
+
| **401** | Unauthorized - Missing or invalid API key | - |
|
|
1141
|
+
| **404** | Not Found - Resource not found | - |
|
|
1142
|
+
| **500** | Internal Server Error - Server error occurred | - |
|
|
1143
|
+
|
|
1144
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
1145
|
+
|
|
1146
|
+
|
|
1147
|
+
## earningsCallsLive
|
|
1148
|
+
|
|
1149
|
+
> EarningsCallsLive200Response earningsCallsLive()
|
|
1150
|
+
|
|
1151
|
+
Live earnings calls
|
|
1152
|
+
|
|
1153
|
+
Earnings calls being captured live right now, with the WebSocket channel of their live transcript. A call appears within seconds of its start and disappears when it ends; an empty list means nothing is live. ### Freshness and coverage - Data is replicated from the capture pipeline with a lag of about a minute. - Only US earnings calls captured by Invinite are served. Minimum tier for display: FREE.
|
|
1154
|
+
|
|
1155
|
+
### Example
|
|
1156
|
+
|
|
1157
|
+
```ts
|
|
1158
|
+
import {
|
|
1159
|
+
Configuration,
|
|
1160
|
+
EarningsCallsApi,
|
|
1161
|
+
} from '@invinite-org/data-api-client';
|
|
1162
|
+
import type { EarningsCallsLiveRequest } from '@invinite-org/data-api-client';
|
|
1163
|
+
|
|
1164
|
+
async function example() {
|
|
1165
|
+
console.log("🚀 Testing @invinite-org/data-api-client SDK...");
|
|
1166
|
+
const config = new Configuration({
|
|
1167
|
+
// Configure HTTP bearer authorization: bearerAuth
|
|
1168
|
+
accessToken: "YOUR BEARER TOKEN",
|
|
1169
|
+
});
|
|
1170
|
+
const api = new EarningsCallsApi(config);
|
|
1171
|
+
|
|
1172
|
+
try {
|
|
1173
|
+
const data = await api.earningsCallsLive();
|
|
1174
|
+
console.log(data);
|
|
1175
|
+
} catch (error) {
|
|
1176
|
+
console.error(error);
|
|
1177
|
+
}
|
|
1178
|
+
}
|
|
1179
|
+
|
|
1180
|
+
// Run the test
|
|
1181
|
+
example().catch(console.error);
|
|
1182
|
+
```
|
|
1183
|
+
|
|
1184
|
+
### Parameters
|
|
1185
|
+
|
|
1186
|
+
This endpoint does not need any parameter.
|
|
1187
|
+
|
|
1188
|
+
### Return type
|
|
1189
|
+
|
|
1190
|
+
[**EarningsCallsLive200Response**](EarningsCallsLive200Response.md)
|
|
1191
|
+
|
|
1192
|
+
### Authorization
|
|
1193
|
+
|
|
1194
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
1195
|
+
|
|
1196
|
+
### HTTP request headers
|
|
1197
|
+
|
|
1198
|
+
- **Content-Type**: Not defined
|
|
1199
|
+
- **Accept**: `application/json`
|
|
1200
|
+
|
|
1201
|
+
|
|
1202
|
+
### HTTP response details
|
|
1203
|
+
| Status code | Description | Response headers |
|
|
1204
|
+
|-------------|-------------|------------------|
|
|
1205
|
+
| **200** | Default Response | - |
|
|
1206
|
+
| **400** | Bad Request - Invalid request parameters | - |
|
|
1207
|
+
| **401** | Unauthorized - Missing or invalid API key | - |
|
|
1208
|
+
| **404** | Not Found - Resource not found | - |
|
|
1209
|
+
| **500** | Internal Server Error - Server error occurred | - |
|
|
1210
|
+
|
|
1211
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
1212
|
+
|
|
1213
|
+
|
|
1214
|
+
## earningsCallsLiveStream
|
|
1215
|
+
|
|
1216
|
+
> EarningsCallsLiveStream200Response earningsCallsLiveStream(eventId, identifier, year, quarter, date, eventType)
|
|
1217
|
+
|
|
1218
|
+
Live audio stream URL
|
|
1219
|
+
|
|
1220
|
+
A temporary HLS playlist URL of an earnings call\'s live audio (PRO). The stream is watermarked. ### Using the URL - The URL works until `expires_at` (2 hours by default) and is minted fresh on every request: request a new one before it expires. - Play it with hls.js, Safari or VLC. The playlist is an EVENT playlist, so seek to 0 for the start of the call. - `call_t0` is the wall clock of call ms 0: `#EXT-X-PROGRAM-DATE-TIME` minus `call_t0` = the `start_ms` of the live transcript (WebSocket channel `live_channel`). ### No stream and errors - `status` `not_started` / `disabled` answer `url: null`. - `403 audio_unavailable` when the company\'s audio is not licensed for delivery. - `503 media_unavailable` while live streaming is not configured. ### Choose the call - By `event_id`, or - by `identifier` with `year` + `quarter` (fiscal), or - by `identifier` with `date` (a calendar day in New York time (America/New_York); a call without a confirmed time is listed on its announced date). With `date`, `event_type` (default `earnings_call`) also addresses an investor day, conference or shareholder meeting. ### Freshness and coverage - Data is replicated from the capture pipeline with a lag of about a minute. - Only US earnings calls captured by Invinite are served. Minimum tier for display: FREE.
|
|
1221
|
+
|
|
1222
|
+
### Example
|
|
1223
|
+
|
|
1224
|
+
```ts
|
|
1225
|
+
import {
|
|
1226
|
+
Configuration,
|
|
1227
|
+
EarningsCallsApi,
|
|
1228
|
+
} from '@invinite-org/data-api-client';
|
|
1229
|
+
import type { EarningsCallsLiveStreamRequest } from '@invinite-org/data-api-client';
|
|
1230
|
+
|
|
1231
|
+
async function example() {
|
|
1232
|
+
console.log("🚀 Testing @invinite-org/data-api-client SDK...");
|
|
1233
|
+
const config = new Configuration({
|
|
1234
|
+
// Configure HTTP bearer authorization: bearerAuth
|
|
1235
|
+
accessToken: "YOUR BEARER TOKEN",
|
|
1236
|
+
});
|
|
1237
|
+
const api = new EarningsCallsApi(config);
|
|
1238
|
+
|
|
1239
|
+
const body = {
|
|
1240
|
+
// string | Event identifier (event_id of any earnings-calls response); wins over the other selectors (optional)
|
|
1241
|
+
eventId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
|
|
1242
|
+
// string | Company ticker symbol or CIK (US companies only), with year+quarter or date (optional)
|
|
1243
|
+
identifier: identifier_example,
|
|
1244
|
+
// number | Fiscal year of the call (with quarter) (optional)
|
|
1245
|
+
year: 56,
|
|
1246
|
+
// number | Fiscal quarter of the call (with year) (optional)
|
|
1247
|
+
quarter: 56,
|
|
1248
|
+
// Date | Day of the call (YYYY-MM-DD): a calendar day in New York time (America/New_York); a call without a confirmed time is listed on its announced date (optional)
|
|
1249
|
+
date: 2013-10-20,
|
|
1250
|
+
// 'earnings_call' | 'investor_day' | 'conference' | 'agm' | 'other' | Event type the date selector matches (default earnings_call): investor_day, conference, agm or other address a non-earnings event by its date; year+quarter select earnings calls only (optional)
|
|
1251
|
+
eventType: eventType_example,
|
|
1252
|
+
} satisfies EarningsCallsLiveStreamRequest;
|
|
1253
|
+
|
|
1254
|
+
try {
|
|
1255
|
+
const data = await api.earningsCallsLiveStream(body);
|
|
1256
|
+
console.log(data);
|
|
1257
|
+
} catch (error) {
|
|
1258
|
+
console.error(error);
|
|
1259
|
+
}
|
|
1260
|
+
}
|
|
1261
|
+
|
|
1262
|
+
// Run the test
|
|
1263
|
+
example().catch(console.error);
|
|
1264
|
+
```
|
|
1265
|
+
|
|
1266
|
+
### Parameters
|
|
1267
|
+
|
|
1268
|
+
|
|
1269
|
+
| Name | Type | Description | Notes |
|
|
1270
|
+
|------------- | ------------- | ------------- | -------------|
|
|
1271
|
+
| **eventId** | `string` | Event identifier (event_id of any earnings-calls response); wins over the other selectors | [Optional] [Defaults to `undefined`] |
|
|
1272
|
+
| **identifier** | `string` | Company ticker symbol or CIK (US companies only), with year+quarter or date | [Optional] [Defaults to `undefined`] |
|
|
1273
|
+
| **year** | `number` | Fiscal year of the call (with quarter) | [Optional] [Defaults to `undefined`] |
|
|
1274
|
+
| **quarter** | `number` | Fiscal quarter of the call (with year) | [Optional] [Defaults to `undefined`] |
|
|
1275
|
+
| **date** | `Date` | Day of the call (YYYY-MM-DD): a calendar day in New York time (America/New_York); a call without a confirmed time is listed on its announced date | [Optional] [Defaults to `undefined`] |
|
|
1276
|
+
| **eventType** | `earnings_call`, `investor_day`, `conference`, `agm`, `other` | Event type the date selector matches (default earnings_call): investor_day, conference, agm or other address a non-earnings event by its date; year+quarter select earnings calls only | [Optional] [Defaults to `undefined`] [Enum: earnings_call, investor_day, conference, agm, other] |
|
|
1277
|
+
|
|
1278
|
+
### Return type
|
|
1279
|
+
|
|
1280
|
+
[**EarningsCallsLiveStream200Response**](EarningsCallsLiveStream200Response.md)
|
|
1281
|
+
|
|
1282
|
+
### Authorization
|
|
1283
|
+
|
|
1284
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
1285
|
+
|
|
1286
|
+
### HTTP request headers
|
|
1287
|
+
|
|
1288
|
+
- **Content-Type**: Not defined
|
|
1289
|
+
- **Accept**: `application/json`
|
|
1290
|
+
|
|
1291
|
+
|
|
1292
|
+
### HTTP response details
|
|
1293
|
+
| Status code | Description | Response headers |
|
|
1294
|
+
|-------------|-------------|------------------|
|
|
1295
|
+
| **200** | Default Response | - |
|
|
1296
|
+
| **400** | Bad Request - Invalid request parameters | - |
|
|
1297
|
+
| **401** | Unauthorized - Missing or invalid API key | - |
|
|
1298
|
+
| **403** | Forbidden - Not available under the current licence | - |
|
|
1299
|
+
| **404** | Not Found - Resource not found | - |
|
|
1300
|
+
| **500** | Internal Server Error - Server error occurred | - |
|
|
1301
|
+
| **503** | Service Unavailable - Temporarily unavailable or switched off | - |
|
|
1302
|
+
|
|
1303
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
1304
|
+
|
|
1305
|
+
|
|
1306
|
+
## earningsCallsMetrics
|
|
1307
|
+
|
|
1308
|
+
> EarningsCallsMetrics200Response earningsCallsMetrics(eventId, identifier, year, quarter, date, eventType)
|
|
1309
|
+
|
|
1310
|
+
Earnings call metrics
|
|
1311
|
+
|
|
1312
|
+
Call metadata of one earnings call: length, prepared remarks vs Q&A, release-to-call gap, question and analyst counts, management\'s share of the Q&A and speaker coverage. ### Errors - `404 metrics_unavailable` until the call has been derived. ### Choose the call - By `event_id`, or - by `identifier` with `year` + `quarter` (fiscal), or - by `identifier` with `date` (a calendar day in New York time (America/New_York); a call without a confirmed time is listed on its announced date). With `date`, `event_type` (default `earnings_call`) also addresses an investor day, conference or shareholder meeting. ### Freshness and coverage - Data is replicated from the capture pipeline with a lag of about a minute. - Only US earnings calls captured by Invinite are served. Minimum tier for redistribute: PRO.
|
|
1313
|
+
|
|
1314
|
+
### Example
|
|
1315
|
+
|
|
1316
|
+
```ts
|
|
1317
|
+
import {
|
|
1318
|
+
Configuration,
|
|
1319
|
+
EarningsCallsApi,
|
|
1320
|
+
} from '@invinite-org/data-api-client';
|
|
1321
|
+
import type { EarningsCallsMetricsRequest } from '@invinite-org/data-api-client';
|
|
1322
|
+
|
|
1323
|
+
async function example() {
|
|
1324
|
+
console.log("🚀 Testing @invinite-org/data-api-client SDK...");
|
|
1325
|
+
const config = new Configuration({
|
|
1326
|
+
// Configure HTTP bearer authorization: bearerAuth
|
|
1327
|
+
accessToken: "YOUR BEARER TOKEN",
|
|
1328
|
+
});
|
|
1329
|
+
const api = new EarningsCallsApi(config);
|
|
1330
|
+
|
|
1331
|
+
const body = {
|
|
1332
|
+
// string | Event identifier (event_id of any earnings-calls response); wins over the other selectors (optional)
|
|
1333
|
+
eventId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
|
|
1334
|
+
// string | Company ticker symbol or CIK (US companies only), with year+quarter or date (optional)
|
|
1335
|
+
identifier: identifier_example,
|
|
1336
|
+
// number | Fiscal year of the call (with quarter) (optional)
|
|
1337
|
+
year: 56,
|
|
1338
|
+
// number | Fiscal quarter of the call (with year) (optional)
|
|
1339
|
+
quarter: 56,
|
|
1340
|
+
// Date | Day of the call (YYYY-MM-DD): a calendar day in New York time (America/New_York); a call without a confirmed time is listed on its announced date (optional)
|
|
1341
|
+
date: 2013-10-20,
|
|
1342
|
+
// 'earnings_call' | 'investor_day' | 'conference' | 'agm' | 'other' | Event type the date selector matches (default earnings_call): investor_day, conference, agm or other address a non-earnings event by its date; year+quarter select earnings calls only (optional)
|
|
1343
|
+
eventType: eventType_example,
|
|
1344
|
+
} satisfies EarningsCallsMetricsRequest;
|
|
1345
|
+
|
|
1346
|
+
try {
|
|
1347
|
+
const data = await api.earningsCallsMetrics(body);
|
|
1348
|
+
console.log(data);
|
|
1349
|
+
} catch (error) {
|
|
1350
|
+
console.error(error);
|
|
1351
|
+
}
|
|
1352
|
+
}
|
|
1353
|
+
|
|
1354
|
+
// Run the test
|
|
1355
|
+
example().catch(console.error);
|
|
1356
|
+
```
|
|
1357
|
+
|
|
1358
|
+
### Parameters
|
|
1359
|
+
|
|
1360
|
+
|
|
1361
|
+
| Name | Type | Description | Notes |
|
|
1362
|
+
|------------- | ------------- | ------------- | -------------|
|
|
1363
|
+
| **eventId** | `string` | Event identifier (event_id of any earnings-calls response); wins over the other selectors | [Optional] [Defaults to `undefined`] |
|
|
1364
|
+
| **identifier** | `string` | Company ticker symbol or CIK (US companies only), with year+quarter or date | [Optional] [Defaults to `undefined`] |
|
|
1365
|
+
| **year** | `number` | Fiscal year of the call (with quarter) | [Optional] [Defaults to `undefined`] |
|
|
1366
|
+
| **quarter** | `number` | Fiscal quarter of the call (with year) | [Optional] [Defaults to `undefined`] |
|
|
1367
|
+
| **date** | `Date` | Day of the call (YYYY-MM-DD): a calendar day in New York time (America/New_York); a call without a confirmed time is listed on its announced date | [Optional] [Defaults to `undefined`] |
|
|
1368
|
+
| **eventType** | `earnings_call`, `investor_day`, `conference`, `agm`, `other` | Event type the date selector matches (default earnings_call): investor_day, conference, agm or other address a non-earnings event by its date; year+quarter select earnings calls only | [Optional] [Defaults to `undefined`] [Enum: earnings_call, investor_day, conference, agm, other] |
|
|
1369
|
+
|
|
1370
|
+
### Return type
|
|
1371
|
+
|
|
1372
|
+
[**EarningsCallsMetrics200Response**](EarningsCallsMetrics200Response.md)
|
|
1373
|
+
|
|
1374
|
+
### Authorization
|
|
1375
|
+
|
|
1376
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
1377
|
+
|
|
1378
|
+
### HTTP request headers
|
|
1379
|
+
|
|
1380
|
+
- **Content-Type**: Not defined
|
|
1381
|
+
- **Accept**: `application/json`
|
|
1382
|
+
|
|
1383
|
+
|
|
1384
|
+
### HTTP response details
|
|
1385
|
+
| Status code | Description | Response headers |
|
|
1386
|
+
|-------------|-------------|------------------|
|
|
1387
|
+
| **200** | Default Response | - |
|
|
1388
|
+
| **400** | Bad Request - Invalid request parameters | - |
|
|
1389
|
+
| **401** | Unauthorized - Missing or invalid API key | - |
|
|
1390
|
+
| **404** | Not Found - Resource not found | - |
|
|
1391
|
+
| **500** | Internal Server Error - Server error occurred | - |
|
|
1392
|
+
|
|
1393
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
1394
|
+
|
|
1395
|
+
|
|
1396
|
+
## earningsCallsParticipants
|
|
1397
|
+
|
|
1398
|
+
> EarningsCallsParticipants200Response earningsCallsParticipants(eventId, identifier, year, quarter, date, eventType, include)
|
|
1399
|
+
|
|
1400
|
+
Earnings call participants
|
|
1401
|
+
|
|
1402
|
+
Speakers of one earnings call (name, title, firm, role, cross-call `person_id`) and its participation flags vs the prior call (`cfo_absent`, `ceo_no_questions`, `new_cfo`, …). ### Choose the call - By `event_id`, or - by `identifier` with `year` + `quarter` (fiscal), or - by `identifier` with `date` (a calendar day in New York time (America/New_York); a call without a confirmed time is listed on its announced date). With `date`, `event_type` (default `earnings_call`) also addresses an investor day, conference or shareholder meeting. ### Calls without a recording - A call without a recording may carry the company\'s own transcript (`stt_provider` `company_document`): it is untimed (`null` timings) and has no cleaned layer. ### Freshness and coverage - Data is replicated from the capture pipeline with a lag of about a minute. - Only US earnings calls captured by Invinite are served. Minimum tier for rag: STANDARD.
|
|
1403
|
+
|
|
1404
|
+
### Example
|
|
1405
|
+
|
|
1406
|
+
```ts
|
|
1407
|
+
import {
|
|
1408
|
+
Configuration,
|
|
1409
|
+
EarningsCallsApi,
|
|
1410
|
+
} from '@invinite-org/data-api-client';
|
|
1411
|
+
import type { EarningsCallsParticipantsRequest } from '@invinite-org/data-api-client';
|
|
1412
|
+
|
|
1413
|
+
async function example() {
|
|
1414
|
+
console.log("🚀 Testing @invinite-org/data-api-client SDK...");
|
|
1415
|
+
const config = new Configuration({
|
|
1416
|
+
// Configure HTTP bearer authorization: bearerAuth
|
|
1417
|
+
accessToken: "YOUR BEARER TOKEN",
|
|
1418
|
+
});
|
|
1419
|
+
const api = new EarningsCallsApi(config);
|
|
1420
|
+
|
|
1421
|
+
const body = {
|
|
1422
|
+
// string | Event identifier (event_id of any earnings-calls response); wins over the other selectors (optional)
|
|
1423
|
+
eventId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
|
|
1424
|
+
// string | Company ticker symbol or CIK (US companies only), with year+quarter or date (optional)
|
|
1425
|
+
identifier: identifier_example,
|
|
1426
|
+
// number | Fiscal year of the call (with quarter) (optional)
|
|
1427
|
+
year: 56,
|
|
1428
|
+
// number | Fiscal quarter of the call (with year) (optional)
|
|
1429
|
+
quarter: 56,
|
|
1430
|
+
// Date | Day of the call (YYYY-MM-DD): a calendar day in New York time (America/New_York); a call without a confirmed time is listed on its announced date (optional)
|
|
1431
|
+
date: 2013-10-20,
|
|
1432
|
+
// 'earnings_call' | 'investor_day' | 'conference' | 'agm' | 'other' | Event type the date selector matches (default earnings_call): investor_day, conference, agm or other address a non-earnings event by its date; year+quarter select earnings calls only (optional)
|
|
1433
|
+
eventType: eventType_example,
|
|
1434
|
+
// Array<'evidence'> | Extra data (repeatable): `evidence` = the quotes each name was resolved from (optional)
|
|
1435
|
+
include: ...,
|
|
1436
|
+
} satisfies EarningsCallsParticipantsRequest;
|
|
1437
|
+
|
|
1438
|
+
try {
|
|
1439
|
+
const data = await api.earningsCallsParticipants(body);
|
|
1440
|
+
console.log(data);
|
|
1441
|
+
} catch (error) {
|
|
1442
|
+
console.error(error);
|
|
1443
|
+
}
|
|
1444
|
+
}
|
|
1445
|
+
|
|
1446
|
+
// Run the test
|
|
1447
|
+
example().catch(console.error);
|
|
1448
|
+
```
|
|
1449
|
+
|
|
1450
|
+
### Parameters
|
|
1451
|
+
|
|
1452
|
+
|
|
1453
|
+
| Name | Type | Description | Notes |
|
|
1454
|
+
|------------- | ------------- | ------------- | -------------|
|
|
1455
|
+
| **eventId** | `string` | Event identifier (event_id of any earnings-calls response); wins over the other selectors | [Optional] [Defaults to `undefined`] |
|
|
1456
|
+
| **identifier** | `string` | Company ticker symbol or CIK (US companies only), with year+quarter or date | [Optional] [Defaults to `undefined`] |
|
|
1457
|
+
| **year** | `number` | Fiscal year of the call (with quarter) | [Optional] [Defaults to `undefined`] |
|
|
1458
|
+
| **quarter** | `number` | Fiscal quarter of the call (with year) | [Optional] [Defaults to `undefined`] |
|
|
1459
|
+
| **date** | `Date` | Day of the call (YYYY-MM-DD): a calendar day in New York time (America/New_York); a call without a confirmed time is listed on its announced date | [Optional] [Defaults to `undefined`] |
|
|
1460
|
+
| **eventType** | `earnings_call`, `investor_day`, `conference`, `agm`, `other` | Event type the date selector matches (default earnings_call): investor_day, conference, agm or other address a non-earnings event by its date; year+quarter select earnings calls only | [Optional] [Defaults to `undefined`] [Enum: earnings_call, investor_day, conference, agm, other] |
|
|
1461
|
+
| **include** | `evidence` | Extra data (repeatable): `evidence` = the quotes each name was resolved from | [Optional] [Enum: evidence] |
|
|
1462
|
+
|
|
1463
|
+
### Return type
|
|
1464
|
+
|
|
1465
|
+
[**EarningsCallsParticipants200Response**](EarningsCallsParticipants200Response.md)
|
|
1466
|
+
|
|
1467
|
+
### Authorization
|
|
1468
|
+
|
|
1469
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
1470
|
+
|
|
1471
|
+
### HTTP request headers
|
|
1472
|
+
|
|
1473
|
+
- **Content-Type**: Not defined
|
|
1474
|
+
- **Accept**: `application/json`
|
|
1475
|
+
|
|
1476
|
+
|
|
1477
|
+
### HTTP response details
|
|
1478
|
+
| Status code | Description | Response headers |
|
|
1479
|
+
|-------------|-------------|------------------|
|
|
1480
|
+
| **200** | Default Response | - |
|
|
1481
|
+
| **400** | Bad Request - Invalid request parameters | - |
|
|
1482
|
+
| **401** | Unauthorized - Missing or invalid API key | - |
|
|
1483
|
+
| **404** | Not Found - Resource not found | - |
|
|
1484
|
+
| **500** | Internal Server Error - Server error occurred | - |
|
|
1485
|
+
|
|
1486
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
1487
|
+
|
|
1488
|
+
|
|
1489
|
+
## earningsCallsPerson
|
|
1490
|
+
|
|
1491
|
+
> EarningsCallsPerson200Response earningsCallsPerson(personId, limit, offset)
|
|
1492
|
+
|
|
1493
|
+
Person across earnings calls
|
|
1494
|
+
|
|
1495
|
+
One person (executive or analyst) across every served earnings call: identity, appearances and participation flags. A merged duplicate id answers `301` to the canonical id. ### Freshness and coverage - Data is replicated from the capture pipeline with a lag of about a minute. - Only US earnings calls captured by Invinite are served. Minimum tier for rag: STANDARD.
|
|
1496
|
+
|
|
1497
|
+
### Example
|
|
1498
|
+
|
|
1499
|
+
```ts
|
|
1500
|
+
import {
|
|
1501
|
+
Configuration,
|
|
1502
|
+
EarningsCallsApi,
|
|
1503
|
+
} from '@invinite-org/data-api-client';
|
|
1504
|
+
import type { EarningsCallsPersonRequest } from '@invinite-org/data-api-client';
|
|
1505
|
+
|
|
1506
|
+
async function example() {
|
|
1507
|
+
console.log("🚀 Testing @invinite-org/data-api-client SDK...");
|
|
1508
|
+
const config = new Configuration({
|
|
1509
|
+
// Configure HTTP bearer authorization: bearerAuth
|
|
1510
|
+
accessToken: "YOUR BEARER TOKEN",
|
|
1511
|
+
});
|
|
1512
|
+
const api = new EarningsCallsApi(config);
|
|
1513
|
+
|
|
1514
|
+
const body = {
|
|
1515
|
+
// string | Person identifier (person_id of participants / qa / analysts)
|
|
1516
|
+
personId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
|
|
1517
|
+
// number | Maximum number of appearances to return (optional)
|
|
1518
|
+
limit: 56,
|
|
1519
|
+
// number | Number of appearances to skip for pagination (optional)
|
|
1520
|
+
offset: 56,
|
|
1521
|
+
} satisfies EarningsCallsPersonRequest;
|
|
1522
|
+
|
|
1523
|
+
try {
|
|
1524
|
+
const data = await api.earningsCallsPerson(body);
|
|
1525
|
+
console.log(data);
|
|
1526
|
+
} catch (error) {
|
|
1527
|
+
console.error(error);
|
|
1528
|
+
}
|
|
1529
|
+
}
|
|
1530
|
+
|
|
1531
|
+
// Run the test
|
|
1532
|
+
example().catch(console.error);
|
|
1533
|
+
```
|
|
1534
|
+
|
|
1535
|
+
### Parameters
|
|
1536
|
+
|
|
1537
|
+
|
|
1538
|
+
| Name | Type | Description | Notes |
|
|
1539
|
+
|------------- | ------------- | ------------- | -------------|
|
|
1540
|
+
| **personId** | `string` | Person identifier (person_id of participants / qa / analysts) | [Defaults to `undefined`] |
|
|
1541
|
+
| **limit** | `number` | Maximum number of appearances to return | [Optional] [Defaults to `50`] |
|
|
1542
|
+
| **offset** | `number` | Number of appearances to skip for pagination | [Optional] [Defaults to `0`] |
|
|
1543
|
+
|
|
1544
|
+
### Return type
|
|
1545
|
+
|
|
1546
|
+
[**EarningsCallsPerson200Response**](EarningsCallsPerson200Response.md)
|
|
1547
|
+
|
|
1548
|
+
### Authorization
|
|
1549
|
+
|
|
1550
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
1551
|
+
|
|
1552
|
+
### HTTP request headers
|
|
1553
|
+
|
|
1554
|
+
- **Content-Type**: Not defined
|
|
1555
|
+
- **Accept**: `application/json`
|
|
1556
|
+
|
|
1557
|
+
|
|
1558
|
+
### HTTP response details
|
|
1559
|
+
| Status code | Description | Response headers |
|
|
1560
|
+
|-------------|-------------|------------------|
|
|
1561
|
+
| **200** | Default Response | - |
|
|
1562
|
+
| **400** | Bad Request - Invalid request parameters | - |
|
|
1563
|
+
| **401** | Unauthorized - Missing or invalid API key | - |
|
|
1564
|
+
| **404** | Not Found - Resource not found | - |
|
|
1565
|
+
| **500** | Internal Server Error - Server error occurred | - |
|
|
1566
|
+
|
|
1567
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
1568
|
+
|
|
1569
|
+
|
|
1570
|
+
## earningsCallsPressRelease
|
|
1571
|
+
|
|
1572
|
+
> EarningsCallsPressRelease200Response earningsCallsPressRelease(eventId, identifier, year, quarter, date, eventType, include)
|
|
1573
|
+
|
|
1574
|
+
Results press release
|
|
1575
|
+
|
|
1576
|
+
The results press release of one earnings call (EDGAR 8-K exhibit, wire release or IR page). ### What you get - Title, publication time, origin, source URL and trust tier. - With `include=body`, the issuer\'s text (display licence only). ### Choose the call - By `event_id`, or - by `identifier` with `year` + `quarter` (fiscal), or - by `identifier` with `date` (a calendar day in New York time (America/New_York); a call without a confirmed time is listed on its announced date). With `date`, `event_type` (default `earnings_call`) also addresses an investor day, conference or shareholder meeting. ### Freshness and coverage - Data is replicated from the capture pipeline with a lag of about a minute. - Only US earnings calls captured by Invinite are served. Minimum tier for display: FREE.
|
|
1577
|
+
|
|
1578
|
+
### Example
|
|
1579
|
+
|
|
1580
|
+
```ts
|
|
1581
|
+
import {
|
|
1582
|
+
Configuration,
|
|
1583
|
+
EarningsCallsApi,
|
|
1584
|
+
} from '@invinite-org/data-api-client';
|
|
1585
|
+
import type { EarningsCallsPressReleaseRequest } from '@invinite-org/data-api-client';
|
|
1586
|
+
|
|
1587
|
+
async function example() {
|
|
1588
|
+
console.log("🚀 Testing @invinite-org/data-api-client SDK...");
|
|
1589
|
+
const config = new Configuration({
|
|
1590
|
+
// Configure HTTP bearer authorization: bearerAuth
|
|
1591
|
+
accessToken: "YOUR BEARER TOKEN",
|
|
1592
|
+
});
|
|
1593
|
+
const api = new EarningsCallsApi(config);
|
|
1594
|
+
|
|
1595
|
+
const body = {
|
|
1596
|
+
// string | Event identifier (event_id of any earnings-calls response); wins over the other selectors (optional)
|
|
1597
|
+
eventId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
|
|
1598
|
+
// string | Company ticker symbol or CIK (US companies only), with year+quarter or date (optional)
|
|
1599
|
+
identifier: identifier_example,
|
|
1600
|
+
// number | Fiscal year of the call (with quarter) (optional)
|
|
1601
|
+
year: 56,
|
|
1602
|
+
// number | Fiscal quarter of the call (with year) (optional)
|
|
1603
|
+
quarter: 56,
|
|
1604
|
+
// Date | Day of the call (YYYY-MM-DD): a calendar day in New York time (America/New_York); a call without a confirmed time is listed on its announced date (optional)
|
|
1605
|
+
date: 2013-10-20,
|
|
1606
|
+
// 'earnings_call' | 'investor_day' | 'conference' | 'agm' | 'other' | Event type the date selector matches (default earnings_call): investor_day, conference, agm or other address a non-earnings event by its date; year+quarter select earnings calls only (optional)
|
|
1607
|
+
eventType: eventType_example,
|
|
1608
|
+
// Array<'body'> | Extra data (repeatable): `body` = the release text (optional)
|
|
1609
|
+
include: ...,
|
|
1610
|
+
} satisfies EarningsCallsPressReleaseRequest;
|
|
1611
|
+
|
|
1612
|
+
try {
|
|
1613
|
+
const data = await api.earningsCallsPressRelease(body);
|
|
1614
|
+
console.log(data);
|
|
1615
|
+
} catch (error) {
|
|
1616
|
+
console.error(error);
|
|
1617
|
+
}
|
|
1618
|
+
}
|
|
1619
|
+
|
|
1620
|
+
// Run the test
|
|
1621
|
+
example().catch(console.error);
|
|
1622
|
+
```
|
|
1623
|
+
|
|
1624
|
+
### Parameters
|
|
1625
|
+
|
|
1626
|
+
|
|
1627
|
+
| Name | Type | Description | Notes |
|
|
1628
|
+
|------------- | ------------- | ------------- | -------------|
|
|
1629
|
+
| **eventId** | `string` | Event identifier (event_id of any earnings-calls response); wins over the other selectors | [Optional] [Defaults to `undefined`] |
|
|
1630
|
+
| **identifier** | `string` | Company ticker symbol or CIK (US companies only), with year+quarter or date | [Optional] [Defaults to `undefined`] |
|
|
1631
|
+
| **year** | `number` | Fiscal year of the call (with quarter) | [Optional] [Defaults to `undefined`] |
|
|
1632
|
+
| **quarter** | `number` | Fiscal quarter of the call (with year) | [Optional] [Defaults to `undefined`] |
|
|
1633
|
+
| **date** | `Date` | Day of the call (YYYY-MM-DD): a calendar day in New York time (America/New_York); a call without a confirmed time is listed on its announced date | [Optional] [Defaults to `undefined`] |
|
|
1634
|
+
| **eventType** | `earnings_call`, `investor_day`, `conference`, `agm`, `other` | Event type the date selector matches (default earnings_call): investor_day, conference, agm or other address a non-earnings event by its date; year+quarter select earnings calls only | [Optional] [Defaults to `undefined`] [Enum: earnings_call, investor_day, conference, agm, other] |
|
|
1635
|
+
| **include** | `body` | Extra data (repeatable): `body` = the release text | [Optional] [Enum: body] |
|
|
1636
|
+
|
|
1637
|
+
### Return type
|
|
1638
|
+
|
|
1639
|
+
[**EarningsCallsPressRelease200Response**](EarningsCallsPressRelease200Response.md)
|
|
1640
|
+
|
|
1641
|
+
### Authorization
|
|
1642
|
+
|
|
1643
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
1644
|
+
|
|
1645
|
+
### HTTP request headers
|
|
1646
|
+
|
|
1647
|
+
- **Content-Type**: Not defined
|
|
1648
|
+
- **Accept**: `application/json`
|
|
1649
|
+
|
|
1650
|
+
|
|
1651
|
+
### HTTP response details
|
|
1652
|
+
| Status code | Description | Response headers |
|
|
1653
|
+
|-------------|-------------|------------------|
|
|
1654
|
+
| **200** | Default Response | - |
|
|
1655
|
+
| **400** | Bad Request - Invalid request parameters | - |
|
|
1656
|
+
| **401** | Unauthorized - Missing or invalid API key | - |
|
|
1657
|
+
| **404** | Not Found - Resource not found | - |
|
|
1658
|
+
| **500** | Internal Server Error - Server error occurred | - |
|
|
1659
|
+
|
|
1660
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
1661
|
+
|
|
1662
|
+
|
|
1663
|
+
## earningsCallsPriceAttribution
|
|
1664
|
+
|
|
1665
|
+
> EarningsCallsPriceAttribution200Response earningsCallsPriceAttribution(eventId, identifier, year, quarter, date, eventType)
|
|
1666
|
+
|
|
1667
|
+
Price moves during a call
|
|
1668
|
+
|
|
1669
|
+
Minute-level price moves aligned to what was being said at the time. This is temporal coincidence, not attribution of cause; pre-market bars are sparse. ### During a live call - The minute rows arrive as each minute closes (`live: true`, `settled: false`; the summary fields are null). - The post-call run replaces them. ### Errors - `404 price_attribution_unavailable` until the first minute row exists. ### Choose the call - By `event_id`, or - by `identifier` with `year` + `quarter` (fiscal), or - by `identifier` with `date` (a calendar day in New York time (America/New_York); a call without a confirmed time is listed on its announced date). With `date`, `event_type` (default `earnings_call`) also addresses an investor day, conference or shareholder meeting. ### Freshness and coverage - Data is replicated from the capture pipeline with a lag of about a minute. - Only US earnings calls captured by Invinite are served. Minimum tier for display: FREE.
|
|
1670
|
+
|
|
1671
|
+
### Example
|
|
1672
|
+
|
|
1673
|
+
```ts
|
|
1674
|
+
import {
|
|
1675
|
+
Configuration,
|
|
1676
|
+
EarningsCallsApi,
|
|
1677
|
+
} from '@invinite-org/data-api-client';
|
|
1678
|
+
import type { EarningsCallsPriceAttributionRequest } from '@invinite-org/data-api-client';
|
|
1679
|
+
|
|
1680
|
+
async function example() {
|
|
1681
|
+
console.log("🚀 Testing @invinite-org/data-api-client SDK...");
|
|
1682
|
+
const config = new Configuration({
|
|
1683
|
+
// Configure HTTP bearer authorization: bearerAuth
|
|
1684
|
+
accessToken: "YOUR BEARER TOKEN",
|
|
1685
|
+
});
|
|
1686
|
+
const api = new EarningsCallsApi(config);
|
|
1687
|
+
|
|
1688
|
+
const body = {
|
|
1689
|
+
// string | Event identifier (event_id of any earnings-calls response); wins over the other selectors (optional)
|
|
1690
|
+
eventId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
|
|
1691
|
+
// string | Company ticker symbol or CIK (US companies only), with year+quarter or date (optional)
|
|
1692
|
+
identifier: identifier_example,
|
|
1693
|
+
// number | Fiscal year of the call (with quarter) (optional)
|
|
1694
|
+
year: 56,
|
|
1695
|
+
// number | Fiscal quarter of the call (with year) (optional)
|
|
1696
|
+
quarter: 56,
|
|
1697
|
+
// Date | Day of the call (YYYY-MM-DD): a calendar day in New York time (America/New_York); a call without a confirmed time is listed on its announced date (optional)
|
|
1698
|
+
date: 2013-10-20,
|
|
1699
|
+
// 'earnings_call' | 'investor_day' | 'conference' | 'agm' | 'other' | Event type the date selector matches (default earnings_call): investor_day, conference, agm or other address a non-earnings event by its date; year+quarter select earnings calls only (optional)
|
|
1700
|
+
eventType: eventType_example,
|
|
1701
|
+
} satisfies EarningsCallsPriceAttributionRequest;
|
|
1702
|
+
|
|
1703
|
+
try {
|
|
1704
|
+
const data = await api.earningsCallsPriceAttribution(body);
|
|
1705
|
+
console.log(data);
|
|
1706
|
+
} catch (error) {
|
|
1707
|
+
console.error(error);
|
|
1708
|
+
}
|
|
1709
|
+
}
|
|
1710
|
+
|
|
1711
|
+
// Run the test
|
|
1712
|
+
example().catch(console.error);
|
|
1713
|
+
```
|
|
1714
|
+
|
|
1715
|
+
### Parameters
|
|
1716
|
+
|
|
1717
|
+
|
|
1718
|
+
| Name | Type | Description | Notes |
|
|
1719
|
+
|------------- | ------------- | ------------- | -------------|
|
|
1720
|
+
| **eventId** | `string` | Event identifier (event_id of any earnings-calls response); wins over the other selectors | [Optional] [Defaults to `undefined`] |
|
|
1721
|
+
| **identifier** | `string` | Company ticker symbol or CIK (US companies only), with year+quarter or date | [Optional] [Defaults to `undefined`] |
|
|
1722
|
+
| **year** | `number` | Fiscal year of the call (with quarter) | [Optional] [Defaults to `undefined`] |
|
|
1723
|
+
| **quarter** | `number` | Fiscal quarter of the call (with year) | [Optional] [Defaults to `undefined`] |
|
|
1724
|
+
| **date** | `Date` | Day of the call (YYYY-MM-DD): a calendar day in New York time (America/New_York); a call without a confirmed time is listed on its announced date | [Optional] [Defaults to `undefined`] |
|
|
1725
|
+
| **eventType** | `earnings_call`, `investor_day`, `conference`, `agm`, `other` | Event type the date selector matches (default earnings_call): investor_day, conference, agm or other address a non-earnings event by its date; year+quarter select earnings calls only | [Optional] [Defaults to `undefined`] [Enum: earnings_call, investor_day, conference, agm, other] |
|
|
1726
|
+
|
|
1727
|
+
### Return type
|
|
1728
|
+
|
|
1729
|
+
[**EarningsCallsPriceAttribution200Response**](EarningsCallsPriceAttribution200Response.md)
|
|
1730
|
+
|
|
1731
|
+
### Authorization
|
|
1732
|
+
|
|
1733
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
1734
|
+
|
|
1735
|
+
### HTTP request headers
|
|
1736
|
+
|
|
1737
|
+
- **Content-Type**: Not defined
|
|
1738
|
+
- **Accept**: `application/json`
|
|
1739
|
+
|
|
1740
|
+
|
|
1741
|
+
### HTTP response details
|
|
1742
|
+
| Status code | Description | Response headers |
|
|
1743
|
+
|-------------|-------------|------------------|
|
|
1744
|
+
| **200** | Default Response | - |
|
|
1745
|
+
| **400** | Bad Request - Invalid request parameters | - |
|
|
1746
|
+
| **401** | Unauthorized - Missing or invalid API key | - |
|
|
1747
|
+
| **404** | Not Found - Resource not found | - |
|
|
1748
|
+
| **500** | Internal Server Error - Server error occurred | - |
|
|
1749
|
+
|
|
1750
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
1751
|
+
|
|
1752
|
+
|
|
1753
|
+
## earningsCallsProsody
|
|
1754
|
+
|
|
1755
|
+
> EarningsCallsProsody200Response earningsCallsProsody(eventId, identifier, year, quarter, date, eventType, section)
|
|
1756
|
+
|
|
1757
|
+
Speaker prosody
|
|
1758
|
+
|
|
1759
|
+
Per-speaker delivery features of one earnings call: speech rate, pauses, fillers, time to answer and, when the audio was analysed, pitch and energy. ### Reading the signals - Prosody features are a volatility and risk signal, not a direction signal. Acoustic fields (`pitch_*`, `energy_*`) are null when `acoustic_available` is false. ### Errors - `404 prosody_unavailable` until the call has been derived. ### Choose the call - By `event_id`, or - by `identifier` with `year` + `quarter` (fiscal), or - by `identifier` with `date` (a calendar day in New York time (America/New_York); a call without a confirmed time is listed on its announced date). With `date`, `event_type` (default `earnings_call`) also addresses an investor day, conference or shareholder meeting. ### Freshness and coverage - Data is replicated from the capture pipeline with a lag of about a minute. - Only US earnings calls captured by Invinite are served. Minimum tier for display: FREE.
|
|
1760
|
+
|
|
1761
|
+
### Example
|
|
1762
|
+
|
|
1763
|
+
```ts
|
|
1764
|
+
import {
|
|
1765
|
+
Configuration,
|
|
1766
|
+
EarningsCallsApi,
|
|
1767
|
+
} from '@invinite-org/data-api-client';
|
|
1768
|
+
import type { EarningsCallsProsodyRequest } from '@invinite-org/data-api-client';
|
|
1769
|
+
|
|
1770
|
+
async function example() {
|
|
1771
|
+
console.log("🚀 Testing @invinite-org/data-api-client SDK...");
|
|
1772
|
+
const config = new Configuration({
|
|
1773
|
+
// Configure HTTP bearer authorization: bearerAuth
|
|
1774
|
+
accessToken: "YOUR BEARER TOKEN",
|
|
1775
|
+
});
|
|
1776
|
+
const api = new EarningsCallsApi(config);
|
|
1777
|
+
|
|
1778
|
+
const body = {
|
|
1779
|
+
// string | Event identifier (event_id of any earnings-calls response); wins over the other selectors (optional)
|
|
1780
|
+
eventId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
|
|
1781
|
+
// string | Company ticker symbol or CIK (US companies only), with year+quarter or date (optional)
|
|
1782
|
+
identifier: identifier_example,
|
|
1783
|
+
// number | Fiscal year of the call (with quarter) (optional)
|
|
1784
|
+
year: 56,
|
|
1785
|
+
// number | Fiscal quarter of the call (with year) (optional)
|
|
1786
|
+
quarter: 56,
|
|
1787
|
+
// Date | Day of the call (YYYY-MM-DD): a calendar day in New York time (America/New_York); a call without a confirmed time is listed on its announced date (optional)
|
|
1788
|
+
date: 2013-10-20,
|
|
1789
|
+
// 'earnings_call' | 'investor_day' | 'conference' | 'agm' | 'other' | Event type the date selector matches (default earnings_call): investor_day, conference, agm or other address a non-earnings event by its date; year+quarter select earnings calls only (optional)
|
|
1790
|
+
eventType: eventType_example,
|
|
1791
|
+
// 'prepared' | 'qa' | 'all' | prepared (remarks), qa, or all (the whole call) (optional)
|
|
1792
|
+
section: section_example,
|
|
1793
|
+
} satisfies EarningsCallsProsodyRequest;
|
|
1794
|
+
|
|
1795
|
+
try {
|
|
1796
|
+
const data = await api.earningsCallsProsody(body);
|
|
1797
|
+
console.log(data);
|
|
1798
|
+
} catch (error) {
|
|
1799
|
+
console.error(error);
|
|
1800
|
+
}
|
|
1801
|
+
}
|
|
1802
|
+
|
|
1803
|
+
// Run the test
|
|
1804
|
+
example().catch(console.error);
|
|
1805
|
+
```
|
|
1806
|
+
|
|
1807
|
+
### Parameters
|
|
1808
|
+
|
|
1809
|
+
|
|
1810
|
+
| Name | Type | Description | Notes |
|
|
1811
|
+
|------------- | ------------- | ------------- | -------------|
|
|
1812
|
+
| **eventId** | `string` | Event identifier (event_id of any earnings-calls response); wins over the other selectors | [Optional] [Defaults to `undefined`] |
|
|
1813
|
+
| **identifier** | `string` | Company ticker symbol or CIK (US companies only), with year+quarter or date | [Optional] [Defaults to `undefined`] |
|
|
1814
|
+
| **year** | `number` | Fiscal year of the call (with quarter) | [Optional] [Defaults to `undefined`] |
|
|
1815
|
+
| **quarter** | `number` | Fiscal quarter of the call (with year) | [Optional] [Defaults to `undefined`] |
|
|
1816
|
+
| **date** | `Date` | Day of the call (YYYY-MM-DD): a calendar day in New York time (America/New_York); a call without a confirmed time is listed on its announced date | [Optional] [Defaults to `undefined`] |
|
|
1817
|
+
| **eventType** | `earnings_call`, `investor_day`, `conference`, `agm`, `other` | Event type the date selector matches (default earnings_call): investor_day, conference, agm or other address a non-earnings event by its date; year+quarter select earnings calls only | [Optional] [Defaults to `undefined`] [Enum: earnings_call, investor_day, conference, agm, other] |
|
|
1818
|
+
| **section** | `prepared`, `qa`, `all` | prepared (remarks), qa, or all (the whole call) | [Optional] [Defaults to `'all'`] [Enum: prepared, qa, all] |
|
|
1819
|
+
|
|
1820
|
+
### Return type
|
|
1821
|
+
|
|
1822
|
+
[**EarningsCallsProsody200Response**](EarningsCallsProsody200Response.md)
|
|
1823
|
+
|
|
1824
|
+
### Authorization
|
|
1825
|
+
|
|
1826
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
1827
|
+
|
|
1828
|
+
### HTTP request headers
|
|
1829
|
+
|
|
1830
|
+
- **Content-Type**: Not defined
|
|
1831
|
+
- **Accept**: `application/json`
|
|
1832
|
+
|
|
1833
|
+
|
|
1834
|
+
### HTTP response details
|
|
1835
|
+
| Status code | Description | Response headers |
|
|
1836
|
+
|-------------|-------------|------------------|
|
|
1837
|
+
| **200** | Default Response | - |
|
|
1838
|
+
| **400** | Bad Request - Invalid request parameters | - |
|
|
1839
|
+
| **401** | Unauthorized - Missing or invalid API key | - |
|
|
1840
|
+
| **404** | Not Found - Resource not found | - |
|
|
1841
|
+
| **500** | Internal Server Error - Server error occurred | - |
|
|
1842
|
+
|
|
1843
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
1844
|
+
|
|
1845
|
+
|
|
1846
|
+
## earningsCallsQa
|
|
1847
|
+
|
|
1848
|
+
> EarningsCallsQa200Response earningsCallsQa(eventId, identifier, year, quarter, date, eventType, limit, offset, include)
|
|
1849
|
+
|
|
1850
|
+
Earnings call Q&A
|
|
1851
|
+
|
|
1852
|
+
Structured Q&A of one earnings call: each analyst question with the analyst\'s identity and firm, the answering executives and the answer. ### What you get - `pairs` is `[]` until the Q&A has been derived. - `include=scores` adds each pair\'s descriptive scores (where the analyst sat in the question order, the question\'s tone and difficulty, whether the answer addressed it) — descriptive features of the exchange, not a forecast. ### Choose the call - By `event_id`, or - by `identifier` with `year` + `quarter` (fiscal), or - by `identifier` with `date` (a calendar day in New York time (America/New_York); a call without a confirmed time is listed on its announced date). With `date`, `event_type` (default `earnings_call`) also addresses an investor day, conference or shareholder meeting. ### Calls without a recording - A call without a recording may carry the company\'s own transcript (`stt_provider` `company_document`): it is untimed (`null` timings) and has no cleaned layer. ### Freshness and coverage - Data is replicated from the capture pipeline with a lag of about a minute. - Only US earnings calls captured by Invinite are served. Minimum tier for rag: STANDARD.
|
|
1853
|
+
|
|
1854
|
+
### Example
|
|
1855
|
+
|
|
1856
|
+
```ts
|
|
1857
|
+
import {
|
|
1858
|
+
Configuration,
|
|
1859
|
+
EarningsCallsApi,
|
|
1860
|
+
} from '@invinite-org/data-api-client';
|
|
1861
|
+
import type { EarningsCallsQaRequest } from '@invinite-org/data-api-client';
|
|
1862
|
+
|
|
1863
|
+
async function example() {
|
|
1864
|
+
console.log("🚀 Testing @invinite-org/data-api-client SDK...");
|
|
1865
|
+
const config = new Configuration({
|
|
1866
|
+
// Configure HTTP bearer authorization: bearerAuth
|
|
1867
|
+
accessToken: "YOUR BEARER TOKEN",
|
|
1868
|
+
});
|
|
1869
|
+
const api = new EarningsCallsApi(config);
|
|
1870
|
+
|
|
1871
|
+
const body = {
|
|
1872
|
+
// string | Event identifier (event_id of any earnings-calls response); wins over the other selectors (optional)
|
|
1873
|
+
eventId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
|
|
1874
|
+
// string | Company ticker symbol or CIK (US companies only), with year+quarter or date (optional)
|
|
1875
|
+
identifier: identifier_example,
|
|
1876
|
+
// number | Fiscal year of the call (with quarter) (optional)
|
|
1877
|
+
year: 56,
|
|
1878
|
+
// number | Fiscal quarter of the call (with year) (optional)
|
|
1879
|
+
quarter: 56,
|
|
1880
|
+
// Date | Day of the call (YYYY-MM-DD): a calendar day in New York time (America/New_York); a call without a confirmed time is listed on its announced date (optional)
|
|
1881
|
+
date: 2013-10-20,
|
|
1882
|
+
// 'earnings_call' | 'investor_day' | 'conference' | 'agm' | 'other' | Event type the date selector matches (default earnings_call): investor_day, conference, agm or other address a non-earnings event by its date; year+quarter select earnings calls only (optional)
|
|
1883
|
+
eventType: eventType_example,
|
|
1884
|
+
// number | Maximum number of Q&A pairs to return (optional)
|
|
1885
|
+
limit: 56,
|
|
1886
|
+
// number | Number of Q&A pairs to skip for pagination (optional)
|
|
1887
|
+
offset: 56,
|
|
1888
|
+
// 'scores' | scores = add each pair\'s descriptive scores (analyst casting order, question tone, difficulty, evasiveness, non-answer flag with verbatim evidence); null for a pair not scored yet (optional)
|
|
1889
|
+
include: include_example,
|
|
1890
|
+
} satisfies EarningsCallsQaRequest;
|
|
1891
|
+
|
|
1892
|
+
try {
|
|
1893
|
+
const data = await api.earningsCallsQa(body);
|
|
1894
|
+
console.log(data);
|
|
1895
|
+
} catch (error) {
|
|
1896
|
+
console.error(error);
|
|
1897
|
+
}
|
|
1898
|
+
}
|
|
1899
|
+
|
|
1900
|
+
// Run the test
|
|
1901
|
+
example().catch(console.error);
|
|
1902
|
+
```
|
|
1903
|
+
|
|
1904
|
+
### Parameters
|
|
1905
|
+
|
|
1906
|
+
|
|
1907
|
+
| Name | Type | Description | Notes |
|
|
1908
|
+
|------------- | ------------- | ------------- | -------------|
|
|
1909
|
+
| **eventId** | `string` | Event identifier (event_id of any earnings-calls response); wins over the other selectors | [Optional] [Defaults to `undefined`] |
|
|
1910
|
+
| **identifier** | `string` | Company ticker symbol or CIK (US companies only), with year+quarter or date | [Optional] [Defaults to `undefined`] |
|
|
1911
|
+
| **year** | `number` | Fiscal year of the call (with quarter) | [Optional] [Defaults to `undefined`] |
|
|
1912
|
+
| **quarter** | `number` | Fiscal quarter of the call (with year) | [Optional] [Defaults to `undefined`] |
|
|
1913
|
+
| **date** | `Date` | Day of the call (YYYY-MM-DD): a calendar day in New York time (America/New_York); a call without a confirmed time is listed on its announced date | [Optional] [Defaults to `undefined`] |
|
|
1914
|
+
| **eventType** | `earnings_call`, `investor_day`, `conference`, `agm`, `other` | Event type the date selector matches (default earnings_call): investor_day, conference, agm or other address a non-earnings event by its date; year+quarter select earnings calls only | [Optional] [Defaults to `undefined`] [Enum: earnings_call, investor_day, conference, agm, other] |
|
|
1915
|
+
| **limit** | `number` | Maximum number of Q&A pairs to return | [Optional] [Defaults to `50`] |
|
|
1916
|
+
| **offset** | `number` | Number of Q&A pairs to skip for pagination | [Optional] [Defaults to `0`] |
|
|
1917
|
+
| **include** | `scores` | scores = add each pair\'s descriptive scores (analyst casting order, question tone, difficulty, evasiveness, non-answer flag with verbatim evidence); null for a pair not scored yet | [Optional] [Defaults to `undefined`] [Enum: scores] |
|
|
1918
|
+
|
|
1919
|
+
### Return type
|
|
1920
|
+
|
|
1921
|
+
[**EarningsCallsQa200Response**](EarningsCallsQa200Response.md)
|
|
1922
|
+
|
|
1923
|
+
### Authorization
|
|
1924
|
+
|
|
1925
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
1926
|
+
|
|
1927
|
+
### HTTP request headers
|
|
1928
|
+
|
|
1929
|
+
- **Content-Type**: Not defined
|
|
1930
|
+
- **Accept**: `application/json`
|
|
1931
|
+
|
|
1932
|
+
|
|
1933
|
+
### HTTP response details
|
|
1934
|
+
| Status code | Description | Response headers |
|
|
1935
|
+
|-------------|-------------|------------------|
|
|
1936
|
+
| **200** | Default Response | - |
|
|
1937
|
+
| **400** | Bad Request - Invalid request parameters | - |
|
|
1938
|
+
| **401** | Unauthorized - Missing or invalid API key | - |
|
|
1939
|
+
| **404** | Not Found - Resource not found | - |
|
|
1940
|
+
| **500** | Internal Server Error - Server error occurred | - |
|
|
1941
|
+
|
|
1942
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
1943
|
+
|
|
1944
|
+
|
|
1945
|
+
## earningsCallsSearch
|
|
1946
|
+
|
|
1947
|
+
> EarningsCallsSearch200Response earningsCallsSearch(q, eventId, identifier, from, to, type, eventType, limit)
|
|
1948
|
+
|
|
1949
|
+
Search earnings calls
|
|
1950
|
+
|
|
1951
|
+
\"Ask this call\": semantic search over earnings-call transcripts and slide text — one call (`event_id`), one company (`identifier`) or every call (default: the last 365 days). ### What you get - Up to 8 passages with speaker and `start_ms`. Cite `event_id` and `start_ms`. - On plans that include the audio and slides routes (PRO), signed URLs: `audio_url` opens the calling account\'s own watermarked copy of the recording at the passage (`#t=<seconds>`) — null while that copy is being prepared (repeat the search a minute later) — and `slide.image_url` shows the slide. ### Event types - `event_type` (default `earnings_call`; `all` = every type) selects investor days, conferences or shareholder meetings too. ### Errors - `429 upstream_rate_limited` and `503 search_unavailable` carry `Retry-After`. - `503 search_disabled` while search is switched off. ### Freshness and coverage - Data is replicated from the capture pipeline with a lag of about a minute. - Only US earnings calls captured by Invinite are served. Minimum tier for rag: STANDARD.
|
|
1952
|
+
|
|
1953
|
+
### Example
|
|
1954
|
+
|
|
1955
|
+
```ts
|
|
1956
|
+
import {
|
|
1957
|
+
Configuration,
|
|
1958
|
+
EarningsCallsApi,
|
|
1959
|
+
} from '@invinite-org/data-api-client';
|
|
1960
|
+
import type { EarningsCallsSearchRequest } from '@invinite-org/data-api-client';
|
|
1961
|
+
|
|
1962
|
+
async function example() {
|
|
1963
|
+
console.log("🚀 Testing @invinite-org/data-api-client SDK...");
|
|
1964
|
+
const config = new Configuration({
|
|
1965
|
+
// Configure HTTP bearer authorization: bearerAuth
|
|
1966
|
+
accessToken: "YOUR BEARER TOKEN",
|
|
1967
|
+
});
|
|
1968
|
+
const api = new EarningsCallsApi(config);
|
|
1969
|
+
|
|
1970
|
+
const body = {
|
|
1971
|
+
// string | The question or phrase to search for
|
|
1972
|
+
q: q_example,
|
|
1973
|
+
// string | Search one call (optional)
|
|
1974
|
+
eventId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
|
|
1975
|
+
// string | Search one company\'s calls (ticker or CIK, US only) (optional)
|
|
1976
|
+
identifier: identifier_example,
|
|
1977
|
+
// Date | First call day (YYYY-MM-DD): a calendar day in New York time (America/New_York); a call without a confirmed time is listed on its announced date. An unscoped search defaults to 365 days back (optional)
|
|
1978
|
+
from: 2013-10-20,
|
|
1979
|
+
// Date | Last call day (YYYY-MM-DD): a calendar day in New York time (America/New_York); a call without a confirmed time is listed on its announced date (optional)
|
|
1980
|
+
to: 2013-10-20,
|
|
1981
|
+
// 'transcript' | 'qa' | 'preparedRemarks' | 'presentation' | transcript (all speech), qa, preparedRemarks or presentation (slide text) (optional)
|
|
1982
|
+
type: type_example,
|
|
1983
|
+
// string | Events searched, as a comma list of earnings_call, investor_day, conference, agm, other; `all` = every event type (default earnings calls) (optional)
|
|
1984
|
+
eventType: eventType_example,
|
|
1985
|
+
// number | Maximum number of passages (at most 8) (optional)
|
|
1986
|
+
limit: 56,
|
|
1987
|
+
} satisfies EarningsCallsSearchRequest;
|
|
1988
|
+
|
|
1989
|
+
try {
|
|
1990
|
+
const data = await api.earningsCallsSearch(body);
|
|
1991
|
+
console.log(data);
|
|
1992
|
+
} catch (error) {
|
|
1993
|
+
console.error(error);
|
|
1994
|
+
}
|
|
1995
|
+
}
|
|
1996
|
+
|
|
1997
|
+
// Run the test
|
|
1998
|
+
example().catch(console.error);
|
|
1999
|
+
```
|
|
2000
|
+
|
|
2001
|
+
### Parameters
|
|
2002
|
+
|
|
2003
|
+
|
|
2004
|
+
| Name | Type | Description | Notes |
|
|
2005
|
+
|------------- | ------------- | ------------- | -------------|
|
|
2006
|
+
| **q** | `string` | The question or phrase to search for | [Defaults to `undefined`] |
|
|
2007
|
+
| **eventId** | `string` | Search one call | [Optional] [Defaults to `undefined`] |
|
|
2008
|
+
| **identifier** | `string` | Search one company\'s calls (ticker or CIK, US only) | [Optional] [Defaults to `undefined`] |
|
|
2009
|
+
| **from** | `Date` | First call day (YYYY-MM-DD): a calendar day in New York time (America/New_York); a call without a confirmed time is listed on its announced date. An unscoped search defaults to 365 days back | [Optional] [Defaults to `undefined`] |
|
|
2010
|
+
| **to** | `Date` | Last call day (YYYY-MM-DD): a calendar day in New York time (America/New_York); a call without a confirmed time is listed on its announced date | [Optional] [Defaults to `undefined`] |
|
|
2011
|
+
| **type** | `transcript`, `qa`, `preparedRemarks`, `presentation` | transcript (all speech), qa, preparedRemarks or presentation (slide text) | [Optional] [Defaults to `undefined`] [Enum: transcript, qa, preparedRemarks, presentation] |
|
|
2012
|
+
| **eventType** | `string` | Events searched, as a comma list of earnings_call, investor_day, conference, agm, other; `all` = every event type (default earnings calls) | [Optional] [Defaults to `'earnings_call'`] |
|
|
2013
|
+
| **limit** | `number` | Maximum number of passages (at most 8) | [Optional] [Defaults to `5`] |
|
|
2014
|
+
|
|
2015
|
+
### Return type
|
|
2016
|
+
|
|
2017
|
+
[**EarningsCallsSearch200Response**](EarningsCallsSearch200Response.md)
|
|
2018
|
+
|
|
2019
|
+
### Authorization
|
|
2020
|
+
|
|
2021
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
2022
|
+
|
|
2023
|
+
### HTTP request headers
|
|
2024
|
+
|
|
2025
|
+
- **Content-Type**: Not defined
|
|
2026
|
+
- **Accept**: `application/json`
|
|
2027
|
+
|
|
2028
|
+
|
|
2029
|
+
### HTTP response details
|
|
2030
|
+
| Status code | Description | Response headers |
|
|
2031
|
+
|-------------|-------------|------------------|
|
|
2032
|
+
| **200** | Default Response | - |
|
|
2033
|
+
| **400** | Bad Request - Invalid request parameters | - |
|
|
2034
|
+
| **401** | Unauthorized - Missing or invalid API key | - |
|
|
2035
|
+
| **404** | Not Found - Resource not found | - |
|
|
2036
|
+
| **429** | Rate limited (Retry-After) | - |
|
|
2037
|
+
| **500** | Internal Server Error - Server error occurred | - |
|
|
2038
|
+
| **503** | Service Unavailable - Temporarily unavailable or switched off | - |
|
|
2039
|
+
|
|
2040
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
2041
|
+
|
|
2042
|
+
|
|
2043
|
+
## earningsCallsSlides
|
|
2044
|
+
|
|
2045
|
+
> EarningsCallsSlides200Response earningsCallsSlides(eventId, identifier, year, quarter, date, eventType, include, pages)
|
|
2046
|
+
|
|
2047
|
+
Earnings call slides
|
|
2048
|
+
|
|
2049
|
+
The slide deck of one earnings call (PRO): the deck PDF and each page image as signed URLs, page titles and, with `include=markdown`, each page\'s text. ### Files - Files are served as short-lived signed URLs (see `expires_at`), never proxied; request a fresh response after expiry. ### Errors - `404 slides_unavailable` when no deck is available. - `503 media_unavailable` while media signing is not configured. ### Choose the call - By `event_id`, or - by `identifier` with `year` + `quarter` (fiscal), or - by `identifier` with `date` (a calendar day in New York time (America/New_York); a call without a confirmed time is listed on its announced date). With `date`, `event_type` (default `earnings_call`) also addresses an investor day, conference or shareholder meeting. ### Freshness and coverage - Data is replicated from the capture pipeline with a lag of about a minute. - Only US earnings calls captured by Invinite are served. Minimum tier for display: FREE.
|
|
2050
|
+
|
|
2051
|
+
### Example
|
|
2052
|
+
|
|
2053
|
+
```ts
|
|
2054
|
+
import {
|
|
2055
|
+
Configuration,
|
|
2056
|
+
EarningsCallsApi,
|
|
2057
|
+
} from '@invinite-org/data-api-client';
|
|
2058
|
+
import type { EarningsCallsSlidesRequest } from '@invinite-org/data-api-client';
|
|
2059
|
+
|
|
2060
|
+
async function example() {
|
|
2061
|
+
console.log("🚀 Testing @invinite-org/data-api-client SDK...");
|
|
2062
|
+
const config = new Configuration({
|
|
2063
|
+
// Configure HTTP bearer authorization: bearerAuth
|
|
2064
|
+
accessToken: "YOUR BEARER TOKEN",
|
|
2065
|
+
});
|
|
2066
|
+
const api = new EarningsCallsApi(config);
|
|
2067
|
+
|
|
2068
|
+
const body = {
|
|
2069
|
+
// string | Event identifier (event_id of any earnings-calls response); wins over the other selectors (optional)
|
|
2070
|
+
eventId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
|
|
2071
|
+
// string | Company ticker symbol or CIK (US companies only), with year+quarter or date (optional)
|
|
2072
|
+
identifier: identifier_example,
|
|
2073
|
+
// number | Fiscal year of the call (with quarter) (optional)
|
|
2074
|
+
year: 56,
|
|
2075
|
+
// number | Fiscal quarter of the call (with year) (optional)
|
|
2076
|
+
quarter: 56,
|
|
2077
|
+
// Date | Day of the call (YYYY-MM-DD): a calendar day in New York time (America/New_York); a call without a confirmed time is listed on its announced date (optional)
|
|
2078
|
+
date: 2013-10-20,
|
|
2079
|
+
// 'earnings_call' | 'investor_day' | 'conference' | 'agm' | 'other' | Event type the date selector matches (default earnings_call): investor_day, conference, agm or other address a non-earnings event by its date; year+quarter select earnings calls only (optional)
|
|
2080
|
+
eventType: eventType_example,
|
|
2081
|
+
// Array<string> | Extra data, comma-separated or repeated: `markdown` = each page\'s extracted text (optional)
|
|
2082
|
+
include: ...,
|
|
2083
|
+
// string | Page or range to serve, e.g. 3 or 1-5 (at most 200 pages per request) (optional)
|
|
2084
|
+
pages: pages_example,
|
|
2085
|
+
} satisfies EarningsCallsSlidesRequest;
|
|
2086
|
+
|
|
2087
|
+
try {
|
|
2088
|
+
const data = await api.earningsCallsSlides(body);
|
|
2089
|
+
console.log(data);
|
|
2090
|
+
} catch (error) {
|
|
2091
|
+
console.error(error);
|
|
2092
|
+
}
|
|
2093
|
+
}
|
|
2094
|
+
|
|
2095
|
+
// Run the test
|
|
2096
|
+
example().catch(console.error);
|
|
2097
|
+
```
|
|
2098
|
+
|
|
2099
|
+
### Parameters
|
|
2100
|
+
|
|
2101
|
+
|
|
2102
|
+
| Name | Type | Description | Notes |
|
|
2103
|
+
|------------- | ------------- | ------------- | -------------|
|
|
2104
|
+
| **eventId** | `string` | Event identifier (event_id of any earnings-calls response); wins over the other selectors | [Optional] [Defaults to `undefined`] |
|
|
2105
|
+
| **identifier** | `string` | Company ticker symbol or CIK (US companies only), with year+quarter or date | [Optional] [Defaults to `undefined`] |
|
|
2106
|
+
| **year** | `number` | Fiscal year of the call (with quarter) | [Optional] [Defaults to `undefined`] |
|
|
2107
|
+
| **quarter** | `number` | Fiscal quarter of the call (with year) | [Optional] [Defaults to `undefined`] |
|
|
2108
|
+
| **date** | `Date` | Day of the call (YYYY-MM-DD): a calendar day in New York time (America/New_York); a call without a confirmed time is listed on its announced date | [Optional] [Defaults to `undefined`] |
|
|
2109
|
+
| **eventType** | `earnings_call`, `investor_day`, `conference`, `agm`, `other` | Event type the date selector matches (default earnings_call): investor_day, conference, agm or other address a non-earnings event by its date; year+quarter select earnings calls only | [Optional] [Defaults to `undefined`] [Enum: earnings_call, investor_day, conference, agm, other] |
|
|
2110
|
+
| **include** | `Array<string>` | Extra data, comma-separated or repeated: `markdown` = each page\'s extracted text | [Optional] |
|
|
2111
|
+
| **pages** | `string` | Page or range to serve, e.g. 3 or 1-5 (at most 200 pages per request) | [Optional] [Defaults to `undefined`] |
|
|
2112
|
+
|
|
2113
|
+
### Return type
|
|
2114
|
+
|
|
2115
|
+
[**EarningsCallsSlides200Response**](EarningsCallsSlides200Response.md)
|
|
2116
|
+
|
|
2117
|
+
### Authorization
|
|
2118
|
+
|
|
2119
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
2120
|
+
|
|
2121
|
+
### HTTP request headers
|
|
2122
|
+
|
|
2123
|
+
- **Content-Type**: Not defined
|
|
2124
|
+
- **Accept**: `application/json`
|
|
2125
|
+
|
|
2126
|
+
|
|
2127
|
+
### HTTP response details
|
|
2128
|
+
| Status code | Description | Response headers |
|
|
2129
|
+
|-------------|-------------|------------------|
|
|
2130
|
+
| **200** | Default Response | - |
|
|
2131
|
+
| **400** | Bad Request - Invalid request parameters | - |
|
|
2132
|
+
| **401** | Unauthorized - Missing or invalid API key | - |
|
|
2133
|
+
| **404** | Not Found - Resource not found | - |
|
|
2134
|
+
| **500** | Internal Server Error - Server error occurred | - |
|
|
2135
|
+
| **503** | Service Unavailable - Temporarily unavailable or switched off | - |
|
|
2136
|
+
|
|
2137
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
2138
|
+
|
|
2139
|
+
|
|
2140
|
+
## earningsCallsTranscript
|
|
2141
|
+
|
|
2142
|
+
> EarningsCallsTranscript200Response earningsCallsTranscript(eventId, identifier, year, quarter, date, eventType, format, version, asOf)
|
|
2143
|
+
|
|
2144
|
+
Earnings call transcript
|
|
2145
|
+
|
|
2146
|
+
Transcript of one earnings call in five formats: any published version (`version`) or the version current at a point in time (`as_of`). ### Credits - Costs 5 credits; `format=words` is weighted by turn count. ### Choose the call - By `event_id`, or - by `identifier` with `year` + `quarter` (fiscal), or - by `identifier` with `date` (a calendar day in New York time (America/New_York); a call without a confirmed time is listed on its announced date). With `date`, `event_type` (default `earnings_call`) also addresses an investor day, conference or shareholder meeting. ### Calls without a recording - A call without a recording may carry the company\'s own transcript (`stt_provider` `company_document`): it is untimed (`null` timings) and has no cleaned layer. ### Freshness and coverage - Data is replicated from the capture pipeline with a lag of about a minute. - Only US earnings calls captured by Invinite are served. Minimum tier for rag: STANDARD.
|
|
2147
|
+
|
|
2148
|
+
### Example
|
|
2149
|
+
|
|
2150
|
+
```ts
|
|
2151
|
+
import {
|
|
2152
|
+
Configuration,
|
|
2153
|
+
EarningsCallsApi,
|
|
2154
|
+
} from '@invinite-org/data-api-client';
|
|
2155
|
+
import type { EarningsCallsTranscriptRequest } from '@invinite-org/data-api-client';
|
|
2156
|
+
|
|
2157
|
+
async function example() {
|
|
2158
|
+
console.log("🚀 Testing @invinite-org/data-api-client SDK...");
|
|
2159
|
+
const config = new Configuration({
|
|
2160
|
+
// Configure HTTP bearer authorization: bearerAuth
|
|
2161
|
+
accessToken: "YOUR BEARER TOKEN",
|
|
2162
|
+
});
|
|
2163
|
+
const api = new EarningsCallsApi(config);
|
|
2164
|
+
|
|
2165
|
+
const body = {
|
|
2166
|
+
// string | Event identifier (event_id of any earnings-calls response); wins over the other selectors (optional)
|
|
2167
|
+
eventId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
|
|
2168
|
+
// string | Company ticker symbol or CIK (US companies only), with year+quarter or date (optional)
|
|
2169
|
+
identifier: identifier_example,
|
|
2170
|
+
// number | Fiscal year of the call (with quarter) (optional)
|
|
2171
|
+
year: 56,
|
|
2172
|
+
// number | Fiscal quarter of the call (with year) (optional)
|
|
2173
|
+
quarter: 56,
|
|
2174
|
+
// Date | Day of the call (YYYY-MM-DD): a calendar day in New York time (America/New_York); a call without a confirmed time is listed on its announced date (optional)
|
|
2175
|
+
date: 2013-10-20,
|
|
2176
|
+
// 'earnings_call' | 'investor_day' | 'conference' | 'agm' | 'other' | Event type the date selector matches (default earnings_call): investor_day, conference, agm or other address a non-earnings event by its date; year+quarter select earnings calls only (optional)
|
|
2177
|
+
eventType: eventType_example,
|
|
2178
|
+
// 'text' | 'speakers' | 'words' | 'sections' | 'cleaned' | text = plain text; speakers = one entry per speaker turn; words = turns with every word (w, s = start ms, e = end ms, c = confidence) — the one large format, billed by turn count; sections = prepared remarks + Q&A + qa_start_ms; cleaned = lightly cleaned turns (404 when the version has no cleaned layer) (optional)
|
|
2179
|
+
format: format_example,
|
|
2180
|
+
// number | A specific published version (one listed by transcript/versions); default = the current one (optional)
|
|
2181
|
+
version: 56,
|
|
2182
|
+
// Date | Point in time (ISO 8601): the version that was current then. Mutually exclusive with version; a future instant = the current version (optional)
|
|
2183
|
+
asOf: 2013-10-20T19:20:30+01:00,
|
|
2184
|
+
} satisfies EarningsCallsTranscriptRequest;
|
|
2185
|
+
|
|
2186
|
+
try {
|
|
2187
|
+
const data = await api.earningsCallsTranscript(body);
|
|
2188
|
+
console.log(data);
|
|
2189
|
+
} catch (error) {
|
|
2190
|
+
console.error(error);
|
|
2191
|
+
}
|
|
2192
|
+
}
|
|
2193
|
+
|
|
2194
|
+
// Run the test
|
|
2195
|
+
example().catch(console.error);
|
|
2196
|
+
```
|
|
2197
|
+
|
|
2198
|
+
### Parameters
|
|
2199
|
+
|
|
2200
|
+
|
|
2201
|
+
| Name | Type | Description | Notes |
|
|
2202
|
+
|------------- | ------------- | ------------- | -------------|
|
|
2203
|
+
| **eventId** | `string` | Event identifier (event_id of any earnings-calls response); wins over the other selectors | [Optional] [Defaults to `undefined`] |
|
|
2204
|
+
| **identifier** | `string` | Company ticker symbol or CIK (US companies only), with year+quarter or date | [Optional] [Defaults to `undefined`] |
|
|
2205
|
+
| **year** | `number` | Fiscal year of the call (with quarter) | [Optional] [Defaults to `undefined`] |
|
|
2206
|
+
| **quarter** | `number` | Fiscal quarter of the call (with year) | [Optional] [Defaults to `undefined`] |
|
|
2207
|
+
| **date** | `Date` | Day of the call (YYYY-MM-DD): a calendar day in New York time (America/New_York); a call without a confirmed time is listed on its announced date | [Optional] [Defaults to `undefined`] |
|
|
2208
|
+
| **eventType** | `earnings_call`, `investor_day`, `conference`, `agm`, `other` | Event type the date selector matches (default earnings_call): investor_day, conference, agm or other address a non-earnings event by its date; year+quarter select earnings calls only | [Optional] [Defaults to `undefined`] [Enum: earnings_call, investor_day, conference, agm, other] |
|
|
2209
|
+
| **format** | `text`, `speakers`, `words`, `sections`, `cleaned` | text = plain text; speakers = one entry per speaker turn; words = turns with every word (w, s = start ms, e = end ms, c = confidence) — the one large format, billed by turn count; sections = prepared remarks + Q&A + qa_start_ms; cleaned = lightly cleaned turns (404 when the version has no cleaned layer) | [Optional] [Defaults to `'speakers'`] [Enum: text, speakers, words, sections, cleaned] |
|
|
2210
|
+
| **version** | `number` | A specific published version (one listed by transcript/versions); default = the current one | [Optional] [Defaults to `undefined`] |
|
|
2211
|
+
| **asOf** | `Date` | Point in time (ISO 8601): the version that was current then. Mutually exclusive with version; a future instant = the current version | [Optional] [Defaults to `undefined`] |
|
|
2212
|
+
|
|
2213
|
+
### Return type
|
|
2214
|
+
|
|
2215
|
+
[**EarningsCallsTranscript200Response**](EarningsCallsTranscript200Response.md)
|
|
2216
|
+
|
|
2217
|
+
### Authorization
|
|
2218
|
+
|
|
2219
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
2220
|
+
|
|
2221
|
+
### HTTP request headers
|
|
2222
|
+
|
|
2223
|
+
- **Content-Type**: Not defined
|
|
2224
|
+
- **Accept**: `application/json`
|
|
2225
|
+
|
|
2226
|
+
|
|
2227
|
+
### HTTP response details
|
|
2228
|
+
| Status code | Description | Response headers |
|
|
2229
|
+
|-------------|-------------|------------------|
|
|
2230
|
+
| **200** | Default Response | - |
|
|
2231
|
+
| **400** | Bad Request - Invalid request parameters | - |
|
|
2232
|
+
| **401** | Unauthorized - Missing or invalid API key | - |
|
|
2233
|
+
| **404** | Default Response | - |
|
|
2234
|
+
| **500** | Internal Server Error - Server error occurred | - |
|
|
2235
|
+
|
|
2236
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
2237
|
+
|
|
2238
|
+
|
|
2239
|
+
## earningsCallsTranscriptDiff
|
|
2240
|
+
|
|
2241
|
+
> EarningsCallsTranscriptDiff200Response earningsCallsTranscriptDiff(from, eventId, identifier, year, quarter, date, eventType, to)
|
|
2242
|
+
|
|
2243
|
+
Transcript version diff
|
|
2244
|
+
|
|
2245
|
+
Word-level diff between two transcript versions of one earnings call (over the cleaned text when both versions have it, else the verbatim text), each change anchored to the start of its speaker turn. ### Credits - Costs 5 credits; computed per request (versions are immutable). ### Choose the call - By `event_id`, or - by `identifier` with `year` + `quarter` (fiscal), or - by `identifier` with `date` (a calendar day in New York time (America/New_York); a call without a confirmed time is listed on its announced date). With `date`, `event_type` (default `earnings_call`) also addresses an investor day, conference or shareholder meeting. ### Calls without a recording - A call without a recording may carry the company\'s own transcript (`stt_provider` `company_document`): it is untimed (`null` timings) and has no cleaned layer. ### Freshness and coverage - Data is replicated from the capture pipeline with a lag of about a minute. - Only US earnings calls captured by Invinite are served. Minimum tier for rag: STANDARD.
|
|
2246
|
+
|
|
2247
|
+
### Example
|
|
2248
|
+
|
|
2249
|
+
```ts
|
|
2250
|
+
import {
|
|
2251
|
+
Configuration,
|
|
2252
|
+
EarningsCallsApi,
|
|
2253
|
+
} from '@invinite-org/data-api-client';
|
|
2254
|
+
import type { EarningsCallsTranscriptDiffRequest } from '@invinite-org/data-api-client';
|
|
2255
|
+
|
|
2256
|
+
async function example() {
|
|
2257
|
+
console.log("🚀 Testing @invinite-org/data-api-client SDK...");
|
|
2258
|
+
const config = new Configuration({
|
|
2259
|
+
// Configure HTTP bearer authorization: bearerAuth
|
|
2260
|
+
accessToken: "YOUR BEARER TOKEN",
|
|
2261
|
+
});
|
|
2262
|
+
const api = new EarningsCallsApi(config);
|
|
2263
|
+
|
|
2264
|
+
const body = {
|
|
2265
|
+
// number | Older version (one listed by transcript/versions)
|
|
2266
|
+
from: 56,
|
|
2267
|
+
// string | Event identifier (event_id of any earnings-calls response); wins over the other selectors (optional)
|
|
2268
|
+
eventId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
|
|
2269
|
+
// string | Company ticker symbol or CIK (US companies only), with year+quarter or date (optional)
|
|
2270
|
+
identifier: identifier_example,
|
|
2271
|
+
// number | Fiscal year of the call (with quarter) (optional)
|
|
2272
|
+
year: 56,
|
|
2273
|
+
// number | Fiscal quarter of the call (with year) (optional)
|
|
2274
|
+
quarter: 56,
|
|
2275
|
+
// Date | Day of the call (YYYY-MM-DD): a calendar day in New York time (America/New_York); a call without a confirmed time is listed on its announced date (optional)
|
|
2276
|
+
date: 2013-10-20,
|
|
2277
|
+
// 'earnings_call' | 'investor_day' | 'conference' | 'agm' | 'other' | Event type the date selector matches (default earnings_call): investor_day, conference, agm or other address a non-earnings event by its date; year+quarter select earnings calls only (optional)
|
|
2278
|
+
eventType: eventType_example,
|
|
2279
|
+
// number | Newer version; default = the current one (optional)
|
|
2280
|
+
to: 56,
|
|
2281
|
+
} satisfies EarningsCallsTranscriptDiffRequest;
|
|
2282
|
+
|
|
2283
|
+
try {
|
|
2284
|
+
const data = await api.earningsCallsTranscriptDiff(body);
|
|
2285
|
+
console.log(data);
|
|
2286
|
+
} catch (error) {
|
|
2287
|
+
console.error(error);
|
|
2288
|
+
}
|
|
2289
|
+
}
|
|
2290
|
+
|
|
2291
|
+
// Run the test
|
|
2292
|
+
example().catch(console.error);
|
|
2293
|
+
```
|
|
2294
|
+
|
|
2295
|
+
### Parameters
|
|
2296
|
+
|
|
2297
|
+
|
|
2298
|
+
| Name | Type | Description | Notes |
|
|
2299
|
+
|------------- | ------------- | ------------- | -------------|
|
|
2300
|
+
| **from** | `number` | Older version (one listed by transcript/versions) | [Defaults to `undefined`] |
|
|
2301
|
+
| **eventId** | `string` | Event identifier (event_id of any earnings-calls response); wins over the other selectors | [Optional] [Defaults to `undefined`] |
|
|
2302
|
+
| **identifier** | `string` | Company ticker symbol or CIK (US companies only), with year+quarter or date | [Optional] [Defaults to `undefined`] |
|
|
2303
|
+
| **year** | `number` | Fiscal year of the call (with quarter) | [Optional] [Defaults to `undefined`] |
|
|
2304
|
+
| **quarter** | `number` | Fiscal quarter of the call (with year) | [Optional] [Defaults to `undefined`] |
|
|
2305
|
+
| **date** | `Date` | Day of the call (YYYY-MM-DD): a calendar day in New York time (America/New_York); a call without a confirmed time is listed on its announced date | [Optional] [Defaults to `undefined`] |
|
|
2306
|
+
| **eventType** | `earnings_call`, `investor_day`, `conference`, `agm`, `other` | Event type the date selector matches (default earnings_call): investor_day, conference, agm or other address a non-earnings event by its date; year+quarter select earnings calls only | [Optional] [Defaults to `undefined`] [Enum: earnings_call, investor_day, conference, agm, other] |
|
|
2307
|
+
| **to** | `number` | Newer version; default = the current one | [Optional] [Defaults to `undefined`] |
|
|
2308
|
+
|
|
2309
|
+
### Return type
|
|
2310
|
+
|
|
2311
|
+
[**EarningsCallsTranscriptDiff200Response**](EarningsCallsTranscriptDiff200Response.md)
|
|
2312
|
+
|
|
2313
|
+
### Authorization
|
|
2314
|
+
|
|
2315
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
2316
|
+
|
|
2317
|
+
### HTTP request headers
|
|
2318
|
+
|
|
2319
|
+
- **Content-Type**: Not defined
|
|
2320
|
+
- **Accept**: `application/json`
|
|
2321
|
+
|
|
2322
|
+
|
|
2323
|
+
### HTTP response details
|
|
2324
|
+
| Status code | Description | Response headers |
|
|
2325
|
+
|-------------|-------------|------------------|
|
|
2326
|
+
| **200** | Default Response | - |
|
|
2327
|
+
| **400** | Bad Request - Invalid request parameters | - |
|
|
2328
|
+
| **401** | Unauthorized - Missing or invalid API key | - |
|
|
2329
|
+
| **404** | Not Found - Resource not found | - |
|
|
2330
|
+
| **422** | Default Response | - |
|
|
2331
|
+
| **500** | Internal Server Error - Server error occurred | - |
|
|
2332
|
+
|
|
2333
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
2334
|
+
|
|
2335
|
+
|
|
2336
|
+
## earningsCallsTranscriptVersions
|
|
2337
|
+
|
|
2338
|
+
> EarningsCallsTranscriptVersions200Response earningsCallsTranscriptVersions(eventId, identifier, year, quarter, date, eventType)
|
|
2339
|
+
|
|
2340
|
+
Transcript versions
|
|
2341
|
+
|
|
2342
|
+
Every published transcript version of one earnings call (`live`, `final`, `corrected`), ascending, without the text. A final version replaced by the next final (the pipeline\'s speaker-naming pass) is not a version here and cannot be requested. ### Choose the call - By `event_id`, or - by `identifier` with `year` + `quarter` (fiscal), or - by `identifier` with `date` (a calendar day in New York time (America/New_York); a call without a confirmed time is listed on its announced date). With `date`, `event_type` (default `earnings_call`) also addresses an investor day, conference or shareholder meeting. ### Freshness and coverage - Data is replicated from the capture pipeline with a lag of about a minute. - Only US earnings calls captured by Invinite are served. Minimum tier for rag: STANDARD.
|
|
2343
|
+
|
|
2344
|
+
### Example
|
|
2345
|
+
|
|
2346
|
+
```ts
|
|
2347
|
+
import {
|
|
2348
|
+
Configuration,
|
|
2349
|
+
EarningsCallsApi,
|
|
2350
|
+
} from '@invinite-org/data-api-client';
|
|
2351
|
+
import type { EarningsCallsTranscriptVersionsRequest } from '@invinite-org/data-api-client';
|
|
2352
|
+
|
|
2353
|
+
async function example() {
|
|
2354
|
+
console.log("🚀 Testing @invinite-org/data-api-client SDK...");
|
|
2355
|
+
const config = new Configuration({
|
|
2356
|
+
// Configure HTTP bearer authorization: bearerAuth
|
|
2357
|
+
accessToken: "YOUR BEARER TOKEN",
|
|
2358
|
+
});
|
|
2359
|
+
const api = new EarningsCallsApi(config);
|
|
2360
|
+
|
|
2361
|
+
const body = {
|
|
2362
|
+
// string | Event identifier (event_id of any earnings-calls response); wins over the other selectors (optional)
|
|
2363
|
+
eventId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
|
|
2364
|
+
// string | Company ticker symbol or CIK (US companies only), with year+quarter or date (optional)
|
|
2365
|
+
identifier: identifier_example,
|
|
2366
|
+
// number | Fiscal year of the call (with quarter) (optional)
|
|
2367
|
+
year: 56,
|
|
2368
|
+
// number | Fiscal quarter of the call (with year) (optional)
|
|
2369
|
+
quarter: 56,
|
|
2370
|
+
// Date | Day of the call (YYYY-MM-DD): a calendar day in New York time (America/New_York); a call without a confirmed time is listed on its announced date (optional)
|
|
2371
|
+
date: 2013-10-20,
|
|
2372
|
+
// 'earnings_call' | 'investor_day' | 'conference' | 'agm' | 'other' | Event type the date selector matches (default earnings_call): investor_day, conference, agm or other address a non-earnings event by its date; year+quarter select earnings calls only (optional)
|
|
2373
|
+
eventType: eventType_example,
|
|
2374
|
+
} satisfies EarningsCallsTranscriptVersionsRequest;
|
|
2375
|
+
|
|
2376
|
+
try {
|
|
2377
|
+
const data = await api.earningsCallsTranscriptVersions(body);
|
|
2378
|
+
console.log(data);
|
|
2379
|
+
} catch (error) {
|
|
2380
|
+
console.error(error);
|
|
2381
|
+
}
|
|
2382
|
+
}
|
|
2383
|
+
|
|
2384
|
+
// Run the test
|
|
2385
|
+
example().catch(console.error);
|
|
2386
|
+
```
|
|
2387
|
+
|
|
2388
|
+
### Parameters
|
|
2389
|
+
|
|
2390
|
+
|
|
2391
|
+
| Name | Type | Description | Notes |
|
|
2392
|
+
|------------- | ------------- | ------------- | -------------|
|
|
2393
|
+
| **eventId** | `string` | Event identifier (event_id of any earnings-calls response); wins over the other selectors | [Optional] [Defaults to `undefined`] |
|
|
2394
|
+
| **identifier** | `string` | Company ticker symbol or CIK (US companies only), with year+quarter or date | [Optional] [Defaults to `undefined`] |
|
|
2395
|
+
| **year** | `number` | Fiscal year of the call (with quarter) | [Optional] [Defaults to `undefined`] |
|
|
2396
|
+
| **quarter** | `number` | Fiscal quarter of the call (with year) | [Optional] [Defaults to `undefined`] |
|
|
2397
|
+
| **date** | `Date` | Day of the call (YYYY-MM-DD): a calendar day in New York time (America/New_York); a call without a confirmed time is listed on its announced date | [Optional] [Defaults to `undefined`] |
|
|
2398
|
+
| **eventType** | `earnings_call`, `investor_day`, `conference`, `agm`, `other` | Event type the date selector matches (default earnings_call): investor_day, conference, agm or other address a non-earnings event by its date; year+quarter select earnings calls only | [Optional] [Defaults to `undefined`] [Enum: earnings_call, investor_day, conference, agm, other] |
|
|
2399
|
+
|
|
2400
|
+
### Return type
|
|
2401
|
+
|
|
2402
|
+
[**EarningsCallsTranscriptVersions200Response**](EarningsCallsTranscriptVersions200Response.md)
|
|
2403
|
+
|
|
2404
|
+
### Authorization
|
|
2405
|
+
|
|
2406
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
2407
|
+
|
|
2408
|
+
### HTTP request headers
|
|
2409
|
+
|
|
2410
|
+
- **Content-Type**: Not defined
|
|
2411
|
+
- **Accept**: `application/json`
|
|
2412
|
+
|
|
2413
|
+
|
|
2414
|
+
### HTTP response details
|
|
2415
|
+
| Status code | Description | Response headers |
|
|
2416
|
+
|-------------|-------------|------------------|
|
|
2417
|
+
| **200** | Default Response | - |
|
|
2418
|
+
| **400** | Bad Request - Invalid request parameters | - |
|
|
2419
|
+
| **401** | Unauthorized - Missing or invalid API key | - |
|
|
2420
|
+
| **404** | Not Found - Resource not found | - |
|
|
2421
|
+
| **500** | Internal Server Error - Server error occurred | - |
|
|
2422
|
+
|
|
2423
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
2424
|
+
|
|
2425
|
+
|
|
2426
|
+
## earningsCallsWebhooksCreate
|
|
2427
|
+
|
|
2428
|
+
> EarningsCallsWebhooksCreate201Response earningsCallsWebhooksCreate(earningsCallsWebhooksCreateRequest)
|
|
2429
|
+
|
|
2430
|
+
Create a webhook
|
|
2431
|
+
|
|
2432
|
+
Create a webhook subscription (at most 5 / 15 / 50 per account on LITE / STANDARD / PRO; 403 plan_limit beyond the plan\'s webhooks, events, CIKs or keywords). The response carries the signing secret exactly once. The URL must be https on port 443 and resolve to public addresses only (400 invalid_webhook_url names the reason). Earnings-call webhooks (LITE and above; webhook count, events, CIKs and keywords by plan — see the Webhooks section of the API description): signed, retried POSTs of the earnings_call.* lifecycle events, see x-webhooks. Minimum tier for display: FREE.
|
|
2433
|
+
|
|
2434
|
+
### Example
|
|
2435
|
+
|
|
2436
|
+
```ts
|
|
2437
|
+
import {
|
|
2438
|
+
Configuration,
|
|
2439
|
+
EarningsCallsApi,
|
|
2440
|
+
} from '@invinite-org/data-api-client';
|
|
2441
|
+
import type { EarningsCallsWebhooksCreateOperationRequest } from '@invinite-org/data-api-client';
|
|
2442
|
+
|
|
2443
|
+
async function example() {
|
|
2444
|
+
console.log("🚀 Testing @invinite-org/data-api-client SDK...");
|
|
2445
|
+
const config = new Configuration({
|
|
2446
|
+
// Configure HTTP bearer authorization: bearerAuth
|
|
2447
|
+
accessToken: "YOUR BEARER TOKEN",
|
|
2448
|
+
});
|
|
2449
|
+
const api = new EarningsCallsApi(config);
|
|
2450
|
+
|
|
2451
|
+
const body = {
|
|
2452
|
+
// EarningsCallsWebhooksCreateRequest
|
|
2453
|
+
earningsCallsWebhooksCreateRequest: ...,
|
|
2454
|
+
} satisfies EarningsCallsWebhooksCreateOperationRequest;
|
|
2455
|
+
|
|
2456
|
+
try {
|
|
2457
|
+
const data = await api.earningsCallsWebhooksCreate(body);
|
|
2458
|
+
console.log(data);
|
|
2459
|
+
} catch (error) {
|
|
2460
|
+
console.error(error);
|
|
2461
|
+
}
|
|
2462
|
+
}
|
|
2463
|
+
|
|
2464
|
+
// Run the test
|
|
2465
|
+
example().catch(console.error);
|
|
2466
|
+
```
|
|
2467
|
+
|
|
2468
|
+
### Parameters
|
|
2469
|
+
|
|
2470
|
+
|
|
2471
|
+
| Name | Type | Description | Notes |
|
|
2472
|
+
|------------- | ------------- | ------------- | -------------|
|
|
2473
|
+
| **earningsCallsWebhooksCreateRequest** | [EarningsCallsWebhooksCreateRequest](EarningsCallsWebhooksCreateRequest.md) | | |
|
|
2474
|
+
|
|
2475
|
+
### Return type
|
|
2476
|
+
|
|
2477
|
+
[**EarningsCallsWebhooksCreate201Response**](EarningsCallsWebhooksCreate201Response.md)
|
|
2478
|
+
|
|
2479
|
+
### Authorization
|
|
2480
|
+
|
|
2481
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
2482
|
+
|
|
2483
|
+
### HTTP request headers
|
|
2484
|
+
|
|
2485
|
+
- **Content-Type**: `application/json`
|
|
2486
|
+
- **Accept**: `application/json`
|
|
2487
|
+
|
|
2488
|
+
|
|
2489
|
+
### HTTP response details
|
|
2490
|
+
| Status code | Description | Response headers |
|
|
2491
|
+
|-------------|-------------|------------------|
|
|
2492
|
+
| **201** | Default Response | - |
|
|
2493
|
+
| **400** | Bad Request - Invalid request parameters | - |
|
|
2494
|
+
| **401** | Unauthorized - Missing or invalid API key | - |
|
|
2495
|
+
| **403** | Forbidden - the plan does not include webhooks (FREE), or the requested events / CIKs / keywords exceed the plan\'s webhook limits | - |
|
|
2496
|
+
| **404** | Not Found - Resource not found | - |
|
|
2497
|
+
| **409** | Conflict - the plan\'s webhook count is reached (5 LITE / 15 STANDARD / 50 PRO) | - |
|
|
2498
|
+
| **500** | Internal Server Error - Server error occurred | - |
|
|
2499
|
+
| **503** | Service Unavailable - subscriptions or deliveries are temporarily unavailable | - |
|
|
2500
|
+
|
|
2501
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
2502
|
+
|
|
2503
|
+
|
|
2504
|
+
## earningsCallsWebhooksDelete
|
|
2505
|
+
|
|
2506
|
+
> earningsCallsWebhooksDelete(id)
|
|
2507
|
+
|
|
2508
|
+
Delete a webhook
|
|
2509
|
+
|
|
2510
|
+
Delete a webhook subscription. Earnings-call webhooks (LITE and above; webhook count, events, CIKs and keywords by plan — see the Webhooks section of the API description): signed, retried POSTs of the earnings_call.* lifecycle events, see x-webhooks. Minimum tier for display: FREE.
|
|
2511
|
+
|
|
2512
|
+
### Example
|
|
2513
|
+
|
|
2514
|
+
```ts
|
|
2515
|
+
import {
|
|
2516
|
+
Configuration,
|
|
2517
|
+
EarningsCallsApi,
|
|
2518
|
+
} from '@invinite-org/data-api-client';
|
|
2519
|
+
import type { EarningsCallsWebhooksDeleteRequest } from '@invinite-org/data-api-client';
|
|
2520
|
+
|
|
2521
|
+
async function example() {
|
|
2522
|
+
console.log("🚀 Testing @invinite-org/data-api-client SDK...");
|
|
2523
|
+
const config = new Configuration({
|
|
2524
|
+
// Configure HTTP bearer authorization: bearerAuth
|
|
2525
|
+
accessToken: "YOUR BEARER TOKEN",
|
|
2526
|
+
});
|
|
2527
|
+
const api = new EarningsCallsApi(config);
|
|
2528
|
+
|
|
2529
|
+
const body = {
|
|
2530
|
+
// string | Webhook subscription id (from the create / list response)
|
|
2531
|
+
id: id_example,
|
|
2532
|
+
} satisfies EarningsCallsWebhooksDeleteRequest;
|
|
2533
|
+
|
|
2534
|
+
try {
|
|
2535
|
+
const data = await api.earningsCallsWebhooksDelete(body);
|
|
2536
|
+
console.log(data);
|
|
2537
|
+
} catch (error) {
|
|
2538
|
+
console.error(error);
|
|
2539
|
+
}
|
|
2540
|
+
}
|
|
2541
|
+
|
|
2542
|
+
// Run the test
|
|
2543
|
+
example().catch(console.error);
|
|
2544
|
+
```
|
|
2545
|
+
|
|
2546
|
+
### Parameters
|
|
2547
|
+
|
|
2548
|
+
|
|
2549
|
+
| Name | Type | Description | Notes |
|
|
2550
|
+
|------------- | ------------- | ------------- | -------------|
|
|
2551
|
+
| **id** | `string` | Webhook subscription id (from the create / list response) | [Defaults to `undefined`] |
|
|
2552
|
+
|
|
2553
|
+
### Return type
|
|
2554
|
+
|
|
2555
|
+
`void` (Empty response body)
|
|
2556
|
+
|
|
2557
|
+
### Authorization
|
|
2558
|
+
|
|
2559
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
2560
|
+
|
|
2561
|
+
### HTTP request headers
|
|
2562
|
+
|
|
2563
|
+
- **Content-Type**: Not defined
|
|
2564
|
+
- **Accept**: `application/json`
|
|
2565
|
+
|
|
2566
|
+
|
|
2567
|
+
### HTTP response details
|
|
2568
|
+
| Status code | Description | Response headers |
|
|
2569
|
+
|-------------|-------------|------------------|
|
|
2570
|
+
| **204** | Deleted | - |
|
|
2571
|
+
| **400** | Bad Request - Invalid request parameters | - |
|
|
2572
|
+
| **401** | Unauthorized - Missing or invalid API key | - |
|
|
2573
|
+
| **403** | Forbidden - the plan does not include webhooks (FREE), or the requested events / CIKs / keywords exceed the plan\'s webhook limits | - |
|
|
2574
|
+
| **404** | Not Found - Resource not found | - |
|
|
2575
|
+
| **500** | Internal Server Error - Server error occurred | - |
|
|
2576
|
+
| **503** | Service Unavailable - subscriptions or deliveries are temporarily unavailable | - |
|
|
2577
|
+
|
|
2578
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
2579
|
+
|
|
2580
|
+
|
|
2581
|
+
## earningsCallsWebhooksDeliveries
|
|
2582
|
+
|
|
2583
|
+
> EarningsCallsWebhooksDeliveries200Response earningsCallsWebhooksDeliveries(id)
|
|
2584
|
+
|
|
2585
|
+
Webhook delivery attempts
|
|
2586
|
+
|
|
2587
|
+
The last 100 delivery attempts of a subscription, newest first, with status and duration (kept 7 days). Earnings-call webhooks (LITE and above; webhook count, events, CIKs and keywords by plan — see the Webhooks section of the API description): signed, retried POSTs of the earnings_call.* lifecycle events, see x-webhooks. Minimum tier for display: FREE.
|
|
2588
|
+
|
|
2589
|
+
### Example
|
|
2590
|
+
|
|
2591
|
+
```ts
|
|
2592
|
+
import {
|
|
2593
|
+
Configuration,
|
|
2594
|
+
EarningsCallsApi,
|
|
2595
|
+
} from '@invinite-org/data-api-client';
|
|
2596
|
+
import type { EarningsCallsWebhooksDeliveriesRequest } from '@invinite-org/data-api-client';
|
|
2597
|
+
|
|
2598
|
+
async function example() {
|
|
2599
|
+
console.log("🚀 Testing @invinite-org/data-api-client SDK...");
|
|
2600
|
+
const config = new Configuration({
|
|
2601
|
+
// Configure HTTP bearer authorization: bearerAuth
|
|
2602
|
+
accessToken: "YOUR BEARER TOKEN",
|
|
2603
|
+
});
|
|
2604
|
+
const api = new EarningsCallsApi(config);
|
|
2605
|
+
|
|
2606
|
+
const body = {
|
|
2607
|
+
// string | Webhook subscription id (from the create / list response)
|
|
2608
|
+
id: id_example,
|
|
2609
|
+
} satisfies EarningsCallsWebhooksDeliveriesRequest;
|
|
2610
|
+
|
|
2611
|
+
try {
|
|
2612
|
+
const data = await api.earningsCallsWebhooksDeliveries(body);
|
|
2613
|
+
console.log(data);
|
|
2614
|
+
} catch (error) {
|
|
2615
|
+
console.error(error);
|
|
2616
|
+
}
|
|
2617
|
+
}
|
|
2618
|
+
|
|
2619
|
+
// Run the test
|
|
2620
|
+
example().catch(console.error);
|
|
2621
|
+
```
|
|
2622
|
+
|
|
2623
|
+
### Parameters
|
|
2624
|
+
|
|
2625
|
+
|
|
2626
|
+
| Name | Type | Description | Notes |
|
|
2627
|
+
|------------- | ------------- | ------------- | -------------|
|
|
2628
|
+
| **id** | `string` | Webhook subscription id (from the create / list response) | [Defaults to `undefined`] |
|
|
2629
|
+
|
|
2630
|
+
### Return type
|
|
2631
|
+
|
|
2632
|
+
[**EarningsCallsWebhooksDeliveries200Response**](EarningsCallsWebhooksDeliveries200Response.md)
|
|
2633
|
+
|
|
2634
|
+
### Authorization
|
|
2635
|
+
|
|
2636
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
2637
|
+
|
|
2638
|
+
### HTTP request headers
|
|
2639
|
+
|
|
2640
|
+
- **Content-Type**: Not defined
|
|
2641
|
+
- **Accept**: `application/json`
|
|
2642
|
+
|
|
2643
|
+
|
|
2644
|
+
### HTTP response details
|
|
2645
|
+
| Status code | Description | Response headers |
|
|
2646
|
+
|-------------|-------------|------------------|
|
|
2647
|
+
| **200** | Default Response | - |
|
|
2648
|
+
| **400** | Bad Request - Invalid request parameters | - |
|
|
2649
|
+
| **401** | Unauthorized - Missing or invalid API key | - |
|
|
2650
|
+
| **403** | Forbidden - the plan does not include webhooks (FREE), or the requested events / CIKs / keywords exceed the plan\'s webhook limits | - |
|
|
2651
|
+
| **404** | Not Found - Resource not found | - |
|
|
2652
|
+
| **500** | Internal Server Error - Server error occurred | - |
|
|
2653
|
+
| **503** | Service Unavailable - subscriptions or deliveries are temporarily unavailable | - |
|
|
2654
|
+
|
|
2655
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
2656
|
+
|
|
2657
|
+
|
|
2658
|
+
## earningsCallsWebhooksList
|
|
2659
|
+
|
|
2660
|
+
> EarningsCallsWebhooksList200Response earningsCallsWebhooksList()
|
|
2661
|
+
|
|
2662
|
+
List webhooks
|
|
2663
|
+
|
|
2664
|
+
List the account\'s webhook subscriptions (secrets are never returned). Earnings-call webhooks (LITE and above; webhook count, events, CIKs and keywords by plan — see the Webhooks section of the API description): signed, retried POSTs of the earnings_call.* lifecycle events, see x-webhooks. Minimum tier for display: FREE.
|
|
2665
|
+
|
|
2666
|
+
### Example
|
|
2667
|
+
|
|
2668
|
+
```ts
|
|
2669
|
+
import {
|
|
2670
|
+
Configuration,
|
|
2671
|
+
EarningsCallsApi,
|
|
2672
|
+
} from '@invinite-org/data-api-client';
|
|
2673
|
+
import type { EarningsCallsWebhooksListRequest } from '@invinite-org/data-api-client';
|
|
2674
|
+
|
|
2675
|
+
async function example() {
|
|
2676
|
+
console.log("🚀 Testing @invinite-org/data-api-client SDK...");
|
|
2677
|
+
const config = new Configuration({
|
|
2678
|
+
// Configure HTTP bearer authorization: bearerAuth
|
|
2679
|
+
accessToken: "YOUR BEARER TOKEN",
|
|
2680
|
+
});
|
|
2681
|
+
const api = new EarningsCallsApi(config);
|
|
2682
|
+
|
|
2683
|
+
try {
|
|
2684
|
+
const data = await api.earningsCallsWebhooksList();
|
|
2685
|
+
console.log(data);
|
|
2686
|
+
} catch (error) {
|
|
2687
|
+
console.error(error);
|
|
2688
|
+
}
|
|
2689
|
+
}
|
|
2690
|
+
|
|
2691
|
+
// Run the test
|
|
2692
|
+
example().catch(console.error);
|
|
2693
|
+
```
|
|
2694
|
+
|
|
2695
|
+
### Parameters
|
|
2696
|
+
|
|
2697
|
+
This endpoint does not need any parameter.
|
|
2698
|
+
|
|
2699
|
+
### Return type
|
|
2700
|
+
|
|
2701
|
+
[**EarningsCallsWebhooksList200Response**](EarningsCallsWebhooksList200Response.md)
|
|
2702
|
+
|
|
2703
|
+
### Authorization
|
|
2704
|
+
|
|
2705
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
2706
|
+
|
|
2707
|
+
### HTTP request headers
|
|
2708
|
+
|
|
2709
|
+
- **Content-Type**: Not defined
|
|
2710
|
+
- **Accept**: `application/json`
|
|
2711
|
+
|
|
2712
|
+
|
|
2713
|
+
### HTTP response details
|
|
2714
|
+
| Status code | Description | Response headers |
|
|
2715
|
+
|-------------|-------------|------------------|
|
|
2716
|
+
| **200** | Default Response | - |
|
|
2717
|
+
| **400** | Bad Request - Invalid request parameters | - |
|
|
2718
|
+
| **401** | Unauthorized - Missing or invalid API key | - |
|
|
2719
|
+
| **403** | Forbidden - the plan does not include webhooks (FREE), or the requested events / CIKs / keywords exceed the plan\'s webhook limits | - |
|
|
2720
|
+
| **404** | Not Found - Resource not found | - |
|
|
2721
|
+
| **500** | Internal Server Error - Server error occurred | - |
|
|
2722
|
+
| **503** | Service Unavailable - subscriptions or deliveries are temporarily unavailable | - |
|
|
2723
|
+
|
|
2724
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
2725
|
+
|
|
2726
|
+
|
|
2727
|
+
## earningsCallsWebhooksRotateSecret
|
|
2728
|
+
|
|
2729
|
+
> EarningsCallsWebhooksRotateSecret200Response earningsCallsWebhooksRotateSecret(id)
|
|
2730
|
+
|
|
2731
|
+
Rotate a webhook signing secret
|
|
2732
|
+
|
|
2733
|
+
Rotate the signing secret. The new secret is returned once; the old one stays valid for 5 minutes (deliveries carry one v1 signature per valid secret). Earnings-call webhooks (LITE and above; webhook count, events, CIKs and keywords by plan — see the Webhooks section of the API description): signed, retried POSTs of the earnings_call.* lifecycle events, see x-webhooks. Minimum tier for display: FREE.
|
|
2734
|
+
|
|
2735
|
+
### Example
|
|
2736
|
+
|
|
2737
|
+
```ts
|
|
2738
|
+
import {
|
|
2739
|
+
Configuration,
|
|
2740
|
+
EarningsCallsApi,
|
|
2741
|
+
} from '@invinite-org/data-api-client';
|
|
2742
|
+
import type { EarningsCallsWebhooksRotateSecretRequest } from '@invinite-org/data-api-client';
|
|
2743
|
+
|
|
2744
|
+
async function example() {
|
|
2745
|
+
console.log("🚀 Testing @invinite-org/data-api-client SDK...");
|
|
2746
|
+
const config = new Configuration({
|
|
2747
|
+
// Configure HTTP bearer authorization: bearerAuth
|
|
2748
|
+
accessToken: "YOUR BEARER TOKEN",
|
|
2749
|
+
});
|
|
2750
|
+
const api = new EarningsCallsApi(config);
|
|
2751
|
+
|
|
2752
|
+
const body = {
|
|
2753
|
+
// string | Webhook subscription id (from the create / list response)
|
|
2754
|
+
id: id_example,
|
|
2755
|
+
} satisfies EarningsCallsWebhooksRotateSecretRequest;
|
|
2756
|
+
|
|
2757
|
+
try {
|
|
2758
|
+
const data = await api.earningsCallsWebhooksRotateSecret(body);
|
|
2759
|
+
console.log(data);
|
|
2760
|
+
} catch (error) {
|
|
2761
|
+
console.error(error);
|
|
2762
|
+
}
|
|
2763
|
+
}
|
|
2764
|
+
|
|
2765
|
+
// Run the test
|
|
2766
|
+
example().catch(console.error);
|
|
2767
|
+
```
|
|
2768
|
+
|
|
2769
|
+
### Parameters
|
|
2770
|
+
|
|
2771
|
+
|
|
2772
|
+
| Name | Type | Description | Notes |
|
|
2773
|
+
|------------- | ------------- | ------------- | -------------|
|
|
2774
|
+
| **id** | `string` | Webhook subscription id (from the create / list response) | [Defaults to `undefined`] |
|
|
2775
|
+
|
|
2776
|
+
### Return type
|
|
2777
|
+
|
|
2778
|
+
[**EarningsCallsWebhooksRotateSecret200Response**](EarningsCallsWebhooksRotateSecret200Response.md)
|
|
2779
|
+
|
|
2780
|
+
### Authorization
|
|
2781
|
+
|
|
2782
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
2783
|
+
|
|
2784
|
+
### HTTP request headers
|
|
2785
|
+
|
|
2786
|
+
- **Content-Type**: Not defined
|
|
2787
|
+
- **Accept**: `application/json`
|
|
2788
|
+
|
|
2789
|
+
|
|
2790
|
+
### HTTP response details
|
|
2791
|
+
| Status code | Description | Response headers |
|
|
2792
|
+
|-------------|-------------|------------------|
|
|
2793
|
+
| **200** | Default Response | - |
|
|
2794
|
+
| **400** | Bad Request - Invalid request parameters | - |
|
|
2795
|
+
| **401** | Unauthorized - Missing or invalid API key | - |
|
|
2796
|
+
| **403** | Forbidden - the plan does not include webhooks (FREE), or the requested events / CIKs / keywords exceed the plan\'s webhook limits | - |
|
|
2797
|
+
| **404** | Not Found - Resource not found | - |
|
|
2798
|
+
| **500** | Internal Server Error - Server error occurred | - |
|
|
2799
|
+
| **503** | Service Unavailable - subscriptions or deliveries are temporarily unavailable | - |
|
|
2800
|
+
|
|
2801
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
2802
|
+
|
|
2803
|
+
|
|
2804
|
+
## earningsCallsWebhooksTest
|
|
2805
|
+
|
|
2806
|
+
> EarningsCallsWebhooksTest202Response earningsCallsWebhooksTest(id)
|
|
2807
|
+
|
|
2808
|
+
Send a test delivery
|
|
2809
|
+
|
|
2810
|
+
Send a signed `ping` delivery to the subscription. Earnings-call webhooks (LITE and above; webhook count, events, CIKs and keywords by plan — see the Webhooks section of the API description): signed, retried POSTs of the earnings_call.* lifecycle events, see x-webhooks. Minimum tier for display: FREE.
|
|
2811
|
+
|
|
2812
|
+
### Example
|
|
2813
|
+
|
|
2814
|
+
```ts
|
|
2815
|
+
import {
|
|
2816
|
+
Configuration,
|
|
2817
|
+
EarningsCallsApi,
|
|
2818
|
+
} from '@invinite-org/data-api-client';
|
|
2819
|
+
import type { EarningsCallsWebhooksTestRequest } from '@invinite-org/data-api-client';
|
|
2820
|
+
|
|
2821
|
+
async function example() {
|
|
2822
|
+
console.log("🚀 Testing @invinite-org/data-api-client SDK...");
|
|
2823
|
+
const config = new Configuration({
|
|
2824
|
+
// Configure HTTP bearer authorization: bearerAuth
|
|
2825
|
+
accessToken: "YOUR BEARER TOKEN",
|
|
2826
|
+
});
|
|
2827
|
+
const api = new EarningsCallsApi(config);
|
|
2828
|
+
|
|
2829
|
+
const body = {
|
|
2830
|
+
// string | Webhook subscription id (from the create / list response)
|
|
2831
|
+
id: id_example,
|
|
2832
|
+
} satisfies EarningsCallsWebhooksTestRequest;
|
|
2833
|
+
|
|
2834
|
+
try {
|
|
2835
|
+
const data = await api.earningsCallsWebhooksTest(body);
|
|
2836
|
+
console.log(data);
|
|
2837
|
+
} catch (error) {
|
|
2838
|
+
console.error(error);
|
|
2839
|
+
}
|
|
2840
|
+
}
|
|
2841
|
+
|
|
2842
|
+
// Run the test
|
|
2843
|
+
example().catch(console.error);
|
|
2844
|
+
```
|
|
2845
|
+
|
|
2846
|
+
### Parameters
|
|
2847
|
+
|
|
2848
|
+
|
|
2849
|
+
| Name | Type | Description | Notes |
|
|
2850
|
+
|------------- | ------------- | ------------- | -------------|
|
|
2851
|
+
| **id** | `string` | Webhook subscription id (from the create / list response) | [Defaults to `undefined`] |
|
|
2852
|
+
|
|
2853
|
+
### Return type
|
|
2854
|
+
|
|
2855
|
+
[**EarningsCallsWebhooksTest202Response**](EarningsCallsWebhooksTest202Response.md)
|
|
2856
|
+
|
|
2857
|
+
### Authorization
|
|
2858
|
+
|
|
2859
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
2860
|
+
|
|
2861
|
+
### HTTP request headers
|
|
2862
|
+
|
|
2863
|
+
- **Content-Type**: Not defined
|
|
2864
|
+
- **Accept**: `application/json`
|
|
2865
|
+
|
|
2866
|
+
|
|
2867
|
+
### HTTP response details
|
|
2868
|
+
| Status code | Description | Response headers |
|
|
2869
|
+
|-------------|-------------|------------------|
|
|
2870
|
+
| **202** | Default Response | - |
|
|
2871
|
+
| **400** | Bad Request - Invalid request parameters | - |
|
|
2872
|
+
| **401** | Unauthorized - Missing or invalid API key | - |
|
|
2873
|
+
| **403** | Forbidden - the plan does not include webhooks (FREE), or the requested events / CIKs / keywords exceed the plan\'s webhook limits | - |
|
|
2874
|
+
| **404** | Not Found - Resource not found | - |
|
|
2875
|
+
| **409** | Conflict - the subscription is disabled | - |
|
|
2876
|
+
| **500** | Internal Server Error - Server error occurred | - |
|
|
2877
|
+
| **503** | Service Unavailable - subscriptions or deliveries are temporarily unavailable | - |
|
|
2878
|
+
|
|
2879
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
2880
|
+
|
|
2881
|
+
|
|
2882
|
+
## earningsCallsWebhooksUpdate
|
|
2883
|
+
|
|
2884
|
+
> EarningsCallsWebhooksList200ResponseDataInner earningsCallsWebhooksUpdate(id, earningsCallsWebhooksUpdateRequest)
|
|
2885
|
+
|
|
2886
|
+
Update a webhook
|
|
2887
|
+
|
|
2888
|
+
Change a webhook subscription\'s keywords, companies, events or active flag (at least one field). active: true re-enables a subscription disabled after failed deliveries. Earnings-call webhooks (LITE and above; webhook count, events, CIKs and keywords by plan — see the Webhooks section of the API description): signed, retried POSTs of the earnings_call.* lifecycle events, see x-webhooks. Minimum tier for display: FREE.
|
|
2889
|
+
|
|
2890
|
+
### Example
|
|
2891
|
+
|
|
2892
|
+
```ts
|
|
2893
|
+
import {
|
|
2894
|
+
Configuration,
|
|
2895
|
+
EarningsCallsApi,
|
|
2896
|
+
} from '@invinite-org/data-api-client';
|
|
2897
|
+
import type { EarningsCallsWebhooksUpdateOperationRequest } from '@invinite-org/data-api-client';
|
|
2898
|
+
|
|
2899
|
+
async function example() {
|
|
2900
|
+
console.log("🚀 Testing @invinite-org/data-api-client SDK...");
|
|
2901
|
+
const config = new Configuration({
|
|
2902
|
+
// Configure HTTP bearer authorization: bearerAuth
|
|
2903
|
+
accessToken: "YOUR BEARER TOKEN",
|
|
2904
|
+
});
|
|
2905
|
+
const api = new EarningsCallsApi(config);
|
|
2906
|
+
|
|
2907
|
+
const body = {
|
|
2908
|
+
// string | Webhook subscription id (from the create / list response)
|
|
2909
|
+
id: id_example,
|
|
2910
|
+
// EarningsCallsWebhooksUpdateRequest | Any of the four fields; at least one (optional)
|
|
2911
|
+
earningsCallsWebhooksUpdateRequest: ...,
|
|
2912
|
+
} satisfies EarningsCallsWebhooksUpdateOperationRequest;
|
|
2913
|
+
|
|
2914
|
+
try {
|
|
2915
|
+
const data = await api.earningsCallsWebhooksUpdate(body);
|
|
2916
|
+
console.log(data);
|
|
2917
|
+
} catch (error) {
|
|
2918
|
+
console.error(error);
|
|
2919
|
+
}
|
|
2920
|
+
}
|
|
2921
|
+
|
|
2922
|
+
// Run the test
|
|
2923
|
+
example().catch(console.error);
|
|
2924
|
+
```
|
|
2925
|
+
|
|
2926
|
+
### Parameters
|
|
2927
|
+
|
|
2928
|
+
|
|
2929
|
+
| Name | Type | Description | Notes |
|
|
2930
|
+
|------------- | ------------- | ------------- | -------------|
|
|
2931
|
+
| **id** | `string` | Webhook subscription id (from the create / list response) | [Defaults to `undefined`] |
|
|
2932
|
+
| **earningsCallsWebhooksUpdateRequest** | [EarningsCallsWebhooksUpdateRequest](EarningsCallsWebhooksUpdateRequest.md) | Any of the four fields; at least one | [Optional] |
|
|
2933
|
+
|
|
2934
|
+
### Return type
|
|
2935
|
+
|
|
2936
|
+
[**EarningsCallsWebhooksList200ResponseDataInner**](EarningsCallsWebhooksList200ResponseDataInner.md)
|
|
2937
|
+
|
|
2938
|
+
### Authorization
|
|
2939
|
+
|
|
2940
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
2941
|
+
|
|
2942
|
+
### HTTP request headers
|
|
2943
|
+
|
|
2944
|
+
- **Content-Type**: `application/json`
|
|
2945
|
+
- **Accept**: `application/json`
|
|
2946
|
+
|
|
2947
|
+
|
|
2948
|
+
### HTTP response details
|
|
2949
|
+
| Status code | Description | Response headers |
|
|
2950
|
+
|-------------|-------------|------------------|
|
|
2951
|
+
| **200** | Default Response | - |
|
|
2952
|
+
| **400** | Bad Request - Invalid request parameters | - |
|
|
2953
|
+
| **401** | Unauthorized - Missing or invalid API key | - |
|
|
2954
|
+
| **403** | Forbidden - the plan does not include webhooks (FREE), or the requested events / CIKs / keywords exceed the plan\'s webhook limits | - |
|
|
2955
|
+
| **404** | Not Found - Resource not found | - |
|
|
2956
|
+
| **500** | Internal Server Error - Server error occurred | - |
|
|
2957
|
+
| **503** | Service Unavailable - subscriptions or deliveries are temporarily unavailable | - |
|
|
2958
|
+
|
|
2959
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
2960
|
+
|