Schemas
Reusable definitions exposed by the product OpenAPI contract.
Archive
{
"type": "object",
"additionalProperties": false,
"required": [
"archiveCik",
"sourcePath",
"completeSubmissionUrl"
],
"properties": {
"archiveCik": {
"type": [
"string",
"null"
],
"pattern": "^[0-9]{10}$"
},
"sourcePath": {
"type": [
"string",
"null"
]
},
"completeSubmissionUrl": {
"type": [
"string",
"null"
],
"format": "uri"
}
}
}CompanyBeneficialOwnershipPosition
{
"type": "object",
"additionalProperties": false,
"required": [
"owner",
"company",
"security",
"position",
"materialContinuity",
"filing",
"version",
"sources"
],
"properties": {
"owner": {
"type": "object",
"additionalProperties": false,
"required": [
"personId",
"name"
],
"properties": {
"personId": {
"type": "string"
},
"name": {
"type": "string"
}
}
},
"company": {
"type": "object",
"additionalProperties": false,
"required": [
"companyId",
"name",
"secIssuerCik"
],
"properties": {
"companyId": {
"type": "string"
},
"name": {
"type": "string"
},
"secIssuerCik": {
"type": "string",
"pattern": "^[0-9]{10}$"
}
}
},
"security": {
"type": "object",
"additionalProperties": false,
"required": [
"legalSecurityId",
"name",
"securityType",
"ticker",
"exchange"
],
"properties": {
"legalSecurityId": {
"type": "string"
},
"name": {
"type": "string"
},
"securityType": {
"type": "string"
},
"ticker": {
"type": [
"string",
"null"
]
},
"exchange": {
"type": [
"string",
"null"
]
}
}
},
"position": {
"type": "object",
"additionalProperties": false,
"required": [
"ownershipKind",
"relationshipState",
"reportedShares",
"reportedAsOfDate",
"valuationTreatment"
],
"properties": {
"ownershipKind": {
"type": "string",
"const": "beneficial-aggregate"
},
"relationshipState": {
"type": "string"
},
"reportedShares": {
"type": "string",
"pattern": "^[0-9]+$"
},
"reportedAsOfDate": {
"type": "string",
"format": "date"
},
"valuationTreatment": {
"type": "string"
}
}
},
"materialContinuity": {
"type": "object",
"additionalProperties": false,
"required": [
"methodologyVersion",
"throughDate",
"exactShareCountReobserved"
],
"properties": {
"methodologyVersion": {
"type": "string",
"const": "schedule13-material-continuity-v1"
},
"throughDate": {
"type": "string",
"format": "date"
},
"exactShareCountReobserved": {
"type": "boolean",
"const": false
}
}
},
"filing": {
"type": "object",
"additionalProperties": false,
"required": [
"accessionNumber"
],
"properties": {
"accessionNumber": {
"type": "string",
"pattern": "^[0-9]{10}-[0-9]{2}-[0-9]{6}$"
}
}
},
"version": {
"type": "object",
"additionalProperties": false,
"required": [
"versionId",
"knowledgeRecordedAt",
"knowledgeValidFrom",
"knowledgeValidThrough"
],
"properties": {
"versionId": {
"type": "string"
},
"knowledgeRecordedAt": {
"type": "string",
"format": "date-time"
},
"knowledgeValidFrom": {
"type": "string",
"format": "date-time"
},
"knowledgeValidThrough": {
"type": [
"string",
"null"
],
"format": "date-time"
}
}
},
"sources": {
"type": "array",
"minItems": 1,
"items": {
"$ref": "#/components/schemas/CompanyOwnershipSource"
}
}
}
}CompanyFinancialsResponse
{
"type": "object",
"additionalProperties": false,
"required": [
"data",
"meta"
],
"properties": {
"data": {
"type": "object",
"additionalProperties": false,
"required": [
"company",
"reportedFacts",
"derivedMetrics"
],
"properties": {
"company": {
"type": "object",
"additionalProperties": false,
"required": [
"companyId",
"secIssuerCik"
],
"properties": {
"companyId": {
"type": "string"
},
"secIssuerCik": {
"type": "string",
"pattern": "^[0-9]{10}$"
}
}
},
"reportedFacts": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FinancialReportedFact"
}
},
"derivedMetrics": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FinancialDerivedMetric"
}
}
}
},
"meta": {
"type": "object",
"additionalProperties": false,
"required": [
"apiVersion",
"sourceAuthority",
"retrievedAt",
"query",
"semantics"
],
"properties": {
"apiVersion": {
"type": "string",
"const": "sec-api-v1"
},
"sourceAuthority": {
"type": "string",
"const": "stock_canonical.fundamental_facts+derived_metrics"
},
"retrievedAt": {
"type": "string",
"format": "date-time"
},
"query": {
"type": "object",
"additionalProperties": false,
"required": [
"secIssuerCik",
"periodScope",
"metricKey",
"asOf",
"limit"
],
"properties": {
"secIssuerCik": {
"type": "string",
"pattern": "^[0-9]{10}$"
},
"periodScope": {
"type": "string",
"enum": [
"all",
"annual",
"quarterly",
"ttm"
]
},
"metricKey": {
"type": [
"string",
"null"
]
},
"asOf": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"limit": {
"type": "integer",
"minimum": 1,
"maximum": 100
}
}
},
"semantics": {
"type": "object",
"additionalProperties": false,
"required": [
"requestTimeSecFetch",
"canonicalCompanyIdentity",
"valuesAreDecimalStrings",
"pointInTimeMode",
"conservativeFilingAvailability",
"reportedFactRevisionChains",
"derivedMetricsAreSourceReported",
"derivedMetricsCarryExplicitInputs"
],
"properties": {
"requestTimeSecFetch": {
"type": "boolean",
"const": false
},
"canonicalCompanyIdentity": {
"type": "boolean",
"const": true
},
"valuesAreDecimalStrings": {
"type": "boolean",
"const": true
},
"pointInTimeMode": {
"type": "string",
"enum": [
"current-selection",
"source-available-as-of"
]
},
"conservativeFilingAvailability": {
"type": "boolean",
"const": true
},
"reportedFactRevisionChains": {
"type": "boolean",
"const": true
},
"derivedMetricsAreSourceReported": {
"type": "boolean",
"const": false
},
"derivedMetricsCarryExplicitInputs": {
"type": "boolean",
"const": true
}
}
}
}
}
}
}CompanyOwnershipPosition
{
"type": "object",
"additionalProperties": false,
"required": [
"owner",
"company",
"security",
"position",
"filing",
"version",
"sources"
],
"properties": {
"owner": {
"type": "object",
"additionalProperties": false,
"required": [
"personId",
"name",
"reportingOwnerCik"
],
"properties": {
"personId": {
"type": "string"
},
"name": {
"type": "string"
},
"reportingOwnerCik": {
"type": "string",
"pattern": "^[0-9]{10}$"
}
}
},
"company": {
"type": "object",
"additionalProperties": false,
"required": [
"companyId",
"name",
"secIssuerCik"
],
"properties": {
"companyId": {
"type": "string"
},
"name": {
"type": "string"
},
"secIssuerCik": {
"type": "string",
"pattern": "^[0-9]{10}$"
}
}
},
"security": {
"type": "object",
"additionalProperties": false,
"required": [
"legalSecurityId",
"name",
"instrumentFamily",
"ticker",
"exchange"
],
"properties": {
"legalSecurityId": {
"type": "string"
},
"name": {
"type": "string"
},
"instrumentFamily": {
"type": "string"
},
"ticker": {
"type": [
"string",
"null"
]
},
"exchange": {
"type": [
"string",
"null"
]
}
}
},
"position": {
"type": "object",
"additionalProperties": false,
"required": [
"ownershipKind",
"relationshipState",
"currentBasisUnits",
"reportedUnits",
"reportedAsOfDate",
"valuationAsOfDate",
"currentValueUsd"
],
"properties": {
"ownershipKind": {
"type": "string"
},
"relationshipState": {
"type": "string"
},
"currentBasisUnits": {
"type": "string",
"pattern": "^[0-9]+(?:\\.[0-9]+)?$"
},
"reportedUnits": {
"type": [
"string",
"null"
],
"pattern": "^[0-9]+(?:\\.[0-9]+)?$"
},
"reportedAsOfDate": {
"type": "string",
"format": "date"
},
"valuationAsOfDate": {
"type": "string",
"format": "date"
},
"currentValueUsd": {
"type": [
"number",
"null"
],
"minimum": 0
}
}
},
"filing": {
"type": "object",
"additionalProperties": false,
"required": [
"accessionNumber",
"form",
"filingDate",
"effectiveDate"
],
"properties": {
"accessionNumber": {
"type": "string",
"pattern": "^[0-9]{10}-[0-9]{2}-[0-9]{6}$"
},
"form": {
"type": "string"
},
"filingDate": {
"type": "string",
"format": "date"
},
"effectiveDate": {
"type": "string",
"format": "date"
}
}
},
"version": {
"type": "object",
"additionalProperties": false,
"required": [
"versionId",
"knowledgeRecordedAt",
"knowledgeValidFrom",
"knowledgeValidThrough"
],
"properties": {
"versionId": {
"type": "string"
},
"knowledgeRecordedAt": {
"type": "string",
"format": "date-time"
},
"knowledgeValidFrom": {
"type": "string",
"format": "date-time"
},
"knowledgeValidThrough": {
"type": [
"string",
"null"
],
"format": "date-time"
}
}
},
"sources": {
"type": "array",
"minItems": 1,
"items": {
"$ref": "#/components/schemas/CompanyOwnershipSource"
}
}
}
}CompanyOwnershipResponse
{
"type": "object",
"additionalProperties": false,
"required": [
"data",
"pagination",
"beneficialOwnershipPagination",
"meta"
],
"properties": {
"data": {
"type": "object",
"additionalProperties": false,
"required": [
"company",
"positions",
"beneficialOwnershipPositions"
],
"properties": {
"company": {
"type": "object",
"additionalProperties": false,
"required": [
"companyId",
"name",
"secIssuerCik"
],
"properties": {
"companyId": {
"type": "string"
},
"name": {
"type": "string"
},
"secIssuerCik": {
"type": "string",
"pattern": "^[0-9]{10}$"
}
}
},
"positions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CompanyOwnershipPosition"
}
},
"beneficialOwnershipPositions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CompanyBeneficialOwnershipPosition"
}
}
}
},
"pagination": {
"type": "object",
"additionalProperties": false,
"required": [
"limit",
"returned",
"total",
"hasMore"
],
"properties": {
"limit": {
"type": "integer",
"minimum": 1,
"maximum": 100
},
"returned": {
"type": "integer",
"minimum": 0
},
"total": {
"type": "integer",
"minimum": 0
},
"hasMore": {
"type": "boolean"
}
}
},
"beneficialOwnershipPagination": {
"type": "object",
"additionalProperties": false,
"required": [
"limit",
"returned",
"total",
"hasMore"
],
"properties": {
"limit": {
"type": "integer",
"minimum": 1,
"maximum": 100
},
"returned": {
"type": "integer",
"minimum": 0
},
"total": {
"type": "integer",
"minimum": 0
},
"hasMore": {
"type": "boolean"
}
}
},
"meta": {
"type": "object",
"additionalProperties": false,
"required": [
"apiVersion",
"sourceAuthority",
"knowledgeAsOf",
"effectiveAsOf",
"payloadSha256",
"coverage",
"semantics"
],
"properties": {
"apiVersion": {
"type": "string",
"const": "sec-api-v1"
},
"sourceAuthority": {
"type": "string",
"const": "wealth-commercial-extracted-facts:siw+bb-schedule13"
},
"knowledgeAsOf": {
"type": "string",
"format": "date-time"
},
"effectiveAsOf": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"payloadSha256": {
"type": "string",
"pattern": "^[a-f0-9]{64}$"
},
"coverage": {
"type": "object",
"additionalProperties": false,
"required": [
"section16CurrentDisclosedPositions",
"schedule13BeneficialOwnership",
"institutional13fHoldings"
],
"properties": {
"section16CurrentDisclosedPositions": {
"type": "string",
"const": "commercially-admitted-subset"
},
"schedule13BeneficialOwnership": {
"type": "string",
"const": "commercially-admitted-subset"
},
"institutional13fHoldings": {
"type": "string",
"const": "unsupported"
}
}
},
"semantics": {
"type": "object",
"additionalProperties": false,
"required": [
"requestTimeSecFetch",
"commercialAdmissionRequired",
"unresolvedPersonIdentityExcluded",
"currentPositionsOnly",
"completeBeneficialOwnership",
"schedule13Included",
"institutionalHoldingsIncluded"
],
"properties": {
"requestTimeSecFetch": {
"type": "boolean",
"const": false
},
"commercialAdmissionRequired": {
"type": "boolean",
"const": true
},
"unresolvedPersonIdentityExcluded": {
"type": "boolean",
"const": true
},
"currentPositionsOnly": {
"type": "boolean",
"const": true
},
"completeBeneficialOwnership": {
"type": "boolean",
"const": false
},
"schedule13Included": {
"type": "boolean",
"const": true
},
"institutionalHoldingsIncluded": {
"type": "boolean",
"const": false
}
}
}
}
}
}
}CompanyOwnershipSource
{
"type": "object",
"additionalProperties": false,
"required": [
"sourceId",
"canonicalSourceId",
"publisher",
"title",
"locator",
"publishedAt"
],
"properties": {
"sourceId": {
"type": "string"
},
"canonicalSourceId": {
"type": "string"
},
"publisher": {
"type": "string"
},
"title": {
"type": "string"
},
"locator": {
"type": "object",
"additionalProperties": false,
"required": [
"kind",
"value"
],
"properties": {
"kind": {
"type": "string",
"enum": [
"sec-accession",
"url",
"unavailable"
]
},
"value": {
"type": [
"string",
"null"
]
}
}
},
"publishedAt": {
"type": [
"string",
"null"
]
}
}
}ErrorResponse
{
"type": "object",
"additionalProperties": false,
"required": [
"error"
],
"properties": {
"error": {
"type": "object",
"additionalProperties": false,
"required": [
"code",
"message"
],
"properties": {
"code": {
"type": "string",
"enum": [
"invalid_request",
"method_not_allowed",
"unauthenticated",
"rate_limited",
"not_found",
"service_unavailable",
"internal_error"
]
},
"message": {
"type": "string"
}
}
}
}
}Filing
{
"type": "object",
"additionalProperties": false,
"required": [
"accessionNumber",
"formType",
"filingDate",
"filingDirectoryUrl",
"firstDiscoveredAt",
"firstDiscoverySource",
"observedFiler",
"archive",
"retainedEvidence"
],
"properties": {
"accessionNumber": {
"type": "string",
"pattern": "^[0-9]{10}-[0-9]{2}-[0-9]{6}$"
},
"formType": {
"type": "string"
},
"filingDate": {
"type": "string",
"format": "date"
},
"filingDirectoryUrl": {
"type": "string",
"format": "uri"
},
"firstDiscoveredAt": {
"type": "string",
"format": "date-time"
},
"firstDiscoverySource": {
"type": "string"
},
"observedFiler": {
"$ref": "#/components/schemas/ObservedFiler"
},
"archive": {
"$ref": "#/components/schemas/Archive"
},
"retainedEvidence": {
"$ref": "#/components/schemas/RetainedEvidence"
}
}
}FilingDiffResponse
{
"type": "object",
"additionalProperties": false,
"required": [
"data",
"meta"
],
"properties": {
"data": {
"type": "object",
"additionalProperties": false,
"required": [
"diff"
],
"properties": {
"diff": {
"type": "object",
"additionalProperties": false,
"required": [
"schemaVersion",
"fromAccessionNumber",
"toAccessionNumber",
"baseFormType",
"sections",
"summary",
"semantics"
],
"properties": {
"schemaVersion": {
"type": "integer",
"const": 1
},
"fromAccessionNumber": {
"type": "string"
},
"toAccessionNumber": {
"type": "string"
},
"baseFormType": {
"type": "string",
"enum": [
"10-K",
"10-Q",
"8-K"
]
},
"sections": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"required": [
"key",
"item",
"status",
"fromContentSha256",
"toContentSha256",
"fromWordCount",
"toWordCount",
"wordCountDelta"
],
"properties": {
"key": {
"type": "string"
},
"item": {
"type": "string"
},
"status": {
"type": "string",
"enum": [
"added",
"removed",
"changed",
"unchanged"
]
},
"fromContentSha256": {
"type": [
"string",
"null"
]
},
"toContentSha256": {
"type": [
"string",
"null"
]
},
"fromWordCount": {
"type": [
"integer",
"null"
]
},
"toWordCount": {
"type": [
"integer",
"null"
]
},
"wordCountDelta": {
"type": [
"integer",
"null"
]
}
}
}
},
"summary": {
"type": "object",
"additionalProperties": false,
"required": [
"added",
"removed",
"changed",
"unchanged"
],
"properties": {
"added": {
"type": "integer",
"minimum": 0
},
"removed": {
"type": "integer",
"minimum": 0
},
"changed": {
"type": "integer",
"minimum": 0
},
"unchanged": {
"type": "integer",
"minimum": 0
}
}
},
"semantics": {
"type": "object",
"additionalProperties": false,
"required": [
"comparedExplicitAccessions",
"automaticAmendmentLinkage"
],
"properties": {
"comparedExplicitAccessions": {
"type": "boolean",
"const": true
},
"automaticAmendmentLinkage": {
"type": "boolean",
"const": false
}
}
}
}
}
}
},
"meta": {
"$ref": "#/components/schemas/FilingIntelligenceMeta"
}
}
}FilingEvent
{
"type": "object",
"additionalProperties": false,
"required": [
"eventType",
"item",
"sectionKey",
"title",
"semanticInference"
],
"properties": {
"eventType": {
"type": "string",
"const": "8-k-item"
},
"item": {
"type": "string"
},
"sectionKey": {
"type": "string"
},
"title": {
"type": [
"string",
"null"
]
},
"semanticInference": {
"type": "boolean",
"const": false
}
}
}FilingIntelligenceManifest
{
"type": "object",
"additionalProperties": false,
"required": [
"schemaVersion",
"extractorVersion",
"accessionNumber",
"formType",
"baseFormType",
"filingDate",
"isAmendment",
"selectedDocument",
"sourceContentSha256",
"normalizedDocumentSha256",
"sections",
"events",
"semantics"
],
"properties": {
"schemaVersion": {
"type": "integer",
"const": 1
},
"extractorVersion": {
"type": "string",
"const": "sec-filing-intelligence-v1"
},
"accessionNumber": {
"type": "string",
"pattern": "^[0-9]{10}-[0-9]{2}-[0-9]{6}$"
},
"formType": {
"type": "string"
},
"baseFormType": {
"type": "string",
"enum": [
"10-K",
"10-Q",
"8-K"
]
},
"filingDate": {
"type": "string",
"format": "date"
},
"isAmendment": {
"type": "boolean"
},
"selectedDocument": {
"type": "object",
"additionalProperties": false,
"required": [
"documentType",
"sequence",
"filename",
"description"
],
"properties": {
"documentType": {
"type": "string"
},
"sequence": {
"type": [
"integer",
"null"
],
"minimum": 0
},
"filename": {
"type": [
"string",
"null"
]
},
"description": {
"type": [
"string",
"null"
]
}
}
},
"sourceContentSha256": {
"type": "string",
"pattern": "^[a-f0-9]{64}$"
},
"normalizedDocumentSha256": {
"type": "string",
"pattern": "^[a-f0-9]{64}$"
},
"sections": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FilingSectionMetadata"
}
},
"events": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FilingEvent"
}
},
"semantics": {
"type": "object",
"additionalProperties": false,
"required": [
"requestTimeSecFetch",
"automaticAmendmentLinkage",
"eventSemanticInference"
],
"properties": {
"requestTimeSecFetch": {
"type": "boolean",
"const": false
},
"automaticAmendmentLinkage": {
"type": "boolean",
"const": false
},
"eventSemanticInference": {
"type": "boolean",
"const": false
}
}
}
}
}FilingIntelligenceMeta
{
"type": "object",
"additionalProperties": false,
"required": [
"apiVersion",
"sourceAuthority",
"retrievedAt",
"semantics"
],
"properties": {
"apiVersion": {
"type": "string",
"const": "sec-api-v1"
},
"sourceAuthority": {
"type": "string",
"const": "sec-filing-intelligence-v1"
},
"retrievedAt": {
"type": "string",
"format": "date-time"
},
"semantics": {
"type": "object",
"additionalProperties": false,
"required": [
"requestTimeSecFetch",
"automaticAmendmentLinkage",
"eventSemanticInference"
],
"properties": {
"requestTimeSecFetch": {
"type": "boolean",
"const": false
},
"automaticAmendmentLinkage": {
"type": "boolean",
"const": false
},
"eventSemanticInference": {
"type": "boolean",
"const": false
}
}
}
}
}FilingResponse
{
"type": "object",
"additionalProperties": false,
"required": [
"data",
"meta"
],
"properties": {
"data": {
"type": "object",
"additionalProperties": false,
"required": [
"filing"
],
"properties": {
"filing": {
"$ref": "#/components/schemas/Filing"
}
}
},
"meta": {
"$ref": "#/components/schemas/Meta"
}
}
}FilingSearchResponse
{
"type": "object",
"additionalProperties": false,
"required": [
"data",
"pagination",
"beneficialOwnershipPagination",
"meta"
],
"properties": {
"data": {
"type": "object",
"additionalProperties": false,
"required": [
"filings"
],
"properties": {
"filings": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Filing"
}
}
}
},
"pagination": {
"type": "object",
"additionalProperties": false,
"required": [
"limit",
"offset",
"returned",
"hasMore",
"nextOffset"
],
"properties": {
"limit": {
"type": "integer",
"minimum": 1,
"maximum": 100
},
"offset": {
"type": "integer",
"minimum": 0,
"maximum": 10000
},
"returned": {
"type": "integer",
"minimum": 0
},
"hasMore": {
"type": "boolean"
},
"nextOffset": {
"type": [
"integer",
"null"
],
"minimum": 0
}
}
},
"meta": {
"$ref": "#/components/schemas/Meta"
}
}
}FilingSectionMetadata
{
"type": "object",
"additionalProperties": false,
"required": [
"key",
"item",
"title",
"contentSha256",
"wordCount",
"normalizedStartLine",
"normalizedEndLine"
],
"properties": {
"key": {
"type": "string"
},
"item": {
"type": "string"
},
"title": {
"type": [
"string",
"null"
]
},
"contentSha256": {
"type": "string",
"pattern": "^[a-f0-9]{64}$"
},
"wordCount": {
"type": "integer",
"minimum": 0
},
"normalizedStartLine": {
"type": "integer",
"minimum": 1
},
"normalizedEndLine": {
"type": "integer",
"minimum": 1
}
}
}FilingSectionResponse
{
"type": "object",
"additionalProperties": false,
"required": [
"data",
"meta"
],
"properties": {
"data": {
"type": "object",
"additionalProperties": false,
"required": [
"accessionNumber",
"section"
],
"properties": {
"accessionNumber": {
"type": "string",
"pattern": "^[0-9]{10}-[0-9]{2}-[0-9]{6}$"
},
"section": {
"allOf": [
{
"$ref": "#/components/schemas/FilingSectionMetadata"
},
{
"type": "object",
"required": [
"text"
],
"properties": {
"text": {
"type": "string"
}
}
}
]
}
}
},
"meta": {
"$ref": "#/components/schemas/FilingIntelligenceMeta"
}
}
}FilingSectionsResponse
{
"type": "object",
"additionalProperties": false,
"required": [
"data",
"meta"
],
"properties": {
"data": {
"type": "object",
"additionalProperties": false,
"required": [
"filing"
],
"properties": {
"filing": {
"$ref": "#/components/schemas/FilingIntelligenceManifest"
}
}
},
"meta": {
"$ref": "#/components/schemas/FilingIntelligenceMeta"
}
}
}FinancialDerivedInput
{
"type": "object",
"additionalProperties": false,
"required": [
"inputRecordId",
"ordinal",
"role",
"sourceFactLocator",
"evidenceId",
"value",
"unit",
"concept",
"periodStart",
"periodEnd",
"filedAt",
"form"
],
"properties": {
"inputRecordId": {
"type": "string"
},
"ordinal": {
"type": "integer",
"minimum": 0
},
"role": {
"type": "string"
},
"sourceFactLocator": {
"type": "string"
},
"evidenceId": {
"type": "string"
},
"value": {
"type": [
"string",
"null"
],
"pattern": "^-?[0-9]+(?:\\.[0-9]+)?$"
},
"unit": {
"type": [
"string",
"null"
]
},
"concept": {
"type": [
"string",
"null"
]
},
"periodStart": {
"type": [
"string",
"null"
],
"format": "date"
},
"periodEnd": {
"type": [
"string",
"null"
],
"format": "date"
},
"filedAt": {
"type": [
"string",
"null"
],
"format": "date"
},
"form": {
"type": [
"string",
"null"
]
}
}
}FinancialDerivedMetric
{
"type": "object",
"additionalProperties": false,
"required": [
"metricObservationId",
"companyId",
"metricKey",
"value",
"unit",
"asOfDate",
"availableAt",
"computedAt",
"methodology",
"rightsProfileId",
"currentlySelected",
"inputs"
],
"properties": {
"metricObservationId": {
"type": "string"
},
"companyId": {
"type": "string"
},
"metricKey": {
"type": "string"
},
"value": {
"type": "string",
"pattern": "^-?[0-9]+(?:\\.[0-9]+)?$"
},
"unit": {
"type": "string"
},
"asOfDate": {
"type": "string",
"format": "date"
},
"availableAt": {
"type": "string",
"format": "date-time"
},
"computedAt": {
"type": "string",
"format": "date-time"
},
"methodology": {
"type": "object",
"additionalProperties": false,
"required": [
"id",
"version"
],
"properties": {
"id": {
"type": "string"
},
"version": {
"type": "string"
}
}
},
"rightsProfileId": {
"type": "string"
},
"currentlySelected": {
"type": "boolean"
},
"inputs": {
"type": "array",
"minItems": 1,
"items": {
"$ref": "#/components/schemas/FinancialDerivedInput"
}
}
}
}FinancialReportedFact
{
"type": "object",
"additionalProperties": false,
"required": [
"factId",
"seriesKey",
"companyId",
"secIssuerCik",
"metricKey",
"statement",
"factKind",
"value",
"unit",
"currency",
"period",
"filing",
"xbrl",
"evidence",
"revision",
"directMethod"
],
"properties": {
"factId": {
"type": "string"
},
"seriesKey": {
"type": "string"
},
"companyId": {
"type": "string"
},
"secIssuerCik": {
"type": "string",
"pattern": "^[0-9]{10}$"
},
"metricKey": {
"type": "string"
},
"statement": {
"type": "string",
"enum": [
"income-statement",
"cash-flow",
"balance-sheet",
"capital-returns"
]
},
"factKind": {
"type": "string",
"enum": [
"duration",
"instant"
]
},
"value": {
"type": "string",
"pattern": "^-?[0-9]+(?:\\.[0-9]+)?$"
},
"unit": {
"type": "string"
},
"currency": {
"type": [
"string",
"null"
]
},
"period": {
"type": "object",
"additionalProperties": false,
"required": [
"periodId",
"kind",
"startDate",
"endDate",
"fiscalYearLabel",
"fiscalPeriodLabel"
],
"properties": {
"periodId": {
"type": "string"
},
"kind": {
"type": "string",
"enum": [
"fiscal-year",
"fiscal-quarter",
"fiscal-ytd",
"instant"
]
},
"startDate": {
"type": [
"string",
"null"
],
"format": "date"
},
"endDate": {
"type": "string",
"format": "date"
},
"fiscalYearLabel": {
"type": [
"string",
"null"
]
},
"fiscalPeriodLabel": {
"type": [
"string",
"null"
]
}
}
},
"filing": {
"type": "object",
"additionalProperties": false,
"required": [
"accession",
"form",
"filedAt",
"availableAt",
"filingFiscalYear",
"frame"
],
"properties": {
"accession": {
"type": "string"
},
"form": {
"type": "string"
},
"filedAt": {
"type": "string",
"format": "date"
},
"availableAt": {
"type": "string",
"format": "date-time"
},
"filingFiscalYear": {
"type": [
"integer",
"null"
]
},
"frame": {
"type": [
"string",
"null"
]
}
}
},
"xbrl": {
"type": "object",
"additionalProperties": false,
"required": [
"concept",
"sourceFactLocator"
],
"properties": {
"concept": {
"type": "string"
},
"sourceFactLocator": {
"type": "string"
}
}
},
"evidence": {
"type": "object",
"additionalProperties": false,
"required": [
"evidenceId",
"sourceId",
"sourceRecordId",
"contentSha256",
"acquiredAt",
"sourcePublishedAt",
"rightsProfileId"
],
"properties": {
"evidenceId": {
"type": "string"
},
"sourceId": {
"type": "string"
},
"sourceRecordId": {
"type": "string"
},
"contentSha256": {
"type": [
"string",
"null"
],
"pattern": "^[a-f0-9]{64}$"
},
"acquiredAt": {
"type": "string",
"format": "date-time"
},
"sourcePublishedAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"rightsProfileId": {
"type": "string"
}
}
},
"revision": {
"type": "object",
"additionalProperties": false,
"required": [
"number",
"supersedesFactId",
"currentlySelected",
"currentState"
],
"properties": {
"number": {
"type": "integer",
"minimum": 1
},
"supersedesFactId": {
"type": [
"string",
"null"
]
},
"currentlySelected": {
"type": "boolean"
},
"currentState": {
"type": "string",
"enum": [
"active",
"superseded"
]
}
}
},
"directMethod": {
"type": "string"
}
}
}InstitutionalHolding13f
{
"type": "object",
"additionalProperties": false,
"required": [
"sourceOrdinal",
"nameOfIssuer",
"titleOfClass",
"cusip",
"reportedValueThousandsUsd",
"reportedAmount",
"reportedAmountType",
"putCall",
"investmentDiscretion",
"otherManager",
"votingAuthority"
],
"properties": {
"sourceOrdinal": {
"type": "integer",
"minimum": 0
},
"nameOfIssuer": {
"type": "string"
},
"titleOfClass": {
"type": "string"
},
"cusip": {
"type": "string",
"pattern": "^[A-Z0-9]{9}$"
},
"reportedValueThousandsUsd": {
"type": "string",
"pattern": "^[0-9]+(?:\\.[0-9]+)?$"
},
"reportedAmount": {
"type": "string",
"pattern": "^[0-9]+(?:\\.[0-9]+)?$"
},
"reportedAmountType": {
"type": "string",
"enum": [
"SH",
"PRN"
]
},
"putCall": {
"type": [
"string",
"null"
],
"enum": [
"PUT",
"CALL",
null
]
},
"investmentDiscretion": {
"type": "string"
},
"otherManager": {
"type": [
"string",
"null"
]
},
"votingAuthority": {
"type": "object",
"additionalProperties": false,
"required": [
"sole",
"shared",
"none"
],
"properties": {
"sole": {
"type": "string",
"pattern": "^[0-9]+(?:\\.[0-9]+)?$"
},
"shared": {
"type": "string",
"pattern": "^[0-9]+(?:\\.[0-9]+)?$"
},
"none": {
"type": "string",
"pattern": "^[0-9]+(?:\\.[0-9]+)?$"
}
}
}
}
}InstitutionalHoldingsResponse
{
"type": "object",
"additionalProperties": false,
"required": [
"data",
"pagination",
"meta"
],
"properties": {
"data": {
"type": "object",
"additionalProperties": false,
"required": [
"filing",
"holdings"
],
"properties": {
"filing": {
"type": "object",
"additionalProperties": false,
"required": [
"accessionNumber",
"formType",
"filingDate",
"reportPeriod",
"manager"
],
"properties": {
"accessionNumber": {
"type": "string",
"pattern": "^[0-9]{10}-[0-9]{2}-[0-9]{6}$"
},
"formType": {
"type": "string",
"enum": [
"13F-HR",
"13F-HR/A"
]
},
"filingDate": {
"type": "string",
"format": "date"
},
"reportPeriod": {
"type": "string",
"format": "date"
},
"manager": {
"type": "object",
"additionalProperties": false,
"required": [
"observedCik",
"observedName",
"identityAuthority"
],
"properties": {
"observedCik": {
"type": "string",
"pattern": "^[0-9]{10}$"
},
"observedName": {
"type": "string"
},
"identityAuthority": {
"type": "string",
"const": "sec-filing-header-observation"
}
}
}
}
},
"holdings": {
"type": "array",
"items": {
"$ref": "#/components/schemas/InstitutionalHolding13f"
}
}
}
},
"pagination": {
"type": "object",
"additionalProperties": false,
"required": [
"limit",
"offset",
"returned",
"total",
"hasMore",
"nextOffset"
],
"properties": {
"limit": {
"type": "integer",
"minimum": 1,
"maximum": 100
},
"offset": {
"type": "integer",
"minimum": 0,
"maximum": 10000
},
"returned": {
"type": "integer",
"minimum": 0
},
"total": {
"type": "integer",
"minimum": 0
},
"hasMore": {
"type": "boolean"
},
"nextOffset": {
"type": [
"integer",
"null"
],
"minimum": 0
}
}
},
"meta": {
"type": "object",
"additionalProperties": false,
"required": [
"apiVersion",
"sourceAuthority",
"retrievedAt",
"sourceContentSha256",
"holdingsContentSha256",
"semantics"
],
"properties": {
"apiVersion": {
"type": "string",
"const": "sec-api-v1"
},
"sourceAuthority": {
"type": "string",
"const": "sec-13f-institutional-holdings-v1"
},
"retrievedAt": {
"type": "string",
"format": "date-time"
},
"sourceContentSha256": {
"type": "string",
"pattern": "^[a-f0-9]{64}$"
},
"holdingsContentSha256": {
"type": "string",
"pattern": "^[a-f0-9]{64}$"
},
"semantics": {
"type": "object",
"additionalProperties": false,
"required": [
"requestTimeSecFetch",
"exactAccessionScoped",
"automaticAmendmentMerge",
"managerIdentityCanonicalized",
"issuerNamesAreReportedLabels",
"cusipIsCanonicalSecurityIdentity",
"companyResolutionApplied",
"reportedValueUnit"
],
"properties": {
"requestTimeSecFetch": {
"type": "boolean",
"const": false
},
"exactAccessionScoped": {
"type": "boolean",
"const": true
},
"automaticAmendmentMerge": {
"type": "boolean",
"const": false
},
"managerIdentityCanonicalized": {
"type": "boolean",
"const": false
},
"issuerNamesAreReportedLabels": {
"type": "boolean",
"const": true
},
"cusipIsCanonicalSecurityIdentity": {
"type": "boolean",
"const": false
},
"companyResolutionApplied": {
"type": "boolean",
"const": false
},
"reportedValueUnit": {
"type": "string",
"const": "thousands-usd"
}
}
}
}
}
}
}Meta
{
"type": "object",
"additionalProperties": false,
"required": [
"apiVersion",
"sourceAuthority",
"retrievedAt",
"semantics"
],
"properties": {
"apiVersion": {
"type": "string",
"const": "sec-api-v1"
},
"sourceAuthority": {
"type": "string",
"const": "sec_source.filing_catalog"
},
"retrievedAt": {
"type": "string",
"format": "date-time"
},
"semantics": {
"type": "object",
"additionalProperties": false,
"required": [
"observedFilerIsCanonicalIdentity",
"requestTimeSecFetch"
],
"properties": {
"observedFilerIsCanonicalIdentity": {
"type": "boolean",
"const": false
},
"requestTimeSecFetch": {
"type": "boolean",
"const": false
}
}
}
}
}ObservedFiler
{
"type": "object",
"additionalProperties": false,
"required": [
"cik",
"name"
],
"properties": {
"cik": {
"type": [
"string",
"null"
],
"pattern": "^[0-9]{10}$"
},
"name": {
"type": [
"string",
"null"
]
}
}
}RetainedEvidence
{
"type": [
"object",
"null"
],
"additionalProperties": false,
"required": [
"evidenceId",
"documentName",
"mediaType",
"contentSha256",
"acquiredAt",
"resolverVersion",
"selectedAt"
],
"properties": {
"evidenceId": {
"type": "string"
},
"documentName": {
"type": [
"string",
"null"
]
},
"mediaType": {
"type": [
"string",
"null"
]
},
"contentSha256": {
"type": [
"string",
"null"
],
"pattern": "^[a-f0-9]{64}$"
},
"acquiredAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"resolverVersion": {
"type": [
"string",
"null"
]
},
"selectedAt": {
"type": [
"string",
"null"
],
"format": "date-time"
}
}
}