{ "openapi": "3.0.0", "paths": { "/companies": { "get": { "operationId": "CompaniesControllerV3_getCompanies", "summary": "List companies", "parameters": [ { "name": "countries", "required": false, "in": "query", "description": "Comma-separated list of country codes (ISO 3166-1 alpha-2)", "schema": { "example": "US,CA", "type": "string" } }, { "name": "exchanges", "required": false, "in": "query", "description": "Exchange symbols, without blankspace, to filter by.", "schema": { "example": "NasdaqCM,NasdaqGS,NYSE", "type": "string" } }, { "name": "tickers", "required": false, "in": "query", "description": "Comma-separated list of company tickers", "schema": { "example": "AAPL,AMZN", "type": "string" } }, { "name": "limit", "required": false, "in": "query", "description": "The maximum number of items to return in a single request.", "schema": { "maximum": 500, "example": 10, "type": "number" } }, { "name": "cursor", "required": false, "in": "query", "description": "A unique identifier pointing to the starting position for the next set of results.", "schema": { "minimum": 0, "example": 2432, "type": "number" } }, { "name": "direction", "required": false, "in": "query", "description": "The direction of the sort order (id field).", "schema": { "example": "asc", "enum": ["asc", "desc"], "type": "string" } }, { "name": "isins", "required": false, "in": "query", "description": "Comma-separated list of ISINs", "schema": { "example": "US0378331005,US0231351067", "type": "string" } }, { "name": "ciks", "required": false, "in": "query", "description": "Comma-separated list of CIKs (SEC Central Index Keys)", "schema": { "example": "0000320193,0001018724", "type": "string" } }, { "name": "openfigis", "required": false, "in": "query", "description": "Comma-separated list of OpenFIGI codes (figi, compositeFigi, or shareClassFigi)", "schema": { "example": "BBG000B9XRY4,BBG001S5N8V8", "type": "string" } }, { "name": "updatedBefore", "required": false, "in": "query", "description": "Query data that was updated before this date (ISO 8601)", "schema": { "example": "2024-01-24T12:00:00Z", "type": "string" } }, { "name": "updatedAfter", "required": false, "in": "query", "description": "Query data that was updated after this date (ISO 8601)", "schema": { "example": "2025-01-12T15:00:00Z", "type": "string" } }, { "name": "ids", "required": false, "in": "query", "description": "Comma-separated list of company IDs", "schema": { "example": "4024,5025,6026", "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedCompaniesResponseDto" } } } }, "400": { "description": "", "content": { "application/json": { "schema": { "properties": { "error": { "example": "Bad Request", "type": "string" }, "message": { "items": { "properties": { "field": { "example": "country", "type": "string" }, "message": { "example": "country must be a valid ISO31661 Alpha2 code", "type": "string" } }, "type": "object" }, "type": "array" }, "statusCode": { "example": 400, "type": "number" } }, "type": "object" } } } }, "401": { "description": "", "content": { "application/json": { "schema": { "properties": { "message": { "example": "Unauthorized", "type": "string" }, "statusCode": { "example": 401, "type": "number" } }, "type": "object" } } } }, "403": { "description": "", "content": { "application/json": { "schema": { "properties": { "message": { "example": "Forbidden", "type": "string" }, "statusCode": { "example": 403, "type": "number" } }, "type": "object" } } } } }, "tags": ["Companies"], "security": [{ "apiKey": [] }] } }, "/companies/{id}": { "get": { "operationId": "CompaniesControllerV3_getCompanyById", "summary": "Retrieve a company", "parameters": [ { "name": "id", "required": true, "in": "path", "schema": { "type": "number" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompanyResponseDto" } } } }, "401": { "description": "", "content": { "application/json": { "schema": { "properties": { "message": { "example": "Unauthorized", "type": "string" }, "statusCode": { "example": 401, "type": "number" } }, "type": "object" } } } }, "403": { "description": "", "content": { "application/json": { "schema": { "properties": { "message": { "example": "Forbidden", "type": "string" }, "statusCode": { "example": 403, "type": "number" } }, "type": "object" } } } }, "404": { "description": "", "content": { "application/json": { "schema": { "properties": { "message": { "example": "Not Found", "type": "string" }, "statusCode": { "example": 404, "type": "number" } }, "type": "object" } } } } }, "tags": ["Companies"], "security": [{ "apiKey": [] }] } }, "/companies/{id}/segments": { "get": { "operationId": "CompaniesControllerV3_getSegments", "summary": "List segments", "parameters": [ { "name": "id", "required": true, "in": "path", "schema": { "type": "number" } }, { "name": "limit", "required": false, "in": "query", "description": "The maximum number of items to return in a single request.", "schema": { "maximum": 500, "example": 10, "type": "number" } }, { "name": "cursor", "required": false, "in": "query", "description": "A unique identifier pointing to the starting position for the next set of results.", "schema": { "minimum": 0, "example": 2432, "type": "number" } }, { "name": "direction", "required": false, "in": "query", "description": "The direction of the sort order (id field).", "schema": { "example": "asc", "enum": ["asc", "desc"], "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedSegmentResponseDto" } } } }, "401": { "description": "", "content": { "application/json": { "schema": { "properties": { "message": { "example": "Unauthorized", "type": "string" }, "statusCode": { "example": 401, "type": "number" } }, "type": "object" } } } }, "403": { "description": "", "content": { "application/json": { "schema": { "properties": { "message": { "example": "Forbidden", "type": "string" }, "statusCode": { "example": 403, "type": "number" } }, "type": "object" } } } } }, "tags": ["Companies"], "security": [{ "apiKey": [] }, { "apiKey": [] }] } }, "/events": { "get": { "operationId": "EventsControllerV3_getEvents", "summary": "List events", "parameters": [ { "name": "countries", "required": false, "in": "query", "description": "Comma-separated list of country codes (ISO 3166-1 alpha-2)", "schema": { "example": "US,CA", "type": "string" } }, { "name": "exchanges", "required": false, "in": "query", "description": "Exchange symbols, without blankspace, to filter by.", "schema": { "example": "NasdaqCM,NasdaqGS,NYSE", "type": "string" } }, { "name": "tickers", "required": false, "in": "query", "description": "Comma-separated list of company tickers", "schema": { "example": "AAPL,AMZN", "type": "string" } }, { "name": "limit", "required": false, "in": "query", "description": "The maximum number of items to return in a single request.", "schema": { "maximum": 500, "example": 10, "type": "number" } }, { "name": "cursor", "required": false, "in": "query", "description": "A unique identifier pointing to the starting position for the next set of results.", "schema": { "minimum": 0, "example": 2432, "type": "number" } }, { "name": "direction", "required": false, "in": "query", "description": "The direction of the sort order (id field).", "schema": { "example": "asc", "enum": ["asc", "desc"], "type": "string" } }, { "name": "endDate", "required": false, "in": "query", "description": "The end date (ISO 8601)", "schema": { "example": "2025-01-10T13:00:00Z", "type": "string" } }, { "name": "startDate", "required": false, "in": "query", "description": "The start date (ISO 8601)", "schema": { "example": "2024-12-12T15:00:00Z", "type": "string" } }, { "name": "isins", "required": false, "in": "query", "description": "Comma-separated list of ISINs", "schema": { "example": "US0378331005,US0231351067", "type": "string" } }, { "name": "ciks", "required": false, "in": "query", "description": "Comma-separated list of CIKs (SEC Central Index Keys)", "schema": { "example": "0000320193,0001018724", "type": "string" } }, { "name": "typeIds", "required": false, "in": "query", "description": "Comma-separated list of event type ids", "schema": { "example": "26,29,35", "type": "string" } }, { "name": "companyIds", "required": false, "in": "query", "description": "Comma-separated list of company IDs", "schema": { "example": "4024,5025,6026", "type": "string" } }, { "name": "sortBy", "required": false, "in": "query", "description": "The field to sort by.", "schema": { "example": "id", "enum": ["id", "date"], "type": "string" } }, { "name": "updatedBefore", "required": false, "in": "query", "description": "Query data that was updated before this date (ISO 8601)", "schema": { "example": "2024-01-24T12:00:00Z", "type": "string" } }, { "name": "updatedAfter", "required": false, "in": "query", "description": "Query data that was updated after this date (ISO 8601)", "schema": { "example": "2025-01-12T15:00:00Z", "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedEventResponseDto" } } } }, "400": { "description": "", "content": { "application/json": { "schema": { "properties": { "error": { "example": "Bad Request", "type": "string" }, "message": { "items": { "properties": { "field": { "example": "country", "type": "string" }, "message": { "example": "country must be a valid ISO31661 Alpha2 code", "type": "string" } }, "type": "object" }, "type": "array" }, "statusCode": { "example": 400, "type": "number" } }, "type": "object" } } } }, "401": { "description": "", "content": { "application/json": { "schema": { "properties": { "message": { "example": "Unauthorized", "type": "string" }, "statusCode": { "example": 401, "type": "number" } }, "type": "object" } } } }, "403": { "description": "", "content": { "application/json": { "schema": { "properties": { "message": { "example": "Forbidden", "type": "string" }, "statusCode": { "example": 403, "type": "number" } }, "type": "object" } } } } }, "tags": ["Events"], "security": [{ "apiKey": [] }] } }, "/events/{id}": { "get": { "operationId": "EventsControllerV3_getEventById", "summary": "Retrieve an event", "parameters": [ { "name": "id", "required": true, "in": "path", "schema": { "type": "number" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EventResponseDto" } } } }, "401": { "description": "", "content": { "application/json": { "schema": { "properties": { "message": { "example": "Unauthorized", "type": "string" }, "statusCode": { "example": 401, "type": "number" } }, "type": "object" } } } }, "403": { "description": "", "content": { "application/json": { "schema": { "properties": { "message": { "example": "Forbidden", "type": "string" }, "statusCode": { "example": 403, "type": "number" } }, "type": "object" } } } }, "404": { "description": "", "content": { "application/json": { "schema": { "properties": { "message": { "example": "Not Found", "type": "string" }, "statusCode": { "example": 404, "type": "number" } }, "type": "object" } } } } }, "tags": ["Events"], "security": [{ "apiKey": [] }] } }, "/events/{id}/summary": { "get": { "operationId": "EventSummaryControllerV3_getSummary", "summary": "Retrieve an event summary", "parameters": [ { "name": "id", "required": true, "in": "path", "schema": { "type": "number" } }, { "name": "length", "required": false, "in": "query", "description": "Length preset for the summary.", "schema": { "default": "short", "example": "long", "type": "string" } }, { "name": "plain", "required": false, "in": "query", "description": "Plain text summary without document sources embedded.", "schema": { "default": false, "example": true, "type": "boolean" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SummaryResponseDto" } } } }, "401": { "description": "", "content": { "application/json": { "schema": { "properties": { "message": { "example": "Unauthorized", "type": "string" }, "statusCode": { "example": 401, "type": "number" } }, "type": "object" } } } }, "403": { "description": "", "content": { "application/json": { "schema": { "properties": { "message": { "example": "Forbidden", "type": "string" }, "statusCode": { "example": 403, "type": "number" } }, "type": "object" } } } } }, "tags": ["Events"], "security": [{ "apiKey": [] }] } }, "/event-types": { "get": { "operationId": "EventTypesControllerV3_getEventTypes", "summary": "List event types", "parameters": [ { "name": "limit", "required": false, "in": "query", "description": "The maximum number of items to return in a single request.", "schema": { "maximum": 500, "example": 10, "type": "number" } }, { "name": "cursor", "required": false, "in": "query", "description": "A unique identifier pointing to the starting position for the next set of results.", "schema": { "minimum": 0, "example": 2432, "type": "number" } }, { "name": "direction", "required": false, "in": "query", "description": "The direction of the sort order (id field).", "schema": { "example": "asc", "enum": ["asc", "desc"], "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedEventTypeResponseDto" } } } }, "400": { "description": "", "content": { "application/json": { "schema": { "properties": { "error": { "example": "Bad Request", "type": "string" }, "message": { "items": { "properties": { "field": { "example": "country", "type": "string" }, "message": { "example": "country must be a valid ISO31661 Alpha2 code", "type": "string" } }, "type": "object" }, "type": "array" }, "statusCode": { "example": 400, "type": "number" } }, "type": "object" } } } }, "401": { "description": "", "content": { "application/json": { "schema": { "properties": { "message": { "example": "Unauthorized", "type": "string" }, "statusCode": { "example": 401, "type": "number" } }, "type": "object" } } } }, "403": { "description": "", "content": { "application/json": { "schema": { "properties": { "message": { "example": "Forbidden", "type": "string" }, "statusCode": { "example": 403, "type": "number" } }, "type": "object" } } } } }, "tags": ["Event Types"], "security": [{ "apiKey": [] }] } }, "/event-types/{id}": { "get": { "operationId": "EventTypesControllerV3_getEventTypeById", "summary": "Retrieve an event type", "parameters": [ { "name": "id", "required": true, "in": "path", "schema": { "type": "number" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EventTypeResponseDto" } } } }, "401": { "description": "", "content": { "application/json": { "schema": { "properties": { "message": { "example": "Unauthorized", "type": "string" }, "statusCode": { "example": 401, "type": "number" } }, "type": "object" } } } }, "403": { "description": "", "content": { "application/json": { "schema": { "properties": { "message": { "example": "Forbidden", "type": "string" }, "statusCode": { "example": 403, "type": "number" } }, "type": "object" } } } }, "404": { "description": "", "content": { "application/json": { "schema": { "properties": { "message": { "example": "Not Found", "type": "string" }, "statusCode": { "example": 404, "type": "number" } }, "type": "object" } } } } }, "tags": ["Event Types"], "security": [{ "apiKey": [] }] } }, "/documents": { "get": { "operationId": "DocumentControllerV3_getDocuments", "summary": "List documents", "parameters": [ { "name": "countries", "required": false, "in": "query", "description": "Comma-separated list of country codes (ISO 3166-1 alpha-2)", "schema": { "example": "US,CA", "type": "string" } }, { "name": "exchanges", "required": false, "in": "query", "description": "Exchange symbols, without blankspace, to filter by.", "schema": { "example": "NasdaqCM,NasdaqGS,NYSE", "type": "string" } }, { "name": "tickers", "required": false, "in": "query", "description": "Comma-separated list of company tickers", "schema": { "example": "AAPL,AMZN", "type": "string" } }, { "name": "limit", "required": false, "in": "query", "description": "The maximum number of items to return in a single request.", "schema": { "maximum": 500, "example": 10, "type": "number" } }, { "name": "cursor", "required": false, "in": "query", "description": "A unique identifier pointing to the starting position for the next set of results.", "schema": { "minimum": 0, "example": 2432, "type": "number" } }, { "name": "direction", "required": false, "in": "query", "description": "The direction of the sort order (id field).", "schema": { "example": "asc", "enum": ["asc", "desc"], "type": "string" } }, { "name": "endDate", "required": false, "in": "query", "description": "The end date (ISO 8601)", "schema": { "example": "2025-01-10T13:00:00Z", "type": "string" } }, { "name": "startDate", "required": false, "in": "query", "description": "The start date (ISO 8601)", "schema": { "example": "2024-12-12T15:00:00Z", "type": "string" } }, { "name": "typeIds", "required": false, "in": "query", "description": "Comma-separated list of type ids", "schema": { "example": "6,13,39", "type": "string" } }, { "name": "isins", "required": false, "in": "query", "description": "Comma-separated list of ISINs", "schema": { "example": "US0378331005,US0231351067", "type": "string" } }, { "name": "ciks", "required": false, "in": "query", "description": "Comma-separated list of CIKs (SEC Central Index Keys)", "schema": { "example": "0000320193,0001018724", "type": "string" } }, { "name": "companyIds", "required": false, "in": "query", "description": "Comma-separated list of company IDs", "schema": { "example": "4024,5025,6026", "type": "string" } }, { "name": "eventIds", "required": false, "in": "query", "description": "Comma-separated list of event IDs", "schema": { "example": "4042,8934,16342", "type": "string" } }, { "name": "documentGroupIds", "required": false, "in": "query", "description": "\n - 1: Earnings Release\n - 2: Press Release\n - 3: Interim Report\n - 4: Annual Report\n - 5: Proxy Statement\n - 6: Registration Statement\n ", "schema": { "example": "3,4", "type": "string" } }, { "name": "updatedBefore", "required": false, "in": "query", "description": "Query data that was updated before this date (ISO 8601)", "schema": { "example": "2024-01-24T12:00:00Z", "type": "string" } }, { "name": "updatedAfter", "required": false, "in": "query", "description": "Query data that was updated after this date (ISO 8601)", "schema": { "example": "2025-01-12T15:00:00Z", "type": "string" } }, { "name": "expand", "required": false, "in": "query", "description": "Comma-separated list of fields to expand", "schema": { "example": "event", "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedDocumentResponseDto" } } } }, "400": { "description": "", "content": { "application/json": { "schema": { "properties": { "error": { "example": "Bad Request", "type": "string" }, "message": { "items": { "properties": { "field": { "example": "country", "type": "string" }, "message": { "example": "country must be a valid ISO31661 Alpha2 code", "type": "string" } }, "type": "object" }, "type": "array" }, "statusCode": { "example": 400, "type": "number" } }, "type": "object" } } } }, "401": { "description": "", "content": { "application/json": { "schema": { "properties": { "message": { "example": "Unauthorized", "type": "string" }, "statusCode": { "example": 401, "type": "number" } }, "type": "object" } } } }, "403": { "description": "", "content": { "application/json": { "schema": { "properties": { "message": { "example": "Forbidden", "type": "string" }, "statusCode": { "example": 403, "type": "number" } }, "type": "object" } } } } }, "tags": ["Documents"], "security": [{ "apiKey": [] }] } }, "/documents/{id}": { "get": { "operationId": "DocumentControllerV3_getDocumentById", "summary": "Retrieve a document", "parameters": [ { "name": "id", "required": true, "in": "path", "schema": { "type": "number" } }, { "name": "expand", "required": false, "in": "query", "description": "Comma-separated list of fields to expand", "schema": { "example": "event", "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DocumentResponseDto" } } } }, "401": { "description": "", "content": { "application/json": { "schema": { "properties": { "message": { "example": "Unauthorized", "type": "string" }, "statusCode": { "example": 401, "type": "number" } }, "type": "object" } } } }, "403": { "description": "", "content": { "application/json": { "schema": { "properties": { "message": { "example": "Forbidden", "type": "string" }, "statusCode": { "example": 403, "type": "number" } }, "type": "object" } } } }, "404": { "description": "", "content": { "application/json": { "schema": { "properties": { "message": { "example": "Not Found", "type": "string" }, "statusCode": { "example": 404, "type": "number" } }, "type": "object" } } } } }, "tags": ["Documents"], "security": [{ "apiKey": [] }] } }, "/documents/reports": { "get": { "operationId": "ReportsControllerV3_getReports", "summary": "List reports", "parameters": [ { "name": "countries", "required": false, "in": "query", "description": "Comma-separated list of country codes (ISO 3166-1 alpha-2)", "schema": { "example": "US,CA", "type": "string" } }, { "name": "exchanges", "required": false, "in": "query", "description": "Exchange symbols, without blankspace, to filter by.", "schema": { "example": "NasdaqCM,NasdaqGS,NYSE", "type": "string" } }, { "name": "tickers", "required": false, "in": "query", "description": "Comma-separated list of company tickers", "schema": { "example": "AAPL,AMZN", "type": "string" } }, { "name": "limit", "required": false, "in": "query", "description": "The maximum number of items to return in a single request.", "schema": { "maximum": 500, "example": 10, "type": "number" } }, { "name": "cursor", "required": false, "in": "query", "description": "A unique identifier pointing to the starting position for the next set of results.", "schema": { "minimum": 0, "example": 2432, "type": "number" } }, { "name": "direction", "required": false, "in": "query", "description": "The direction of the sort order (id field).", "schema": { "example": "asc", "enum": ["asc", "desc"], "type": "string" } }, { "name": "endDate", "required": false, "in": "query", "description": "The end date (ISO 8601)", "schema": { "example": "2025-01-10T13:00:00Z", "type": "string" } }, { "name": "startDate", "required": false, "in": "query", "description": "The start date (ISO 8601)", "schema": { "example": "2024-12-12T15:00:00Z", "type": "string" } }, { "name": "typeIds", "required": false, "in": "query", "description": "Comma-separated list of type ids", "schema": { "example": "6,13,39", "type": "string" } }, { "name": "isins", "required": false, "in": "query", "description": "Comma-separated list of ISINs", "schema": { "example": "US0378331005,US0231351067", "type": "string" } }, { "name": "ciks", "required": false, "in": "query", "description": "Comma-separated list of CIKs (SEC Central Index Keys)", "schema": { "example": "0000320193,0001018724", "type": "string" } }, { "name": "companyIds", "required": false, "in": "query", "description": "Comma-separated list of company IDs", "schema": { "example": "4024,5025,6026", "type": "string" } }, { "name": "eventIds", "required": false, "in": "query", "description": "Comma-separated list of event IDs", "schema": { "example": "4042,8934,16342", "type": "string" } }, { "name": "documentGroupIds", "required": false, "in": "query", "description": "\n - 1: Earnings Release\n - 2: Press Release\n - 3: Interim Report\n - 4: Annual Report\n - 5: Proxy Statement\n - 6: Registration Statement\n ", "schema": { "example": "3,4", "type": "string" } }, { "name": "updatedBefore", "required": false, "in": "query", "description": "Query data that was updated before this date (ISO 8601)", "schema": { "example": "2024-01-24T12:00:00Z", "type": "string" } }, { "name": "updatedAfter", "required": false, "in": "query", "description": "Query data that was updated after this date (ISO 8601)", "schema": { "example": "2025-01-12T15:00:00Z", "type": "string" } }, { "name": "expand", "required": false, "in": "query", "description": "Comma-separated list of fields to expand", "schema": { "example": "event", "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedDocumentResponseDto" } } } }, "400": { "description": "", "content": { "application/json": { "schema": { "properties": { "error": { "example": "Bad Request", "type": "string" }, "message": { "items": { "properties": { "field": { "example": "country", "type": "string" }, "message": { "example": "country must be a valid ISO31661 Alpha2 code", "type": "string" } }, "type": "object" }, "type": "array" }, "statusCode": { "example": 400, "type": "number" } }, "type": "object" } } } }, "401": { "description": "", "content": { "application/json": { "schema": { "properties": { "message": { "example": "Unauthorized", "type": "string" }, "statusCode": { "example": 401, "type": "number" } }, "type": "object" } } } }, "403": { "description": "", "content": { "application/json": { "schema": { "properties": { "message": { "example": "Forbidden", "type": "string" }, "statusCode": { "example": 403, "type": "number" } }, "type": "object" } } } } }, "tags": ["Reports"], "security": [{ "apiKey": [] }] } }, "/documents/reports/{id}": { "get": { "operationId": "ReportsControllerV3_getReportById", "summary": "Retrieve a report", "parameters": [ { "name": "id", "required": true, "in": "path", "schema": { "type": "number" } }, { "name": "expand", "required": false, "in": "query", "description": "Comma-separated list of fields to expand", "schema": { "example": "event", "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DocumentResponseDto" } } } }, "401": { "description": "", "content": { "application/json": { "schema": { "properties": { "message": { "example": "Unauthorized", "type": "string" }, "statusCode": { "example": 401, "type": "number" } }, "type": "object" } } } }, "403": { "description": "", "content": { "application/json": { "schema": { "properties": { "message": { "example": "Forbidden", "type": "string" }, "statusCode": { "example": 403, "type": "number" } }, "type": "object" } } } }, "404": { "description": "", "content": { "application/json": { "schema": { "properties": { "message": { "example": "Not Found", "type": "string" }, "statusCode": { "example": 404, "type": "number" } }, "type": "object" } } } } }, "tags": ["Reports"], "security": [{ "apiKey": [] }] } }, "/documents/reports/{id}/pages": { "get": { "operationId": "ReportsControllerV3_getReportPages", "summary": "List report pages", "parameters": [ { "name": "id", "required": true, "in": "path", "schema": { "type": "number" } }, { "name": "limit", "required": false, "in": "query", "description": "The maximum number of items to return in a single request.", "schema": { "maximum": 500, "example": 10, "type": "number" } }, { "name": "cursor", "required": false, "in": "query", "description": "A unique identifier pointing to the starting position for the next set of results.", "schema": { "minimum": 0, "example": 2432, "type": "number" } }, { "name": "direction", "required": false, "in": "query", "description": "The direction of the sort order (id field).", "schema": { "example": "asc", "enum": ["asc", "desc"], "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedDocumentDataResponseDto" } } } }, "401": { "description": "", "content": { "application/json": { "schema": { "properties": { "message": { "example": "Unauthorized", "type": "string" }, "statusCode": { "example": 401, "type": "number" } }, "type": "object" } } } }, "403": { "description": "", "content": { "application/json": { "schema": { "properties": { "message": { "example": "Forbidden", "type": "string" }, "statusCode": { "example": 403, "type": "number" } }, "type": "object" } } } } }, "tags": ["Reports"], "security": [{ "apiKey": [] }] } }, "/documents/reports/{id}/summary": { "get": { "operationId": "ReportSummaryControllerV3_getSummary", "summary": "Retrieve a report summary", "parameters": [ { "name": "id", "required": true, "in": "path", "schema": { "type": "number" } }, { "name": "length", "required": false, "in": "query", "description": "Length preset for the summary.", "schema": { "default": "short", "example": "long", "type": "string" } }, { "name": "plain", "required": false, "in": "query", "description": "Plain text summary without document sources embedded.", "schema": { "default": false, "example": true, "type": "boolean" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SummaryResponseDto" } } } }, "401": { "description": "", "content": { "application/json": { "schema": { "properties": { "message": { "example": "Unauthorized", "type": "string" }, "statusCode": { "example": 401, "type": "number" } }, "type": "object" } } } }, "403": { "description": "", "content": { "application/json": { "schema": { "properties": { "message": { "example": "Forbidden", "type": "string" }, "statusCode": { "example": 403, "type": "number" } }, "type": "object" } } } } }, "tags": ["Reports"], "security": [{ "apiKey": [] }] } }, "/documents/reports/{id}/text": { "get": { "operationId": "ReportsTextControllerV3_getText", "summary": "Retrieve a report text", "parameters": [ { "name": "id", "required": true, "in": "path", "schema": { "type": "number" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DocumentTextResponseDto" } } } }, "401": { "description": "", "content": { "application/json": { "schema": { "properties": { "message": { "example": "Unauthorized", "type": "string" }, "statusCode": { "example": 401, "type": "number" } }, "type": "object" } } } }, "403": { "description": "", "content": { "application/json": { "schema": { "properties": { "message": { "example": "Forbidden", "type": "string" }, "statusCode": { "example": 403, "type": "number" } }, "type": "object" } } } } }, "tags": ["Reports"], "security": [{ "apiKey": [] }] } }, "/documents/slides": { "get": { "operationId": "SlidesControllerV3_getSlideDecks", "summary": "List slide decks", "parameters": [ { "name": "countries", "required": false, "in": "query", "description": "Comma-separated list of country codes (ISO 3166-1 alpha-2)", "schema": { "example": "US,CA", "type": "string" } }, { "name": "exchanges", "required": false, "in": "query", "description": "Exchange symbols, without blankspace, to filter by.", "schema": { "example": "NasdaqCM,NasdaqGS,NYSE", "type": "string" } }, { "name": "tickers", "required": false, "in": "query", "description": "Comma-separated list of company tickers", "schema": { "example": "AAPL,AMZN", "type": "string" } }, { "name": "limit", "required": false, "in": "query", "description": "The maximum number of items to return in a single request.", "schema": { "maximum": 500, "example": 10, "type": "number" } }, { "name": "cursor", "required": false, "in": "query", "description": "A unique identifier pointing to the starting position for the next set of results.", "schema": { "minimum": 0, "example": 2432, "type": "number" } }, { "name": "direction", "required": false, "in": "query", "description": "The direction of the sort order (id field).", "schema": { "example": "asc", "enum": ["asc", "desc"], "type": "string" } }, { "name": "endDate", "required": false, "in": "query", "description": "The end date (ISO 8601)", "schema": { "example": "2025-01-10T13:00:00Z", "type": "string" } }, { "name": "startDate", "required": false, "in": "query", "description": "The start date (ISO 8601)", "schema": { "example": "2024-12-12T15:00:00Z", "type": "string" } }, { "name": "typeIds", "required": false, "in": "query", "description": "Comma-separated list of type ids", "schema": { "example": "6,13,39", "type": "string" } }, { "name": "isins", "required": false, "in": "query", "description": "Comma-separated list of ISINs", "schema": { "example": "US0378331005,US0231351067", "type": "string" } }, { "name": "ciks", "required": false, "in": "query", "description": "Comma-separated list of CIKs (SEC Central Index Keys)", "schema": { "example": "0000320193,0001018724", "type": "string" } }, { "name": "companyIds", "required": false, "in": "query", "description": "Comma-separated list of company IDs", "schema": { "example": "4024,5025,6026", "type": "string" } }, { "name": "eventIds", "required": false, "in": "query", "description": "Comma-separated list of event IDs", "schema": { "example": "4042,8934,16342", "type": "string" } }, { "name": "documentGroupIds", "required": false, "in": "query", "description": "\n - 1: Earnings Release\n - 2: Press Release\n - 3: Interim Report\n - 4: Annual Report\n - 5: Proxy Statement\n - 6: Registration Statement\n ", "schema": { "example": "3,4", "type": "string" } }, { "name": "updatedBefore", "required": false, "in": "query", "description": "Query data that was updated before this date (ISO 8601)", "schema": { "example": "2024-01-24T12:00:00Z", "type": "string" } }, { "name": "updatedAfter", "required": false, "in": "query", "description": "Query data that was updated after this date (ISO 8601)", "schema": { "example": "2025-01-12T15:00:00Z", "type": "string" } }, { "name": "expand", "required": false, "in": "query", "description": "Comma-separated list of fields to expand", "schema": { "example": "event", "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedDocumentResponseDto" } } } }, "400": { "description": "", "content": { "application/json": { "schema": { "properties": { "error": { "example": "Bad Request", "type": "string" }, "message": { "items": { "properties": { "field": { "example": "country", "type": "string" }, "message": { "example": "country must be a valid ISO31661 Alpha2 code", "type": "string" } }, "type": "object" }, "type": "array" }, "statusCode": { "example": 400, "type": "number" } }, "type": "object" } } } }, "401": { "description": "", "content": { "application/json": { "schema": { "properties": { "message": { "example": "Unauthorized", "type": "string" }, "statusCode": { "example": 401, "type": "number" } }, "type": "object" } } } }, "403": { "description": "", "content": { "application/json": { "schema": { "properties": { "message": { "example": "Forbidden", "type": "string" }, "statusCode": { "example": 403, "type": "number" } }, "type": "object" } } } } }, "tags": ["Slides"], "security": [{ "apiKey": [] }] } }, "/documents/slides/{id}": { "get": { "operationId": "SlidesControllerV3_getSlideDeckById", "summary": "Retrieve a slide deck", "parameters": [ { "name": "id", "required": true, "in": "path", "schema": { "type": "number" } }, { "name": "expand", "required": false, "in": "query", "description": "Comma-separated list of fields to expand", "schema": { "example": "event", "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DocumentResponseDto" } } } }, "401": { "description": "", "content": { "application/json": { "schema": { "properties": { "message": { "example": "Unauthorized", "type": "string" }, "statusCode": { "example": 401, "type": "number" } }, "type": "object" } } } }, "403": { "description": "", "content": { "application/json": { "schema": { "properties": { "message": { "example": "Forbidden", "type": "string" }, "statusCode": { "example": 403, "type": "number" } }, "type": "object" } } } }, "404": { "description": "", "content": { "application/json": { "schema": { "properties": { "message": { "example": "Not Found", "type": "string" }, "statusCode": { "example": 404, "type": "number" } }, "type": "object" } } } } }, "tags": ["Slides"], "security": [{ "apiKey": [] }] } }, "/documents/slides/{id}/pages": { "get": { "operationId": "SlidesControllerV3_getSlideDeckPages", "summary": "List slide deck pages", "parameters": [ { "name": "id", "required": true, "in": "path", "schema": { "type": "number" } }, { "name": "limit", "required": false, "in": "query", "description": "The maximum number of items to return in a single request.", "schema": { "maximum": 500, "example": 10, "type": "number" } }, { "name": "cursor", "required": false, "in": "query", "description": "A unique identifier pointing to the starting position for the next set of results.", "schema": { "minimum": 0, "example": 2432, "type": "number" } }, { "name": "direction", "required": false, "in": "query", "description": "The direction of the sort order (id field).", "schema": { "example": "asc", "enum": ["asc", "desc"], "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedDocumentDataResponseDto" } } } }, "401": { "description": "", "content": { "application/json": { "schema": { "properties": { "message": { "example": "Unauthorized", "type": "string" }, "statusCode": { "example": 401, "type": "number" } }, "type": "object" } } } }, "403": { "description": "", "content": { "application/json": { "schema": { "properties": { "message": { "example": "Forbidden", "type": "string" }, "statusCode": { "example": 403, "type": "number" } }, "type": "object" } } } } }, "tags": ["Slides"], "security": [{ "apiKey": [] }] } }, "/documents/slides/{id}/summary": { "get": { "operationId": "SlidesSummaryControllerV3_getSummary", "summary": "Retrieve a slide deck summary", "parameters": [ { "name": "id", "required": true, "in": "path", "schema": { "type": "number" } }, { "name": "length", "required": false, "in": "query", "description": "Length preset for the summary.", "schema": { "default": "short", "example": "long", "type": "string" } }, { "name": "plain", "required": false, "in": "query", "description": "Plain text summary without document sources embedded.", "schema": { "default": false, "example": true, "type": "boolean" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SummaryResponseDto" } } } }, "401": { "description": "", "content": { "application/json": { "schema": { "properties": { "message": { "example": "Unauthorized", "type": "string" }, "statusCode": { "example": 401, "type": "number" } }, "type": "object" } } } }, "403": { "description": "", "content": { "application/json": { "schema": { "properties": { "message": { "example": "Forbidden", "type": "string" }, "statusCode": { "example": 403, "type": "number" } }, "type": "object" } } } } }, "tags": ["Slides"], "security": [{ "apiKey": [] }] } }, "/documents/slides/{id}/text": { "get": { "operationId": "SlidesTextControllerV3_getText", "summary": "Retrieve a slide deck text", "parameters": [ { "name": "id", "required": true, "in": "path", "schema": { "type": "number" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DocumentTextResponseDto" } } } }, "401": { "description": "", "content": { "application/json": { "schema": { "properties": { "message": { "example": "Unauthorized", "type": "string" }, "statusCode": { "example": 401, "type": "number" } }, "type": "object" } } } }, "403": { "description": "", "content": { "application/json": { "schema": { "properties": { "message": { "example": "Forbidden", "type": "string" }, "statusCode": { "example": 403, "type": "number" } }, "type": "object" } } } } }, "tags": ["Slides"], "security": [{ "apiKey": [] }] } }, "/documents/transcripts": { "get": { "operationId": "TranscriptControllerV3_getTranscripts", "summary": "List transcripts", "parameters": [ { "name": "countries", "required": false, "in": "query", "description": "Comma-separated list of country codes (ISO 3166-1 alpha-2)", "schema": { "example": "US,CA", "type": "string" } }, { "name": "exchanges", "required": false, "in": "query", "description": "Exchange symbols, without blankspace, to filter by.", "schema": { "example": "NasdaqCM,NasdaqGS,NYSE", "type": "string" } }, { "name": "tickers", "required": false, "in": "query", "description": "Comma-separated list of company tickers", "schema": { "example": "AAPL,AMZN", "type": "string" } }, { "name": "limit", "required": false, "in": "query", "description": "The maximum number of items to return in a single request.", "schema": { "maximum": 500, "example": 10, "type": "number" } }, { "name": "cursor", "required": false, "in": "query", "description": "A unique identifier pointing to the starting position for the next set of results.", "schema": { "minimum": 0, "example": 2432, "type": "number" } }, { "name": "direction", "required": false, "in": "query", "description": "The direction of the sort order (id field).", "schema": { "example": "asc", "enum": ["asc", "desc"], "type": "string" } }, { "name": "endDate", "required": false, "in": "query", "description": "The end date (ISO 8601)", "schema": { "example": "2025-01-10T13:00:00Z", "type": "string" } }, { "name": "startDate", "required": false, "in": "query", "description": "The start date (ISO 8601)", "schema": { "example": "2024-12-12T15:00:00Z", "type": "string" } }, { "name": "typeIds", "required": false, "in": "query", "description": "Comma-separated list of type ids", "schema": { "example": "6,13,39", "type": "string" } }, { "name": "isins", "required": false, "in": "query", "description": "Comma-separated list of ISINs", "schema": { "example": "US0378331005,US0231351067", "type": "string" } }, { "name": "ciks", "required": false, "in": "query", "description": "Comma-separated list of CIKs (SEC Central Index Keys)", "schema": { "example": "0000320193,0001018724", "type": "string" } }, { "name": "companyIds", "required": false, "in": "query", "description": "Comma-separated list of company IDs", "schema": { "example": "4024,5025,6026", "type": "string" } }, { "name": "eventIds", "required": false, "in": "query", "description": "Comma-separated list of event IDs", "schema": { "example": "4042,8934,16342", "type": "string" } }, { "name": "documentGroupIds", "required": false, "in": "query", "description": "\n - 1: Earnings Release\n - 2: Press Release\n - 3: Interim Report\n - 4: Annual Report\n - 5: Proxy Statement\n - 6: Registration Statement\n ", "schema": { "example": "3,4", "type": "string" } }, { "name": "updatedBefore", "required": false, "in": "query", "description": "Query data that was updated before this date (ISO 8601)", "schema": { "example": "2024-01-24T12:00:00Z", "type": "string" } }, { "name": "updatedAfter", "required": false, "in": "query", "description": "Query data that was updated after this date (ISO 8601)", "schema": { "example": "2025-01-12T15:00:00Z", "type": "string" } }, { "name": "expand", "required": false, "in": "query", "description": "Comma-separated list of fields to expand", "schema": { "example": "event", "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedDocumentResponseDto" } } } }, "400": { "description": "", "content": { "application/json": { "schema": { "properties": { "error": { "example": "Bad Request", "type": "string" }, "message": { "items": { "properties": { "field": { "example": "country", "type": "string" }, "message": { "example": "country must be a valid ISO31661 Alpha2 code", "type": "string" } }, "type": "object" }, "type": "array" }, "statusCode": { "example": 400, "type": "number" } }, "type": "object" } } } }, "401": { "description": "", "content": { "application/json": { "schema": { "properties": { "message": { "example": "Unauthorized", "type": "string" }, "statusCode": { "example": 401, "type": "number" } }, "type": "object" } } } }, "403": { "description": "", "content": { "application/json": { "schema": { "properties": { "message": { "example": "Forbidden", "type": "string" }, "statusCode": { "example": 403, "type": "number" } }, "type": "object" } } } } }, "tags": ["Transcripts"], "security": [{ "apiKey": [] }] } }, "/documents/transcripts/{id}": { "get": { "operationId": "TranscriptControllerV3_getTranscriptById", "summary": "Retrieve a transcript", "parameters": [ { "name": "id", "required": true, "in": "path", "schema": { "type": "number" } }, { "name": "expand", "required": false, "in": "query", "description": "Comma-separated list of fields to expand", "schema": { "example": "event", "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DocumentResponseDto" } } } }, "401": { "description": "", "content": { "application/json": { "schema": { "properties": { "message": { "example": "Unauthorized", "type": "string" }, "statusCode": { "example": 401, "type": "number" } }, "type": "object" } } } }, "403": { "description": "", "content": { "application/json": { "schema": { "properties": { "message": { "example": "Forbidden", "type": "string" }, "statusCode": { "example": 403, "type": "number" } }, "type": "object" } } } }, "404": { "description": "", "content": { "application/json": { "schema": { "properties": { "message": { "example": "Not Found", "type": "string" }, "statusCode": { "example": 404, "type": "number" } }, "type": "object" } } } } }, "tags": ["Transcripts"], "security": [{ "apiKey": [] }] } }, "/documents/transcripts/{id}/chapters": { "get": { "operationId": "TranscriptControllerV3_getTranscriptChapters", "summary": "List transcript chapters", "parameters": [ { "name": "id", "required": true, "in": "path", "schema": { "type": "number" } }, { "name": "limit", "required": false, "in": "query", "description": "The maximum number of items to return in a single request.", "schema": { "maximum": 500, "example": 10, "type": "number" } }, { "name": "cursor", "required": false, "in": "query", "description": "A unique identifier pointing to the starting position for the next set of results.", "schema": { "minimum": 0, "example": 2432, "type": "number" } }, { "name": "direction", "required": false, "in": "query", "description": "The direction of the sort order (id field).", "schema": { "example": "asc", "enum": ["asc", "desc"], "type": "string" } }, { "name": "levels", "required": false, "in": "query", "description": "Comma-separated list of chapter levels to include", "schema": { "example": "1,2", "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedChapterResponseDto" } } } }, "401": { "description": "", "content": { "application/json": { "schema": { "properties": { "message": { "example": "Unauthorized", "type": "string" }, "statusCode": { "example": 401, "type": "number" } }, "type": "object" } } } }, "403": { "description": "", "content": { "application/json": { "schema": { "properties": { "message": { "example": "Forbidden", "type": "string" }, "statusCode": { "example": 403, "type": "number" } }, "type": "object" } } } } }, "tags": ["Transcripts"], "security": [{ "apiKey": [] }] } }, "/documents/transcripts/{id}/summary": { "get": { "operationId": "TranscriptSummaryControllerV3_getSummary", "summary": "Retrieve a transcript summary", "parameters": [ { "name": "id", "required": true, "in": "path", "schema": { "type": "number" } }, { "name": "length", "required": false, "in": "query", "description": "Length preset for the summary.", "schema": { "default": "short", "example": "long", "type": "string" } }, { "name": "plain", "required": false, "in": "query", "description": "Plain text summary without document sources embedded.", "schema": { "default": false, "example": true, "type": "boolean" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SummaryResponseDto" } } } }, "401": { "description": "", "content": { "application/json": { "schema": { "properties": { "message": { "example": "Unauthorized", "type": "string" }, "statusCode": { "example": 401, "type": "number" } }, "type": "object" } } } }, "403": { "description": "", "content": { "application/json": { "schema": { "properties": { "message": { "example": "Forbidden", "type": "string" }, "statusCode": { "example": 403, "type": "number" } }, "type": "object" } } } } }, "tags": ["Transcripts"], "security": [{ "apiKey": [] }] } }, "/document-types": { "get": { "operationId": "DocumentTypesControllerV3_getDocumentTypes", "summary": "List document types", "parameters": [ { "name": "limit", "required": false, "in": "query", "description": "The maximum number of items to return in a single request.", "schema": { "maximum": 500, "example": 10, "type": "number" } }, { "name": "cursor", "required": false, "in": "query", "description": "A unique identifier pointing to the starting position for the next set of results.", "schema": { "minimum": 0, "example": 2432, "type": "number" } }, { "name": "direction", "required": false, "in": "query", "description": "The direction of the sort order (id field).", "schema": { "example": "asc", "enum": ["asc", "desc"], "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedDocumentTypeResponseDto" } } } }, "400": { "description": "", "content": { "application/json": { "schema": { "properties": { "error": { "example": "Bad Request", "type": "string" }, "message": { "items": { "properties": { "field": { "example": "country", "type": "string" }, "message": { "example": "country must be a valid ISO31661 Alpha2 code", "type": "string" } }, "type": "object" }, "type": "array" }, "statusCode": { "example": 400, "type": "number" } }, "type": "object" } } } }, "401": { "description": "", "content": { "application/json": { "schema": { "properties": { "message": { "example": "Unauthorized", "type": "string" }, "statusCode": { "example": 401, "type": "number" } }, "type": "object" } } } }, "403": { "description": "", "content": { "application/json": { "schema": { "properties": { "message": { "example": "Forbidden", "type": "string" }, "statusCode": { "example": 403, "type": "number" } }, "type": "object" } } } } }, "tags": ["Document Types"], "security": [{ "apiKey": [] }] } }, "/document-types/{id}": { "get": { "operationId": "DocumentTypesControllerV3_getDocumentTypeById", "summary": "Retrieve a document type", "parameters": [ { "name": "id", "required": true, "in": "path", "schema": { "type": "number" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DocumentTypeResponseDto" } } } }, "401": { "description": "", "content": { "application/json": { "schema": { "properties": { "message": { "example": "Unauthorized", "type": "string" }, "statusCode": { "example": 401, "type": "number" } }, "type": "object" } } } }, "403": { "description": "", "content": { "application/json": { "schema": { "properties": { "message": { "example": "Forbidden", "type": "string" }, "statusCode": { "example": 403, "type": "number" } }, "type": "object" } } } }, "404": { "description": "", "content": { "application/json": { "schema": { "properties": { "message": { "example": "Not Found", "type": "string" }, "statusCode": { "example": 404, "type": "number" } }, "type": "object" } } } } }, "tags": ["Document Types"], "security": [{ "apiKey": [] }] } }, "/audio": { "get": { "operationId": "AudioControllerV3_getAudio", "summary": "List audio", "parameters": [ { "name": "countries", "required": false, "in": "query", "description": "Comma-separated list of country codes (ISO 3166-1 alpha-2)", "schema": { "example": "US,CA", "type": "string" } }, { "name": "exchanges", "required": false, "in": "query", "description": "Exchange symbols, without blankspace, to filter by.", "schema": { "example": "NasdaqCM,NasdaqGS,NYSE", "type": "string" } }, { "name": "tickers", "required": false, "in": "query", "description": "Comma-separated list of company tickers", "schema": { "example": "AAPL,AMZN", "type": "string" } }, { "name": "limit", "required": false, "in": "query", "description": "The maximum number of items to return in a single request.", "schema": { "maximum": 500, "example": 10, "type": "number" } }, { "name": "cursor", "required": false, "in": "query", "description": "A unique identifier pointing to the starting position for the next set of results.", "schema": { "minimum": 0, "example": 2432, "type": "number" } }, { "name": "direction", "required": false, "in": "query", "description": "The direction of the sort order (id field).", "schema": { "example": "asc", "enum": ["asc", "desc"], "type": "string" } }, { "name": "endDate", "required": false, "in": "query", "description": "The end date (ISO 8601)", "schema": { "example": "2025-01-10T13:00:00Z", "type": "string" } }, { "name": "startDate", "required": false, "in": "query", "description": "The start date (ISO 8601)", "schema": { "example": "2024-12-12T15:00:00Z", "type": "string" } }, { "name": "isins", "required": false, "in": "query", "description": "Comma-separated list of ISINs", "schema": { "example": "US0378331005,US0231351067", "type": "string" } }, { "name": "ciks", "required": false, "in": "query", "description": "Comma-separated list of CIKs (SEC Central Index Keys)", "schema": { "example": "0000320193,0001018724", "type": "string" } }, { "name": "companyIds", "required": false, "in": "query", "description": "Comma-separated list of company IDs", "schema": { "example": "4024,5025,6026", "type": "string" } }, { "name": "eventIds", "required": false, "in": "query", "description": "Comma-separated list of event IDs", "schema": { "example": "4042,8934,16342", "type": "string" } }, { "name": "updatedBefore", "required": false, "in": "query", "description": "Query data that was updated before this date (ISO 8601)", "schema": { "example": "2024-01-24T12:00:00Z", "type": "string" } }, { "name": "updatedAfter", "required": false, "in": "query", "description": "Query data that was updated after this date (ISO 8601)", "schema": { "example": "2025-01-12T15:00:00Z", "type": "string" } }, { "name": "expand", "required": false, "in": "query", "description": "Comma-separated list of fields to expand", "schema": { "example": "event", "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedAudioResponseDto" } } } }, "400": { "description": "", "content": { "application/json": { "schema": { "properties": { "error": { "example": "Bad Request", "type": "string" }, "message": { "items": { "properties": { "field": { "example": "country", "type": "string" }, "message": { "example": "country must be a valid ISO31661 Alpha2 code", "type": "string" } }, "type": "object" }, "type": "array" }, "statusCode": { "example": 400, "type": "number" } }, "type": "object" } } } }, "401": { "description": "", "content": { "application/json": { "schema": { "properties": { "message": { "example": "Unauthorized", "type": "string" }, "statusCode": { "example": 401, "type": "number" } }, "type": "object" } } } }, "403": { "description": "", "content": { "application/json": { "schema": { "properties": { "message": { "example": "Forbidden", "type": "string" }, "statusCode": { "example": 403, "type": "number" } }, "type": "object" } } } } }, "tags": ["Backlog Audio"], "security": [{ "apiKey": [] }] } }, "/audio/{id}": { "get": { "operationId": "AudioControllerV3_getAudioById", "summary": "Retrieve an audio", "parameters": [ { "name": "id", "required": true, "in": "path", "schema": { "type": "number" } }, { "name": "expand", "required": false, "in": "query", "description": "Comma-separated list of fields to expand", "schema": { "example": "event", "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AudioResponseDto" } } } }, "401": { "description": "", "content": { "application/json": { "schema": { "properties": { "message": { "example": "Unauthorized", "type": "string" }, "statusCode": { "example": 401, "type": "number" } }, "type": "object" } } } }, "403": { "description": "", "content": { "application/json": { "schema": { "properties": { "message": { "example": "Forbidden", "type": "string" }, "statusCode": { "example": 403, "type": "number" } }, "type": "object" } } } }, "404": { "description": "", "content": { "application/json": { "schema": { "properties": { "message": { "example": "Not Found", "type": "string" }, "statusCode": { "example": 404, "type": "number" } }, "type": "object" } } } } }, "tags": ["Backlog Audio"], "security": [{ "apiKey": [] }] } }, "/audio/{id}/chapters": { "get": { "operationId": "AudioControllerV3_getAudioChapters", "summary": "List audio chapters", "parameters": [ { "name": "id", "required": true, "in": "path", "schema": { "type": "number" } }, { "name": "limit", "required": false, "in": "query", "description": "The maximum number of items to return in a single request.", "schema": { "maximum": 500, "example": 10, "type": "number" } }, { "name": "cursor", "required": false, "in": "query", "description": "A unique identifier pointing to the starting position for the next set of results.", "schema": { "minimum": 0, "example": 2432, "type": "number" } }, { "name": "direction", "required": false, "in": "query", "description": "The direction of the sort order (id field).", "schema": { "example": "asc", "enum": ["asc", "desc"], "type": "string" } }, { "name": "levels", "required": false, "in": "query", "description": "Comma-separated list of chapter levels to include", "schema": { "example": "1,2", "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedChapterResponseDto" } } } }, "401": { "description": "", "content": { "application/json": { "schema": { "properties": { "message": { "example": "Unauthorized", "type": "string" }, "statusCode": { "example": 401, "type": "number" } }, "type": "object" } } } }, "403": { "description": "", "content": { "application/json": { "schema": { "properties": { "message": { "example": "Forbidden", "type": "string" }, "statusCode": { "example": 403, "type": "number" } }, "type": "object" } } } } }, "tags": ["Backlog Audio"], "security": [{ "apiKey": [] }] } }, "/live": { "get": { "operationId": "LiveControllerV3_getLivePaginated", "summary": "List live events", "parameters": [ { "name": "countries", "required": false, "in": "query", "description": "Comma-separated list of country codes (ISO 3166-1 alpha-2)", "schema": { "example": "US,CA", "type": "string" } }, { "name": "exchanges", "required": false, "in": "query", "description": "Exchange symbols, without blankspace, to filter by.", "schema": { "example": "NasdaqCM,NasdaqGS,NYSE", "type": "string" } }, { "name": "tickers", "required": false, "in": "query", "description": "Comma-separated list of company tickers", "schema": { "example": "AAPL,AMZN", "type": "string" } }, { "name": "limit", "required": false, "in": "query", "description": "The maximum number of items to return in a single request.", "schema": { "maximum": 500, "example": 10, "type": "number" } }, { "name": "cursor", "required": false, "in": "query", "description": "A unique identifier pointing to the starting position for the next set of results.", "schema": { "minimum": 0, "example": 2432, "type": "number" } }, { "name": "direction", "required": false, "in": "query", "description": "The direction of the sort order (id field).", "schema": { "example": "asc", "enum": ["asc", "desc"], "type": "string" } }, { "name": "isins", "required": false, "in": "query", "description": "Comma-separated list of ISINs", "schema": { "example": "US0378331005,US0231351067", "type": "string" } }, { "name": "ciks", "required": false, "in": "query", "description": "Comma-separated list of CIKs (SEC Central Index Keys)", "schema": { "example": "0000320193,0001018724", "type": "string" } }, { "name": "companyIds", "required": false, "in": "query", "description": "Comma-separated list of company IDs", "schema": { "example": "4024,5025,6026", "type": "string" } }, { "name": "eventIds", "required": false, "in": "query", "description": "Comma-separated list of event IDs", "schema": { "example": "4042,8934,16342", "type": "string" } }, { "name": "states", "required": false, "in": "query", "description": "\n - notLive\n - willBeLive\n - live\n - liveFailedInterrupted\n - liveFailedNoAccess\n - liveFailedNotStarted\n - processingRecording\n - processingRecordingFailed\n - recordingAvailable\n ", "schema": { "example": "willBeLive,live", "type": "string" } }, { "name": "transcriptVersion", "required": false, "in": "query", "description": "The version of the live transcript stream", "schema": { "example": "1.6", "enum": ["1.6", "1.7"], "type": "string" } }, { "name": "endDate", "required": false, "in": "query", "description": "The end date (ISO 8601)", "schema": { "example": "2025-01-10T13:00:00Z", "type": "string" } }, { "name": "startDate", "required": false, "in": "query", "description": "The start date (ISO 8601)", "schema": { "example": "2024-12-12T15:00:00Z", "type": "string" } }, { "name": "updatedBefore", "required": false, "in": "query", "description": "Query data that was updated before this date (ISO 8601)", "schema": { "example": "2024-01-24T12:00:00Z", "type": "string" } }, { "name": "updatedAfter", "required": false, "in": "query", "description": "Query data that was updated after this date (ISO 8601)", "schema": { "example": "2025-01-12T15:00:00Z", "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedLiveResponseDto" } } } }, "400": { "description": "", "content": { "application/json": { "schema": { "properties": { "error": { "example": "Bad Request", "type": "string" }, "message": { "items": { "properties": { "field": { "example": "country", "type": "string" }, "message": { "example": "country must be a valid ISO31661 Alpha2 code", "type": "string" } }, "type": "object" }, "type": "array" }, "statusCode": { "example": 400, "type": "number" } }, "type": "object" } } } }, "401": { "description": "", "content": { "application/json": { "schema": { "properties": { "message": { "example": "Unauthorized", "type": "string" }, "statusCode": { "example": 401, "type": "number" } }, "type": "object" } } } }, "403": { "description": "", "content": { "application/json": { "schema": { "properties": { "message": { "example": "Forbidden", "type": "string" }, "statusCode": { "example": 403, "type": "number" } }, "type": "object" } } } } }, "tags": ["Live"], "security": [{ "apiKey": [] }] } }, "/live/{id}": { "get": { "operationId": "LiveControllerV3_getLiveById", "summary": "Retrieve a live event", "parameters": [ { "name": "id", "required": true, "in": "path", "schema": { "type": "number" } }, { "name": "transcriptVersion", "required": false, "in": "query", "description": "The version of the live transcript stream", "schema": { "example": "1.6", "enum": ["1.6", "1.7"], "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LiveResponseDto" } } } }, "401": { "description": "", "content": { "application/json": { "schema": { "properties": { "message": { "example": "Unauthorized", "type": "string" }, "statusCode": { "example": 401, "type": "number" } }, "type": "object" } } } }, "403": { "description": "", "content": { "application/json": { "schema": { "properties": { "message": { "example": "Forbidden", "type": "string" }, "statusCode": { "example": 403, "type": "number" } }, "type": "object" } } } }, "404": { "description": "", "content": { "application/json": { "schema": { "properties": { "message": { "example": "Not Found", "type": "string" }, "statusCode": { "example": 404, "type": "number" } }, "type": "object" } } } } }, "tags": ["Live"], "security": [{ "apiKey": [] }] } }, "/live/audio": { "get": { "operationId": "AudioControllerV3_getLiveAudio", "summary": "List live audio", "parameters": [ { "name": "countries", "required": false, "in": "query", "description": "Comma-separated list of country codes (ISO 3166-1 alpha-2)", "schema": { "example": "US,CA", "type": "string" } }, { "name": "exchanges", "required": false, "in": "query", "description": "Exchange symbols, without blankspace, to filter by.", "schema": { "example": "NasdaqCM,NasdaqGS,NYSE", "type": "string" } }, { "name": "tickers", "required": false, "in": "query", "description": "Comma-separated list of company tickers", "schema": { "example": "AAPL,AMZN", "type": "string" } }, { "name": "limit", "required": false, "in": "query", "description": "The maximum number of items to return in a single request.", "schema": { "maximum": 500, "example": 10, "type": "number" } }, { "name": "cursor", "required": false, "in": "query", "description": "A unique identifier pointing to the starting position for the next set of results.", "schema": { "minimum": 0, "example": 2432, "type": "number" } }, { "name": "direction", "required": false, "in": "query", "description": "The direction of the sort order (id field).", "schema": { "example": "asc", "enum": ["asc", "desc"], "type": "string" } }, { "name": "isins", "required": false, "in": "query", "description": "Comma-separated list of ISINs", "schema": { "example": "US0378331005,US0231351067", "type": "string" } }, { "name": "ciks", "required": false, "in": "query", "description": "Comma-separated list of CIKs (SEC Central Index Keys)", "schema": { "example": "0000320193,0001018724", "type": "string" } }, { "name": "companyIds", "required": false, "in": "query", "description": "Comma-separated list of company IDs", "schema": { "example": "4024,5025,6026", "type": "string" } }, { "name": "eventIds", "required": false, "in": "query", "description": "Comma-separated list of event IDs", "schema": { "example": "4042,8934,16342", "type": "string" } }, { "name": "states", "required": false, "in": "query", "description": "\n - notLive\n - willBeLive\n - live\n - liveFailedInterrupted\n - liveFailedNoAccess\n - liveFailedNotStarted\n - processingRecording\n - processingRecordingFailed\n - recordingAvailable\n ", "schema": { "example": "willBeLive,live", "type": "string" } }, { "name": "endDate", "required": false, "in": "query", "description": "The end date (ISO 8601)", "schema": { "example": "2025-01-10T13:00:00Z", "type": "string" } }, { "name": "startDate", "required": false, "in": "query", "description": "The start date (ISO 8601)", "schema": { "example": "2024-12-12T15:00:00Z", "type": "string" } }, { "name": "updatedBefore", "required": false, "in": "query", "description": "Query data that was updated before this date (ISO 8601)", "schema": { "example": "2024-01-24T12:00:00Z", "type": "string" } }, { "name": "updatedAfter", "required": false, "in": "query", "description": "Query data that was updated after this date (ISO 8601)", "schema": { "example": "2025-01-12T15:00:00Z", "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedLiveAudioResponseDto" } } } }, "400": { "description": "", "content": { "application/json": { "schema": { "properties": { "error": { "example": "Bad Request", "type": "string" }, "message": { "items": { "properties": { "field": { "example": "country", "type": "string" }, "message": { "example": "country must be a valid ISO31661 Alpha2 code", "type": "string" } }, "type": "object" }, "type": "array" }, "statusCode": { "example": 400, "type": "number" } }, "type": "object" } } } }, "401": { "description": "", "content": { "application/json": { "schema": { "properties": { "message": { "example": "Unauthorized", "type": "string" }, "statusCode": { "example": 401, "type": "number" } }, "type": "object" } } } }, "403": { "description": "", "content": { "application/json": { "schema": { "properties": { "message": { "example": "Forbidden", "type": "string" }, "statusCode": { "example": 403, "type": "number" } }, "type": "object" } } } } }, "tags": ["Live Audio"], "security": [{ "apiKey": [] }] } }, "/live/audio/{id}": { "get": { "operationId": "AudioControllerV3_getLiveAudioById", "summary": "Retrieve a live audio", "parameters": [ { "name": "id", "required": true, "in": "path", "schema": { "type": "number" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LiveAudioResponseDto" } } } }, "401": { "description": "", "content": { "application/json": { "schema": { "properties": { "message": { "example": "Unauthorized", "type": "string" }, "statusCode": { "example": 401, "type": "number" } }, "type": "object" } } } }, "403": { "description": "", "content": { "application/json": { "schema": { "properties": { "message": { "example": "Forbidden", "type": "string" }, "statusCode": { "example": 403, "type": "number" } }, "type": "object" } } } }, "404": { "description": "", "content": { "application/json": { "schema": { "properties": { "message": { "example": "Not Found", "type": "string" }, "statusCode": { "example": 404, "type": "number" } }, "type": "object" } } } } }, "tags": ["Live Audio"], "security": [{ "apiKey": [] }] } }, "/live/transcripts": { "get": { "operationId": "TranscriptsControllerV3_getLiveTranscripts", "summary": "List live transcripts", "parameters": [ { "name": "countries", "required": false, "in": "query", "description": "Comma-separated list of country codes (ISO 3166-1 alpha-2)", "schema": { "example": "US,CA", "type": "string" } }, { "name": "exchanges", "required": false, "in": "query", "description": "Exchange symbols, without blankspace, to filter by.", "schema": { "example": "NasdaqCM,NasdaqGS,NYSE", "type": "string" } }, { "name": "tickers", "required": false, "in": "query", "description": "Comma-separated list of company tickers", "schema": { "example": "AAPL,AMZN", "type": "string" } }, { "name": "limit", "required": false, "in": "query", "description": "The maximum number of items to return in a single request.", "schema": { "maximum": 500, "example": 10, "type": "number" } }, { "name": "cursor", "required": false, "in": "query", "description": "A unique identifier pointing to the starting position for the next set of results.", "schema": { "minimum": 0, "example": 2432, "type": "number" } }, { "name": "direction", "required": false, "in": "query", "description": "The direction of the sort order (id field).", "schema": { "example": "asc", "enum": ["asc", "desc"], "type": "string" } }, { "name": "isins", "required": false, "in": "query", "description": "Comma-separated list of ISINs", "schema": { "example": "US0378331005,US0231351067", "type": "string" } }, { "name": "ciks", "required": false, "in": "query", "description": "Comma-separated list of CIKs (SEC Central Index Keys)", "schema": { "example": "0000320193,0001018724", "type": "string" } }, { "name": "companyIds", "required": false, "in": "query", "description": "Comma-separated list of company IDs", "schema": { "example": "4024,5025,6026", "type": "string" } }, { "name": "eventIds", "required": false, "in": "query", "description": "Comma-separated list of event IDs", "schema": { "example": "4042,8934,16342", "type": "string" } }, { "name": "states", "required": false, "in": "query", "description": "\n - notLive\n - willBeLive\n - live\n - liveFailedInterrupted\n - liveFailedNoAccess\n - liveFailedNotStarted\n - processingRecording\n - processingRecordingFailed\n - recordingAvailable\n ", "schema": { "example": "willBeLive,live", "type": "string" } }, { "name": "transcriptVersion", "required": false, "in": "query", "description": "The version of the live transcript stream", "schema": { "example": "1.6", "enum": ["1.6", "1.7"], "type": "string" } }, { "name": "endDate", "required": false, "in": "query", "description": "The end date (ISO 8601)", "schema": { "example": "2025-01-10T13:00:00Z", "type": "string" } }, { "name": "startDate", "required": false, "in": "query", "description": "The start date (ISO 8601)", "schema": { "example": "2024-12-12T15:00:00Z", "type": "string" } }, { "name": "updatedBefore", "required": false, "in": "query", "description": "Query data that was updated before this date (ISO 8601)", "schema": { "example": "2024-01-24T12:00:00Z", "type": "string" } }, { "name": "updatedAfter", "required": false, "in": "query", "description": "Query data that was updated after this date (ISO 8601)", "schema": { "example": "2025-01-12T15:00:00Z", "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedLiveTranscriptResponseDto" } } } }, "400": { "description": "", "content": { "application/json": { "schema": { "properties": { "error": { "example": "Bad Request", "type": "string" }, "message": { "items": { "properties": { "field": { "example": "country", "type": "string" }, "message": { "example": "country must be a valid ISO31661 Alpha2 code", "type": "string" } }, "type": "object" }, "type": "array" }, "statusCode": { "example": 400, "type": "number" } }, "type": "object" } } } }, "401": { "description": "", "content": { "application/json": { "schema": { "properties": { "message": { "example": "Unauthorized", "type": "string" }, "statusCode": { "example": 401, "type": "number" } }, "type": "object" } } } }, "403": { "description": "", "content": { "application/json": { "schema": { "properties": { "message": { "example": "Forbidden", "type": "string" }, "statusCode": { "example": 403, "type": "number" } }, "type": "object" } } } } }, "tags": ["Live Transcripts"], "security": [{ "apiKey": [] }] } }, "/live/transcripts/{id}": { "get": { "operationId": "TranscriptsControllerV3_getLiveTranscriptById", "summary": "Retrieve a live transcript", "parameters": [ { "name": "id", "required": true, "in": "path", "schema": { "type": "number" } }, { "name": "transcriptVersion", "required": false, "in": "query", "description": "The version of the live transcript stream", "schema": { "example": "1.6", "enum": ["1.6", "1.7"], "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LiveTranscriptResponseDto" } } } }, "401": { "description": "", "content": { "application/json": { "schema": { "properties": { "message": { "example": "Unauthorized", "type": "string" }, "statusCode": { "example": 401, "type": "number" } }, "type": "object" } } } }, "403": { "description": "", "content": { "application/json": { "schema": { "properties": { "message": { "example": "Forbidden", "type": "string" }, "statusCode": { "example": 403, "type": "number" } }, "type": "object" } } } }, "404": { "description": "", "content": { "application/json": { "schema": { "properties": { "message": { "example": "Not Found", "type": "string" }, "statusCode": { "example": 404, "type": "number" } }, "type": "object" } } } } }, "tags": ["Live Transcripts"], "security": [{ "apiKey": [] }] } } }, "info": { "title": "Quartr Public API", "description": "The Quartr Public API", "version": "3.0", "contact": {} }, "tags": [ { "name": "Companies", "description": "" }, { "name": "Events", "description": "" }, { "name": "Event Types", "description": "" }, { "name": "Documents", "description": "" }, { "name": "Document Types", "description": "" }, { "name": "Reports", "description": "" }, { "name": "Slides", "description": "" }, { "name": "Transcripts", "description": "" }, { "name": "Backlog Audio", "description": "" }, { "name": "Live", "description": "" }, { "name": "Live Audio", "description": "" }, { "name": "Live Transcripts", "description": "" } ], "servers": [{ "url": "https://api.quartr.com" }], "components": { "securitySchemes": { "apiKey": { "in": "header", "name": "x-api-key", "type": "apiKey" } }, "schemas": { "PaginatedCompaniesResponseDto": { "type": "object", "properties": {} }, "CompanyResponseDto": { "type": "object", "properties": {} }, "PaginatedSegmentResponseDto": { "type": "object", "properties": {} }, "PaginatedEventResponseDto": { "type": "object", "properties": {} }, "EventResponseDto": { "type": "object", "properties": {} }, "SummaryResponseDto": { "type": "object", "properties": {} }, "PaginatedEventTypeResponseDto": { "type": "object", "properties": {} }, "EventTypeResponseDto": { "type": "object", "properties": {} }, "PaginatedDocumentResponseDto": { "type": "object", "properties": {} }, "DocumentResponseDto": { "type": "object", "properties": {} }, "PaginatedDocumentDataResponseDto": { "type": "object", "properties": {} }, "DocumentTextResponseDto": { "type": "object", "properties": {} }, "PaginatedChapterResponseDto": { "type": "object", "properties": {} }, "PaginatedDocumentTypeResponseDto": { "type": "object", "properties": {} }, "DocumentTypeResponseDto": { "type": "object", "properties": {} }, "PaginatedAudioResponseDto": { "type": "object", "properties": {} }, "AudioResponseDto": { "type": "object", "properties": {} }, "PaginatedLiveResponseDto": { "type": "object", "properties": {} }, "LiveResponseDto": { "type": "object", "properties": {} }, "PaginatedLiveAudioResponseDto": { "type": "object", "properties": {} }, "LiveAudioResponseDto": { "type": "object", "properties": {} }, "PaginatedLiveTranscriptResponseDto": { "type": "object", "properties": {} }, "LiveTranscriptResponseDto": { "type": "object", "properties": {} } } } }