openapi: 3.0.0 info: contact: {} description: This REST API provides endpoints to all Benzinga APIs. termsOfService: http://swagger.io/terms/ title: Benzinga APIs version: 1.0.0 paths: /api/v1/analyst/reports/raw-text: get: description: Get Analyst Reports Raw Text Data operationId: get-analyst-reports-raw-text-data parameters: - description: Page number in: query name: page schema: type: integer - description: Page size in: query name: pagesize schema: type: integer responses: "200": description: OK content: application/json: schema: items: $ref: "#/components/schemas/models.AnalystReportRawText" type: array "400": description: Bad Request content: application/json: schema: items: type: string type: array "500": description: Internal Server Error content: application/json: schema: items: type: string type: array security: - ApiKeyAuth: [] summary: Get Analyst Reports Raw Text Data tags: - Analyst Reports Raw Text /analyst/insights: get: description: Get Analyst Insights V1 operationId: get-analyst-insights-v1 parameters: - description: Page number in: query name: page schema: type: integer - description: Page size in: query name: pageSize schema: type: integer - description: Symbols in: query name: symbols schema: type: string - description: Analyst in: query name: analyst schema: type: string - description: Rating ID in: query name: rating_id schema: type: string - description: Firm in: query name: search_keys_type schema: type: string enum: - 'firm_id' - 'firm' - 'analyst_id' - 'analyst_name' - description: Firm name in: query name: search_keys schema: type: string responses: "200": description: Analyst Insights content: application/json: schema: $ref: "#/components/schemas/models.AnalystInsightsJSON" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/api.ErrorResponse" "500": description: Internal Server Error content: application/json: schema: $ref: "#/components/schemas/api.ErrorResponse" security: - ApiKeyAuth: [] summary: Get Analyst Insights V1 tags: - Analyst Insights /api/v2.1/calendar/ipos: get: description: Returns the IPOs data operationId: get-ipos-v21 parameters: - description: Page number in: query name: page schema: type: integer - description: Page size in: query name: pagesize schema: type: integer - description: Date in YYYY-MM-DD format in: query name: parameters[date] schema: type: string format: date - description: Start date in YYYY-MM-DD format in: query name: parameters[date_from] schema: type: string format: date - description: End date in YYYY-MM-DD format in: query name: parameters[date_to] schema: type: string format: date - description: Tickers in: query name: parameters[tickers] schema: type: string - description: IPO type in: query name: parameters[ipo_type] schema: type: string - description: Updated time in Unix format in: query name: parameters[updated] schema: type: string format: int64 responses: "200": description: IPOs content: application/json: schema: $ref: "#/components/schemas/models.IPOJSON" text/xml: schema: $ref: "#/components/schemas/models.IPOJSON" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/api.ErrorResponse" text/xml: schema: $ref: "#/components/schemas/api.ErrorResponse" "500": description: Internal Server Error content: application/json: schema: $ref: "#/components/schemas/api.ErrorResponse" text/xml: schema: $ref: "#/components/schemas/api.ErrorResponse" security: - ApiKeyAuth: [] summary: Get IPOs V2.1 tags: - ipos # Pagination extension added here x-speakeasy-pagination: type: offsetLimit inputs: - name: page in: parameters type: page - name: pageSize in: parameters type: pageSize outputs: results: "$.analyst-insights" /api/v2.2/calendar/dividends: get: description: Returns a list of dividends operationId: get-dividends-v22 parameters: - description: Page number in: query name: page schema: type: integer - description: Page size in: query name: pagesize schema: type: integer - description: Date in YYYY-MM-DD format in: query name: parameters[date] schema: type: string format: date - description: Start date in YYYY-MM-DD format in: query name: parameters[date_from] schema: type: string format: date - description: End date in YYYY-MM-DD format in: query name: parameters[date_to] schema: type: string format: date - description: Date sort order in: query name: parameters[date_sort] schema: type: string enum: - 'announced' - 'ex' - 'payable' - 'record' - description: Dividend yield operation in: query name: parameters[dividend_yield_operation] schema: type: string - description: Dividend yield in: query name: parameters[dividend_yield] schema: type: number - description: Importance in: query name: parameters[importance] schema: type: integer enum: - 0 - 1 - 2 - 3 - 4 - 5 - description: Tickers in: query name: parameters[tickers] schema: type: string - description: Updated time in Unix format in: query name: parameters[updated] schema: type: string format: int64 responses: "200": description: Dividends content: application/json: schema: $ref: "#/components/schemas/models.DividendJSON" text/xml: schema: $ref: "#/components/schemas/models.DividendJSON" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/api.ErrorResponse" text/xml: schema: $ref: "#/components/schemas/api.ErrorResponse" "500": description: Internal Server Error content: application/json: schema: $ref: "#/components/schemas/api.ErrorResponse" text/xml: schema: $ref: "#/components/schemas/api.ErrorResponse" security: - ApiKeyAuth: [] summary: Get Dividends V2.2 tags: - Dividends /api/v2/calendar/ipos: get: description: Returns the IPOs data operationId: get-ipos-v2 parameters: - description: Page number in: query name: page schema: type: integer - description: Page size in: query name: pagesize schema: type: integer - description: Date in YYYY-MM-DD format in: query name: parameters[date] schema: type: string format: date - description: Start date in YYYY-MM-DD format in: query name: parameters[date_from] schema: type: string format: date - description: End date in YYYY-MM-DD format in: query name: parameters[date_to] schema: type: string format: date - description: Tickers in: query name: parameters[tickers] schema: type: string - description: IPO type in: query name: parameters[ipo_type] schema: type: string - description: Updated time in Unix format in: query name: parameters[updated] schema: type: string format: int64 responses: "200": description: IPOs content: application/json: schema: $ref: "#/components/schemas/models.IPOJSON" text/xml: schema: $ref: "#/components/schemas/models.IPOJSON" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/api.ErrorResponse" text/xml: schema: $ref: "#/components/schemas/api.ErrorResponse" "500": description: Internal Server Error content: application/json: schema: $ref: "#/components/schemas/api.ErrorResponse" text/xml: schema: $ref: "#/components/schemas/api.ErrorResponse" security: - ApiKeyAuth: [] summary: Get IPOs V2 tags: - ipos /bulls_bears_say: get: description: Get Bulls Say Bears Say V1 operationId: get-bulls-say-bears-say-v1 parameters: - description: Symbols in: query name: symbols schema: type: string responses: "200": description: Bulls Say Bears Say content: application/json: schema: $ref: "#/components/schemas/models.BullsSayBearsSayJSON" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/api.ErrorResponse" "500": description: Internal Server Error content: application/json: schema: $ref: "#/components/schemas/api.ErrorResponse" security: - ApiKeyAuth: [] summary: Get Bulls Say Bears Say V1 tags: - Bulls Say Bears Say /calendar-removed/: get: description: Get Removed from v2 endpoint operationId: get-removed parameters: - description: Page number in: query name: page schema: type: integer - description: Page size in: query name: pageSize schema: type: integer - description: Type in: query name: type schema: type: string enum: - 'ratings' - 'earnings' - 'dividends' - 'splits' - 'ipos' - 'offerings' - 'economics' - 'guidance' - 'ma' - 'conference calls' - description: Updated time in Unix format in: query name: updated schema: type: integer format: int64 responses: "200": description: Removed content: application/json: schema: $ref: "#/components/schemas/models.RmvdJSON" text/xml: schema: $ref: "#/components/schemas/models.RmvdJSON" "500": description: Internal Error content: application/json: schema: type: string text/xml: schema: type: string security: - ApiKeyAuth: [] summary: Get Removed (v2) tags: - removed /calendar/conference-calls: get: description: Returns Conference Calls data operationId: get-conference-calls parameters: - description: Page number in: query name: page schema: type: integer - description: Page size in: query name: pagesize schema: type: integer - description: Date in YYYY-MM-DD format in: query name: parameters[date] schema: type: string format: date - description: Start date in YYYY-MM-DD format in: query name: parameters[date_from] schema: type: string format: date - description: End date in YYYY-MM-DD format in: query name: parameters[date_to] schema: type: string format: date - description: Tickers in: query name: parameters[tickers] schema: type: string - description: Updated time in Unix format in: query name: parameters[updated] schema: type: string format: int64 responses: "200": description: Conference Calls content: application/json: schema: $ref: "#/components/schemas/models.ConferenceJSON" text/xml: schema: $ref: "#/components/schemas/models.ConferenceJSON" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/api.ErrorResponse" text/xml: schema: $ref: "#/components/schemas/api.ErrorResponse" "500": description: Internal Server Error content: application/json: schema: $ref: "#/components/schemas/api.ErrorResponse" text/xml: schema: $ref: "#/components/schemas/api.ErrorResponse" security: - ApiKeyAuth: [] summary: Get Conference Calls tags: - conference_calls /calendar/dividends: get: description: Returns a list of dividends operationId: get-dividends parameters: - description: Page number in: query name: page schema: type: integer - description: Page size in: query name: pagesize schema: type: integer - description: Date in YYYY-MM-DD format in: query name: parameters[date] schema: type: string format: date - description: Start date in YYYY-MM-DD format in: query name: parameters[date_from] schema: type: string format: date - description: End date in YYYY-MM-DD format in: query name: parameters[date_to] schema: type: string format: date - description: Date sort order in: query name: parameters[date_sort] schema: type: string enum: - 'announced' - 'ex' - 'payable' - 'record' - description: Dividend yield operation in: query name: parameters[dividend_yield_operation] schema: type: string enum: - 'lt' - 'lte' - 'eq' - 'gt' - 'gte' - description: Dividend yield in: query name: parameters[dividend_yield] schema: type: number - description: Importance in: query name: parameters[importance] schema: type: integer enum: - 0 - 1 - 2 - 3 - 4 - 5 - description: Tickers in: query name: parameters[tickers] schema: type: string - description: Updated time in Unix format in: query name: parameters[updated] schema: type: string format: int64 responses: "200": description: Dividends content: application/json: schema: $ref: "#/components/schemas/models.DividendJSON" text/xml: schema: $ref: "#/components/schemas/models.DividendJSON" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/api.ErrorResponse" text/xml: schema: $ref: "#/components/schemas/api.ErrorResponse" "500": description: Internal Server Error content: application/json: schema: $ref: "#/components/schemas/api.ErrorResponse" text/xml: schema: $ref: "#/components/schemas/api.ErrorResponse" security: - ApiKeyAuth: [] summary: Get Dividends V2 & V2.1 tags: - Dividends /calendar/earnings: get: description: Returns the earnings data operationId: get-earnings parameters: - description: Page number in: query name: page schema: type: integer - description: Page size in: query name: pagesize schema: type: integer - description: Date in YYYY-MM-DD format in: query name: parameters[date] schema: type: string format: date - description: Start date in YYYY-MM-DD format in: query name: parameters[date_from] schema: type: string format: date - description: End date in YYYY-MM-DD format in: query name: parameters[date_to] schema: type: string format: date - description: Sort by date in: query name: parameters[date_sort] schema: type: string enum: - date - description: Importance in: query name: parameters[importance] schema: type: integer - description: Tickers in: query name: parameters[tickers] schema: type: string - description: Updated time in Unix format in: query name: parameters[updated] schema: type: string format: int64 responses: "200": description: Earnings content: application/json: schema: $ref: "#/components/schemas/models.EarningJSON" text/xml: schema: $ref: "#/components/schemas/models.EarningJSON" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/api.ErrorResponse" text/xml: schema: $ref: "#/components/schemas/api.ErrorResponse" "500": description: Internal Server Error content: application/json: schema: $ref: "#/components/schemas/api.ErrorResponse" text/xml: schema: $ref: "#/components/schemas/api.ErrorResponse" security: - ApiKeyAuth: [] summary: Get Earnings tags: - earnings /calendar/economics: get: description: Returns the economic calendar data operationId: get-economics parameters: - description: Page number in: query name: page schema: type: integer - description: Page size in: query name: pagesize schema: type: integer - description: Date in YYYY-MM-DD format in: query name: parameters[date] schema: type: string format: date - description: Start date in YYYY-MM-DD format in: query name: parameters[date_from] schema: type: string format: date - description: End date in YYYY-MM-DD format in: query name: parameters[date_to] schema: type: string format: date - description: Importance in: query name: parameters[importance] schema: type: integer enum: - 0 - 1 - 2 - 3 - 4 - 5 - description: Country in: query name: country schema: type: string - description: Updated time in Unix format in: query name: parameters[updated] schema: type: string format: int64 - description: Event category in: query name: event_category schema: type: string responses: "200": description: Economics content: application/json: schema: $ref: "#/components/schemas/models.EconomicJSON" text/xml: schema: $ref: "#/components/schemas/models.EconomicJSON" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/api.ErrorResponse" text/xml: schema: $ref: "#/components/schemas/api.ErrorResponse" "500": description: Internal Server Error content: application/json: schema: $ref: "#/components/schemas/api.ErrorResponse" text/xml: schema: $ref: "#/components/schemas/api.ErrorResponse" security: - ApiKeyAuth: [] summary: Get Economics tags: - economics /calendar/events: get: description: Get Events operationId: get-events parameters: - description: Page number in: query name: page schema: type: integer - description: Page size in: query name: pagesize schema: type: integer - description: Date in YYYY-MM-DD format in: query name: parameters[date] schema: type: string format: date - description: Start date in YYYY-MM-DD format in: query name: parameters[date_from] schema: type: string format: date - description: End date in YYYY-MM-DD format in: query name: parameters[date_to] schema: type: string format: date - description: Importance in: query name: parameters[importance] schema: type: integer enum: - 0 - 1 - 2 - 3 - 4 - 5 - description: Tickers in: query name: parameters[tickers] schema: type: string - description: Updated time in Unix format in: query name: parameters[updated] schema: type: string format: int64 responses: "200": description: Events content: application/json: schema: $ref: "#/components/schemas/models.EventsJSON" text/xml: schema: $ref: "#/components/schemas/models.EventsJSON" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/api.ErrorResponse" text/xml: schema: $ref: "#/components/schemas/api.ErrorResponse" "500": description: Internal Server Error content: application/json: schema: $ref: "#/components/schemas/api.ErrorResponse" text/xml: schema: $ref: "#/components/schemas/api.ErrorResponse" security: - ApiKeyAuth: [] summary: Get Events tags: - events /calendar/fda: get: description: FDA approvals, clinical trials, and PDUFA dates operationId: get-fda parameters: - description: Page number in: query name: page schema: type: integer - description: Page size in: query name: pagesize schema: type: integer - description: Date in YYYY-MM-DD format in: query name: parameters[date] schema: type: string format: date - description: Start date in YYYY-MM-DD format in: query name: parameters[date_from] schema: type: string format: date - description: End date in YYYY-MM-DD format in: query name: parameters[date_to] schema: type: string format: date - description: Date search field in: query name: parameters[date_search_field] schema: type: string enum: - announced - target - description: Date search strict in: query name: parameters[date_search_strict] schema: type: boolean - description: Securities in: query name: parameters[securities] schema: type: string - description: Updated time in Unix format in: query name: parameters[updated] schema: type: string format: int64 responses: "200": description: FDA content: application/json: schema: $ref: "#/components/schemas/models.FDAJSON" text/xml: schema: $ref: "#/components/schemas/models.FDAJSON" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/api.ErrorResponse" text/xml: schema: $ref: "#/components/schemas/api.ErrorResponse" "500": description: Internal Server Error content: application/json: schema: $ref: "#/components/schemas/api.ErrorResponse" text/xml: schema: $ref: "#/components/schemas/api.ErrorResponse" security: - ApiKeyAuth: [] summary: Get FDA tags: - fda /calendar/guidance: get: description: Returns the guidance data operationId: get-guidance parameters: - description: Page number in: query name: page schema: type: integer - description: Page size in: query name: pagesize schema: type: integer - description: Date in YYYY-MM-DD format in: query name: parameters[date] schema: type: string format: date - description: Start date in YYYY-MM-DD format in: query name: parameters[date_from] schema: type: string format: date - description: End date in YYYY-MM-DD format in: query name: parameters[date_to] schema: type: string format: date - description: Importance in: query name: parameters[importance] schema: type: string enum: - "0" - "1" - "2" - "3" - "4" - "5" - description: Is Primary in: query name: parameters[is_primary] schema: type: string enum: - 'Y' - 'N' - 'All' - description: Tickers in: query name: parameters[tickers] schema: type: string - description: Updated time in Unix format in: query name: parameters[updated] schema: type: string format: int64 responses: "200": description: Guidance content: application/json: schema: $ref: "#/components/schemas/models.GuidanceJSON" text/xml: schema: $ref: "#/components/schemas/models.GuidanceJSON" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/api.ErrorResponse" text/xml: schema: $ref: "#/components/schemas/api.ErrorResponse" "500": description: Internal Server Error content: application/json: schema: $ref: "#/components/schemas/api.ErrorResponse" text/xml: schema: $ref: "#/components/schemas/api.ErrorResponse" security: - ApiKeyAuth: [] summary: Get Guidance tags: - guidance /calendar/ma: get: description: Returns merger and acquisition data operationId: get-ma parameters: - description: Page number in: query name: page schema: type: integer - description: Page size in: query name: pagesize schema: type: integer - description: Date in YYYY-MM-DD format in: query name: parameters[date] schema: type: string format: date - description: Start date in YYYY-MM-DD format in: query name: parameters[date_from] schema: type: string format: date - description: End date in YYYY-MM-DD format in: query name: parameters[date_to] schema: type: string format: date - description: Importance in: query name: parameters[importance] schema: type: integer enum: - 0 - 1 - 2 - 3 - 4 - 5 - description: Tickers in: query name: parameters[tickers] schema: type: string - description: Updated time in Unix format in: query name: parameters[updated] schema: type: string format: int64 - description: Sort by date in: query name: parameters[date_sort] schema: type: string enum: - expected - completed - announced responses: "200": description: MA content: application/json: schema: $ref: "#/components/schemas/models.AcquisitionJSON" text/xml: schema: $ref: "#/components/schemas/models.AcquisitionJSON" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/api.ErrorResponse" text/xml: schema: $ref: "#/components/schemas/api.ErrorResponse" "500": description: Internal Server Error content: application/json: schema: $ref: "#/components/schemas/api.ErrorResponse" text/xml: schema: $ref: "#/components/schemas/api.ErrorResponse" security: - ApiKeyAuth: [] summary: Get Merger and Acquisition tags: - ma /calendar/offerings: get: description: Returns Secondary Offering data operationId: get-offerings parameters: - description: Page number in: query name: page schema: type: integer - description: Page size in: query name: pagesize schema: type: integer - description: Date in YYYY-MM-DD format in: query name: parameters[date] schema: type: string format: date - description: Start date in YYYY-MM-DD format in: query name: parameters[date_from] schema: type: string format: date - description: End date in YYYY-MM-DD format in: query name: parameters[date_to] schema: type: string format: date - description: Importance in: query name: parameters[importance] schema: type: integer enum: - 0 - 1 - 2 - 3 - 4 - 5 - description: Tickers in: query name: parameters[tickers] schema: type: string - description: Updated time in Unix format in: query name: parameters[updated] schema: type: string format: int64 responses: "200": description: Offerings content: application/json: schema: $ref: "#/components/schemas/models.OfferingJSON" text/xml: schema: $ref: "#/components/schemas/models.OfferingJSON" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/api.ErrorResponse" text/xml: schema: $ref: "#/components/schemas/api.ErrorResponse" "500": description: Internal Server Error content: application/json: schema: $ref: "#/components/schemas/api.ErrorResponse" text/xml: schema: $ref: "#/components/schemas/api.ErrorResponse" security: - ApiKeyAuth: [] summary: Get Offerings tags: - offerings /calendar/ratings: get: description: Returns analyst ratings data operationId: get-ratings parameters: - description: Fields in: query name: fields schema: type: string - description: Page number in: query name: page schema: type: integer - description: Page size in: query name: pagesize schema: type: integer - description: Date in YYYY-MM-DD format in: query name: parameters[date] schema: type: string format: date - description: Start date in YYYY-MM-DD format in: query name: parameters[date_from] schema: type: string format: date - description: End date in YYYY-MM-DD format in: query name: parameters[date_to] schema: type: string format: date - description: Importance in: query name: parameters[importance] schema: type: integer enum: - 0 - 1 - 2 - 3 - 4 - 5 - description: Tickers in: query name: parameters[tickers] schema: type: string - description: Updated time in Unix format in: query name: parameters[updated] schema: type: string format: int64 - description: Analyst IDs in: query name: parameters[analyst_id] schema: type: string - description: Firm IDs in: query name: parameters[firm_id] schema: type: string - description: Action in: query name: parameters[action] schema: type: string enum: - 'Downgrades' - 'Upgrades' - 'Maintains' - 'Reinstates' - 'Reiterates' - 'Assumes' - 'Initiates Coverage On' - 'Terminates Coverage On' - 'Removes' - 'Suspends' - 'Firm Dissolved' - description: Firm in: query name: firm schema: type: string - description: Analyst in: query name: analyst schema: type: string responses: "200": description: Ratings content: application/json: schema: $ref: "#/components/schemas/models.RatingJSON" text/xml: schema: $ref: "#/components/schemas/models.RatingJSON" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/api.ErrorResponse" text/xml: schema: $ref: "#/components/schemas/api.ErrorResponse" "500": description: Internal Server Error content: application/json: schema: $ref: "#/components/schemas/api.ErrorResponse" text/xml: schema: $ref: "#/components/schemas/api.ErrorResponse" security: - ApiKeyAuth: [] summary: Get Ratings tags: - ratings /calendar/ratings/analysts: get: description: Returns the full list of analyst that are providing ratings operationId: get-ratings-analysts parameters: - description: Page number in: query name: page schema: type: integer - description: Page size in: query name: pageSize schema: type: integer - description: Fields in: query name: fields schema: type: string - description: Analyst in: query name: analyst schema: type: string - description: Analyst name in: query name: analyst_name schema: type: string - description: Firm in: query name: firm schema: type: string - description: Firm name in: query name: firm_name schema: type: string - description: Updated time in Unix format in: query name: updated schema: type: integer format: int64 responses: "200": description: Ratings Analysts content: application/json: schema: $ref: "#/components/schemas/models.RatingsAnalystJSON" text/xml: schema: $ref: "#/components/schemas/models.RatingsAnalystJSON" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/api.ErrorResponse" text/xml: schema: $ref: "#/components/schemas/api.ErrorResponse" "500": description: Internal Server Error content: application/json: schema: $ref: "#/components/schemas/api.ErrorResponse" text/xml: schema: $ref: "#/components/schemas/api.ErrorResponse" security: - ApiKeyAuth: [] summary: Get Ratings Analysts tags: - ratings_analysts /calendar/ratings/firms: get: description: Returns the available firms providing analyst ratings operationId: get-ratings-firms parameters: - description: Page number in: query name: page schema: type: integer - description: Page size in: query name: pageSize schema: type: integer - description: Fields in: query name: fields schema: type: string - description: Firm in: query name: firm schema: type: string - description: Updated time in Unix format in: query name: updated schema: type: integer format: int64 responses: "200": description: Ratings Firms content: application/json: schema: $ref: "#/components/schemas/models.RatingsFirmJSON" text/xml: schema: $ref: "#/components/schemas/models.RatingsFirmJSON" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/api.ErrorResponse" text/xml: schema: $ref: "#/components/schemas/api.ErrorResponse" "500": description: Internal Server Error content: application/json: schema: $ref: "#/components/schemas/api.ErrorResponse" text/xml: schema: $ref: "#/components/schemas/api.ErrorResponse" security: - ApiKeyAuth: [] summary: Get Ratings Firms tags: - ratings_firms /calendar/splits: get: description: Returns splits calendar data operationId: get-splits parameters: - description: Page number in: query name: page schema: type: integer - description: Page size in: query name: pagesize schema: type: integer - description: Date in YYYY-MM-DD format in: query name: parameters[date] schema: type: string format: date - description: Start date in YYYY-MM-DD format in: query name: parameters[date_from] schema: type: string format: date - description: End date in YYYY-MM-DD format in: query name: parameters[date_to] schema: type: string format: date - description: Date search field in: query name: parameters[date_search_field] schema: type: string enum: - announced - target - description: Importance in: query name: parameters[importance] schema: type: integer enum: - 0 - 1 - 2 - 3 - 4 - 5 - description: Tickers in: query name: parameters[tickers] schema: type: string - description: Updated time in Unix format in: query name: parameters[updated] schema: type: string format: int64 responses: "200": description: Splits content: application/json: schema: $ref: "#/components/schemas/models.SplitJSON" text/xml: schema: $ref: "#/components/schemas/models.SplitJSON" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/api.ErrorResponse" text/xml: schema: $ref: "#/components/schemas/api.ErrorResponse" "500": description: Internal Server Error content: application/json: schema: $ref: "#/components/schemas/api.ErrorResponse" text/xml: schema: $ref: "#/components/schemas/api.ErrorResponse" security: - ApiKeyAuth: [] summary: Get Splits tags: - splits /consensus_ratings: get: description: Get Consensus Ratings for a given symbol operationId: get-consensus-ratings-v1 parameters: - description: Page number in: query name: page schema: type: integer - description: Page size in: query name: pagesize schema: type: integer - description: Start date in YYYY-MM-DD format in: query name: parameters[date_from] schema: type: string format: date - description: End date in YYYY-MM-DD format in: query name: parameters[date_to] schema: type: string format: date - description: Tickers in: query name: parameters[tickers] schema: type: string - description: Simplify the ratings to Buy, Hold, Sell in: query name: simplify schema: type: string - description: Aggregate type in: query name: aggregate_type schema: type: string enum: - number - percentage responses: "200": description: OK content: application/json: schema: $ref: "#/components/schemas/api.ConsensusRating" "400": description: Bad Request content: application/json: schema: type: string "500": description: Internal Error content: application/json: schema: type: string security: - ApiKeyAuth: [] summary: Get Consensus Ratings tags: - consensus_ratings /government_trade_reports: get: description: Get Government Trade Reports operationId: get-government-trade-reports parameters: - description: Page number in: query name: page schema: type: integer - description: Page size in: query name: pageSize schema: type: integer - description: Date from in: query name: date_from schema: type: integer format: int64 - description: Date to in: query name: date_to schema: type: integer format: int64 - description: Updated since in: query name: updated_since schema: type: integer format: int64 - description: Date in: query name: date schema: type: integer format: int64 - description: Chamber in: query name: chamber schema: type: string enum: - 'House' - 'Senate' - description: Fields in: query name: fields schema: type: string - description: Search keys type in: query name: search_keys_type schema: type: string enum: - 'report_id' - 'ticker' - description: Search keys in: query name: search_keys schema: type: string responses: "200": description: Government Trade Reports content: application/json: schema: $ref: "#/components/schemas/models.GovernmentTradeJSON" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/api.ErrorResponse" "500": description: Internal Server Error content: application/json: schema: $ref: "#/components/schemas/api.ErrorResponse" security: - ApiKeyAuth: [] summary: Get Government Trade Reports tags: - Government Trade Reports /government_trades: get: description: Get Government Trades operationId: get-government-trades parameters: - description: Page number in: query name: page schema: type: integer - description: Page size in: query name: pageSize schema: type: integer - description: Date from in: query name: date_from schema: type: integer format: int64 - description: Date to in: query name: date_to schema: type: integer format: int64 - description: Updated since in: query name: updated_since schema: type: integer format: int64 - description: Date in: query name: date schema: type: integer format: int64 - description: Chamber in: query name: chamber schema: type: string enum: - 'House' - 'Senate' - description: Fields in: query name: fields schema: type: string - description: Search keys type in: query name: search_keys_type schema: type: string enum: - 'report_id' - 'ticker' - description: Search keys in: query name: search_keys schema: type: string responses: "200": description: Government Trades content: application/json: schema: $ref: "#/components/schemas/models.GovernmentTradeJSON" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/api.ErrorResponse" "500": description: Internal Server Error content: application/json: schema: $ref: "#/components/schemas/api.ErrorResponse" security: - ApiKeyAuth: [] summary: Get Government Trades tags: - Government Trades "/sec/insider_transactions/{type}": get: description: Get Insider Transaction operationId: get-insider-transaction parameters: - description: Transaction Type in: path name: type required: true schema: type: string enum: - 'transactions' - 'filings' - description: Page number in: query name: page schema: type: integer - description: Page size in: query name: pageSize schema: type: integer - description: Date from in: query name: date_from schema: type: integer format: int64 - description: Date to in: query name: date_to schema: type: integer format: int64 - description: Updated since in: query name: updated_since schema: type: integer format: int64 - description: Date in: query name: date schema: type: integer format: int64 - description: Chamber in: query name: chamber schema: type: string enum: - 'House' - 'Senate' - description: Fields in: query name: fields schema: type: string - description: Search keys type in: query name: search_keys_type schema: type: string enum: - 'report_id' - 'ticker' - description: Search keys in: query name: search_keys schema: type: string - description: Updated time in Unix format in: query name: updated schema: type: integer format: int64 - description: Display in: query name: display schema: type: string enum: - 'flat' - 'nested' responses: "200": description: Insider Transaction content: application/json: schema: $ref: "#/components/schemas/models.InsiderTransactionFilingJSON" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/api.ErrorResponse" "500": description: Internal Server Error content: application/json: schema: $ref: "#/components/schemas/api.ErrorResponse" security: - ApiKeyAuth: [] summary: Get Insider Transaction tags: - Insider Transaction /sec/insider_transactions/owners: get: description: Get Insider Transaction Owner operationId: get-insider-transaction-owner parameters: - description: Page number in: query name: page schema: type: integer - description: Page size in: query name: pageSize schema: type: integer - description: Date from in: query name: date_from schema: type: integer format: int64 - description: Date to in: query name: date_to schema: type: integer format: int64 - description: Updated since in: query name: updated_since schema: type: integer format: int64 - description: Date in: query name: date schema: type: integer format: int64 - description: Chamber in: query name: chamber schema: type: string enum: - 'House' - 'Senate' - description: Fields in: query name: fields schema: type: string - description: Search keys type in: query name: search_keys_type schema: type: string enum: - 'report_id' - 'ticker' - description: Search keys in: query name: search_keys schema: type: string - description: Updated time in Unix format in: query name: updated schema: type: integer format: int64 - description: Display in: query name: display schema: type: string enum: - 'flat' - 'nested' responses: "200": description: Insider Transaction Owner content: application/json: schema: $ref: "#/components/schemas/models.InsiderTransactionFilingJSON" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/api.ErrorResponse" "500": description: Internal Server Error content: application/json: schema: $ref: "#/components/schemas/api.ErrorResponse" security: - ApiKeyAuth: [] summary: Get Insider Transaction Owner tags: - Insider Transaction /signal/option_activity: get: description: Get OptionActivity V1 operationId: get-option-activity-v1 parameters: - description: Page number in: query name: page schema: type: integer - description: Page size in: query name: pagesize schema: type: integer - description: Date in YYYY-MM-DD format in: query name: parameters[date] schema: type: string format: date - description: Start date in YYYY-MM-DD format in: query name: parameters[date_from] schema: type: string format: date - description: End date in YYYY-MM-DD format in: query name: parameters[date_to] schema: type: string format: date - description: Sort by date in: query name: parameters[date_sort] schema: type: string enum: - date - description: Tickers in: query name: parameters[tickers] schema: type: string - description: ID in: query name: parameters[id] schema: type: string - description: Updated time in Unix format in: query name: parameters[updated] schema: type: string format: int64 responses: "200": description: Option Activity content: application/json: schema: $ref: "#/components/schemas/models.OptionActivityJSON" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/api.ErrorResponse" "500": description: Internal Server Error content: application/json: schema: $ref: "#/components/schemas/api.ErrorResponse" security: - ApiKeyAuth: [] summary: Get OptionActivity V1 tags: - Option Activity /api/v1/quoteDelayed: get: description: Get delayed quotes for a list of symbols, ISINs, or CIKs operationId: get-quote-delayed-v1 parameters: - description: Comma separated list of symbols in: query name: symbols schema: type: string - description: ISIN of the security in: query name: isin schema: type: string - description: CIK of the security in: query name: cik schema: type: string responses: "200": description: Returns a JSON object with delayed quotes content: application/json: schema: type: string "400": description: Bad Request content: application/json: schema: type: string "500": description: Internal Server Error content: application/json: schema: type: string security: - ApiKeyAuth: [] summary: Get delayed quotes V1 tags: - QuoteDelayed /api/v2.1/fundamentals: get: description: Get Fundamentals V2.1 operationId: get-fundamentals-v21 parameters: - description: Comma separated list of symbols in: query name: symbols required: true schema: type: string - description: As of date in: query name: asOf schema: type: string - description: Period in: query name: period schema: type: string - description: Report Type in: query name: reportType schema: type: string responses: "200": description: OK content: application/json: schema: type: string "400": description: Bad Request content: application/json: schema: type: string "500": description: Internal Server Error content: application/json: schema: type: string security: - ApiKeyAuth: [] summary: Get Fundamentals V2.1 tags: - Fundamentals /api/v2.1/fundamentals/alphaBeta: get: description: Get Alpha Beta operationId: get-alpha-beta-v21 parameters: - description: Comma separated list of symbols in: query name: symbols required: true schema: type: string - description: As of date in: query name: asOf schema: type: string - description: Period in: query name: period schema: type: string - description: Report Type in: query name: reportType schema: type: string responses: "200": description: OK content: application/json: schema: type: string "400": description: Bad Request content: application/json: schema: type: string "500": description: Internal Server Error content: application/json: schema: type: string security: - ApiKeyAuth: [] summary: Get Alpha Beta V2.1 tags: - Fundamentals /api/v2.1/fundamentals/company: get: description: Get Company Data operationId: get-company-v21 parameters: - description: Comma separated list of symbols in: query name: symbols required: true schema: type: string - description: As of date in: query name: asOf schema: type: string - description: Period in: query name: period schema: type: string - description: Report Type in: query name: reportType schema: type: string responses: "200": description: OK content: application/json: schema: type: string "400": description: Bad Request content: application/json: schema: type: string "500": description: Internal Server Error content: application/json: schema: type: string security: - ApiKeyAuth: [] summary: Get Company Data v2.1 tags: - Fundamentals /api/v2.1/fundamentals/companyProfile: get: description: Get Company Profile operationId: get-company-profile-v21 parameters: - description: Comma separated list of symbols in: query name: symbols required: true schema: type: string - description: As of date in: query name: asOf schema: type: string - description: Period in: query name: period schema: type: string - description: Report Type in: query name: reportType schema: type: string responses: "200": description: OK content: application/json: schema: type: string "400": description: Bad Request content: application/json: schema: type: string "500": description: Internal Server Error content: application/json: schema: type: string security: - ApiKeyAuth: [] summary: Get Company Profile v2.1 tags: - Fundamentals /api/v2.1/fundamentals/shareClass: get: description: Get Share Class operationId: get-share-class-v21 parameters: - description: Comma separated list of symbols in: query name: symbols required: true schema: type: string - description: As of date in: query name: asOf schema: type: string - description: Period in: query name: period schema: type: string - description: Report Type in: query name: reportType schema: type: string responses: "200": description: OK content: application/json: schema: type: string "400": description: Bad Request content: application/json: schema: type: string "500": description: Internal Server Error content: application/json: schema: type: string security: - ApiKeyAuth: [] summary: Get Share Class V2.1 tags: - Fundamentals /api/v2.1/fundamentals/shareClassProfile: get: description: Get Share Class Profile operationId: get-share-class-profile-v21 parameters: - description: Comma separated list of symbols in: query name: symbols required: true schema: type: string - description: As of date in: query name: asOf schema: type: string - description: Period in: query name: period schema: type: string - description: Report Type in: query name: reportType schema: type: string responses: "200": description: OK content: application/json: schema: type: string "400": description: Bad Request content: application/json: schema: type: string "500": description: Internal Server Error content: application/json: schema: type: string security: - ApiKeyAuth: [] summary: Get Share Class Profile V2.1 tags: - Fundamentals /api/v2/bars: get: description: Get Bars V2 operationId: get-bars-v2 parameters: - description: Symbols in: query name: symbols required: true schema: type: string - description: From in: query name: from required: true schema: type: string - description: To in: query name: to schema: type: string - description: Interval in: query name: interval schema: type: string responses: "200": description: OK content: application/json: schema: items: type: object type: array "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/bzhttp.Resp" "500": description: Internal Server Error content: application/json: schema: $ref: "#/components/schemas/bzhttp.Resp" security: - ApiKeyAuth: [] summary: Get Bars V2 tags: - Bars /api/v2/fundamentals: get: description: Get Fundamentals V2 operationId: get-fundamentals-v2 parameters: - description: Comma separated list of symbols in: query name: symbols required: true schema: type: string - description: As of date in: query name: asOf schema: type: string - description: Period in: query name: period schema: type: string - description: Report Type in: query name: reportType schema: type: string responses: "200": description: OK content: application/json: schema: type: string "400": description: Bad Request content: application/json: schema: type: string "500": description: Internal Server Error content: application/json: schema: type: string summary: Get Fundamentals V2 tags: - Fundamentals /api/v2/fundamentals/assetClassification: get: description: Get Asset Classification operationId: get-asset-classification-v21 parameters: - description: Comma separated list of symbols in: query name: symbols required: true schema: type: string - description: As of date in: query name: asOf schema: type: string - description: Period in: query name: period schema: type: string - description: Report Type in: query name: reportType schema: type: string responses: "200": description: OK content: application/json: schema: type: string "400": description: Bad Request content: application/json: schema: type: string "500": description: Internal Server Error content: application/json: schema: type: string security: - ApiKeyAuth: [] summary: Get Asset Classification V2.1 tags: - Fundamentals /api/v2/fundamentals/earningRatios: get: description: Get earning ratios for a list of symbols, ISINs, or CIKs operationId: get-earning-ratios-v21 parameters: - description: Comma separated list of symbols in: query name: symbols schema: type: string - description: As of date in: query name: asOf schema: type: string - description: Period in: query name: period schema: type: string - description: Report Type in: query name: reportType schema: type: string responses: "200": description: Returns a JSON object with earning ratios content: application/json: schema: type: string "400": description: Bad Request content: application/json: schema: type: string "500": description: Internal Server Error content: application/json: schema: type: string security: - ApiKeyAuth: [] summary: Get earning ratios V2.1 tags: - EarningRatios /api/v2/fundamentals/earningsReports: get: description: Get Earnings Reports operationId: get-earnings-reports-v21 parameters: - description: Comma separated list of symbols in: query name: symbols required: true schema: type: string - description: As of date in: query name: asOf schema: type: string - description: Period in: query name: period schema: type: string - description: Report Type in: query name: reportType schema: type: string responses: "200": description: OK content: application/json: schema: type: string "400": description: Bad Request content: application/json: schema: type: string "500": description: Internal Server Error content: application/json: schema: type: string security: - ApiKeyAuth: [] summary: Get Earnings Reports V2.1 tags: - Fundamentals /api/v2/fundamentals/financials: get: description: Get Financials V2.1 operationId: get-financials-v21 parameters: - description: Comma separated list of symbols in: query name: symbols required: true schema: type: string - description: As of date in: query name: asOf schema: type: string - description: Period in: query name: period schema: type: string - description: Report Type in: query name: reportType schema: type: string responses: "200": description: OK content: application/json: schema: items: type: string type: array "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/bzhttp.Resp" "500": description: Internal Server Error content: application/json: schema: $ref: "#/components/schemas/bzhttp.Resp" security: - ApiKeyAuth: [] summary: Get Financials V2.1 tags: - Fundamentals /api/v2/fundamentals/operationRatios: get: description: Get operation ratios for a list of symbols operationId: get-operation-ratios-v21 parameters: - description: Comma separated list of symbols in: query name: symbols required: true schema: type: string - description: As of date in: query name: asOf schema: type: string - description: Period in: query name: period schema: type: string - description: Report Type in: query name: reportType schema: type: string responses: "200": description: Returns a JSON object with operation ratios content: application/json: schema: type: string "400": description: Bad Request content: application/json: schema: type: string "500": description: Internal Server Error content: application/json: schema: type: string security: - ApiKeyAuth: [] summary: Get operation ratios V2.1 tags: - OperationRatios /api/v2/fundamentals/valuationRatios: get: description: Get valuation ratios for a list of symbols, ISINs, or CIKs operationId: get-valuation-ratios-v21 parameters: - description: Comma separated list of symbols in: query name: symbols schema: type: string - description: As of date in: query name: asOf schema: type: string - description: Period in: query name: period schema: type: string - description: Report Type in: query name: reportType schema: type: string responses: "200": description: Returns a JSON object with valuation ratios content: application/json: schema: type: string "400": description: Bad Request content: application/json: schema: type: string "500": description: Internal Server Error content: application/json: schema: type: string security: - ApiKeyAuth: [] summary: Get valuation ratios V2.1 tags: - ValuationRatios /api/v2/quoteDelayed: get: description: Get delayed quotes for a list of symbols operationId: get-quote-delayed-v2 parameters: - description: Comma separated list of symbols in: query name: symbols schema: type: string - description: ISIN of the security in: query name: isin schema: type: string - description: CIK of the security in: query name: cik schema: type: string responses: "200": description: Returns a JSON object with delayed quotes content: application/json: schema: type: string "400": description: Bad Request content: application/json: schema: type: string "500": description: Internal Server Error content: application/json: schema: type: string security: - ApiKeyAuth: [] summary: Get delayed quotes V2 tags: - QuoteDelayed /api/v3/fundamentals: get: description: Get Fundamentals V3 operationId: get-fundamentals-v3 parameters: - description: Comma separated list of symbols in: query name: symbols required: true schema: type: string - description: From date in: query name: from schema: type: string - description: To date in: query name: to schema: type: string - description: Report Type in: query name: date schema: type: string responses: "200": description: OK content: application/json: schema: type: string "400": description: Bad Request content: application/json: schema: type: string "500": description: Internal Server Error content: application/json: schema: type: string security: - ApiKeyAuth: [] summary: Get Fundamentals V3 tags: - Fundamentals /api/v3/fundamentals/balance-sheet: get: description: Get Balance Sheet V3 operationId: get-balance-sheet-v3 parameters: - description: Symbols in: query name: symbols required: true schema: type: string - description: From in: query name: from schema: type: string - description: To in: query name: to schema: type: string - description: Report Type in: query name: date schema: type: string responses: "200": description: OK content: application/json: schema: items: type: string type: array "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/bzhttp.Resp" security: - ApiKeyAuth: [] summary: Get Balance Sheet V3 tags: - Fundamentals /api/v3/fundamentals/cash-flow: get: description: Get Cash Flow V3 operationId: get-cash-flow-v3 parameters: - description: Comma separated list of symbols in: query name: symbols required: true schema: type: string - description: From date in: query name: from schema: type: string - description: To date in: query name: to schema: type: string - description: Report Type in: query name: date schema: type: string responses: "200": description: OK content: application/json: schema: items: type: string type: array "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/bzhttp.Resp" "500": description: Internal Server Error content: application/json: schema: $ref: "#/components/schemas/bzhttp.Resp" summary: Get Cash Flow V3 tags: - Fundamentals /api/v3/fundamentals/derived: get: description: Get derived figures and ratios for a list of symbols operationId: get-derived-figures-and-ratios-v3 parameters: - description: Comma separated list of symbols in: query name: symbols required: true schema: type: string - description: From date in: query name: from schema: type: string - description: To date in: query name: to schema: type: string - description: Report Type in: query name: date schema: type: string responses: "200": description: Returns a JSON object with derived figures and ratios content: application/json: schema: type: string "400": description: Bad Request content: application/json: schema: type: string "500": description: Internal Server Error content: application/json: schema: type: string security: - ApiKeyAuth: [] summary: Get derived figures and ratios V3 tags: - DerivedFiguresAndRatios /api/v3/fundamentals/income-statement: get: description: Get Income Statement V3 operationId: get-income-statement-v3 parameters: - description: Comma separated list of symbols in: query name: symbols required: true schema: type: string - description: From date in: query name: from schema: type: string - description: To date in: query name: to schema: type: string - description: Report Type in: query name: date schema: type: string responses: "200": description: OK content: application/json: schema: type: string "400": description: Bad Request content: application/json: schema: type: string "500": description: Internal Server Error content: application/json: schema: type: string security: - ApiKeyAuth: [] summary: Get Income Statement V3 tags: - Fundamentals /api/v3/fundamentals/share-price-ratios: get: description: Get Share Price Ratios operationId: get-share-price-ratios-v3 parameters: - description: Comma separated list of symbols in: query name: symbols required: true schema: type: string - description: From date in: query name: from schema: type: string - description: To date in: query name: to schema: type: string - description: Report type in: query name: date schema: type: string responses: "200": description: OK content: application/json: schema: items: type: string type: array "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/bzhttp.Resp" "500": description: Internal Server Error content: application/json: schema: $ref: "#/components/schemas/bzhttp.Resp" security: - ApiKeyAuth: [] summary: Get Share Price Ratios V3 tags: - Fundamentals /api/v1/earnings-call-transcripts: get: description: Get Earnings Call Transcripts operationId: get-earnings-call-transcripts parameters: - description: Tickers in: query name: tickers style: form explode: false schema: type: array items: type: string - description: Call ID in: query name: call_id style: form explode: false schema: type: array items: type: string - description: Page in: query name: page schema: type: integer - description: Page Size in: query name: pagesize schema: type: integer responses: "200": description: OK content: application/json: schema: items: $ref: "#/components/schemas/models.TranscriptSummary" type: array "400": description: Bad Request content: application/json: schema: items: type: string type: array "500": description: Internal Server Error content: application/json: schema: items: type: string type: array security: - ApiKeyAuth: [] summary: Get Earnings Call Transcripts tags: - Earnings Call Transcripts /api/v1/earnings-call-transcripts/audio: get: description: Get Earnings Call Transcript Audio Files operationId: get-earnings-call-transcript-audio-files parameters: - description: Tickers in: query name: tickers style: form explode: false schema: type: array items: type: string - description: Call ID in: query name: call_id style: form explode: false schema: type: array items: type: string - description: Page in: query name: page schema: type: integer - description: Page Size in: query name: pagesize schema: type: integer responses: "200": description: OK content: application/json: schema: items: $ref: "#/components/schemas/models.TranscriptSummaryAudio" type: array "400": description: Bad Request content: application/json: schema: items: type: string type: array "500": description: Internal Server Error content: application/json: schema: items: type: string type: array security: - ApiKeyAuth: [] summary: Get Earnings Call Transcript Audio Files tags: - Earnings Call Transcripts /logos/bulk-sync: get: description: Get Logos for given search keys operationId: logo-bulk-sync parameters: - description: Search Keys in: query name: search_keys required: true schema: type: string - description: Search Keys Type in: query name: search_keys_type schema: type: string - description: Fields in: query name: fields required: true style: form explode: false schema: type: array items: type: string - description: Page in: query name: page schema: type: integer - description: Page Size in: query name: pagesize schema: type: integer - description: Updated At From in: query name: updated_since schema: type: string - description: Scale in: query name: scale schema: type: string - description: Composite Radius in: query name: composite_radius schema: type: integer responses: "200": description: OK content: application/json: schema: $ref: "#/components/schemas/bzhttp.Resp" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/bzhttp.Resp" "404": description: Not Found content: application/json: schema: $ref: "#/components/schemas/bzhttp.Resp" "500": description: Internal Server Error content: application/json: schema: $ref: "#/components/schemas/bzhttp.Resp" security: - ApiKeyAuth: [] summary: Get Logos for given search keys tags: - logos /logos/search: get: description: Get Logos for given search keys operationId: get-search-logos parameters: - description: Search Keys in: query name: search_keys required: true schema: type: string - description: Search Keys Type in: query name: search_keys_type schema: type: string - description: Fields in: query name: fields required: true schema: type: string - description: Composite Auto in: query name: composite_auto schema: type: boolean - description: Composite Radius in: query name: composite_radius schema: type: integer - description: Scale in: query name: scale schema: type: string - description: Max Width in: query name: max_width schema: type: string responses: "200": description: OK content: application/json: schema: items: $ref: "#/components/schemas/logoapi.LogoRevision" type: array "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/bzhttp.Resp" "404": description: Not Found content: application/json: schema: $ref: "#/components/schemas/bzhttp.Resp" "500": description: Internal Server Error content: application/json: schema: $ref: "#/components/schemas/bzhttp.Resp" security: - ApiKeyAuth: [] summary: Get Logos for given search keys tags: - logos /api/v2/news: get: description: Get News operationId: get-news parameters: - description: Tickers in: query name: tickers schema: type: string - description: CUSIPs in: query name: cusips schema: type: string - description: ISINs in: query name: isins schema: type: string - description: Channels in: query name: channels schema: type: string - description: Topics in: query name: topics schema: type: string - description: Authors in: query name: authors schema: type: string - description: Content Types in: query name: contentTypes schema: type: string - description: Sort in: query name: sort schema: type: string - description: Date in: query name: date schema: type: string format: date - description: Published Since in: query name: publishedSince schema: type: string - description: Updated Since in: query name: updatedSince schema: type: string - description: Date From in: query name: dateFrom schema: type: string - description: Date To in: query name: dateTo schema: type: string - description: Page Size in: query name: pageSize schema: type: integer - description: Page in: query name: page schema: type: integer - description: Last ID in: query name: lastID schema: type: string - description: Display Output in: query name: displayOutput schema: type: string - description: Noise in: query name: noise schema: type: string - description: Format in: query name: format schema: type: string responses: "200": description: OK content: application/json: schema: items: $ref: "#/components/schemas/api.NewsItem" type: array text/xml: schema: items: $ref: "#/components/schemas/api.NewsItem" type: array "400": description: Invalid or Missing Query Parameters content: application/json: schema: type: string text/xml: schema: type: string "499": description: Request Context Cancelled content: application/json: schema: type: string text/xml: schema: type: string "500": description: Internal Error content: application/json: schema: type: string text/xml: schema: type: string security: - ApiKeyAuth: [] summary: Get News tags: - News /api/v2/news/removed: get: description: Get Removed News operationId: get-removed-news parameters: - description: Updated Since in: query name: updatedSince schema: type: string - description: Page Size in: query name: pageSize schema: type: integer - description: Page in: query name: page schema: type: integer responses: "200": description: OK content: application/json: schema: items: $ref: "#/components/schemas/api.NewsRemovedItem" type: array text/xml: schema: items: $ref: "#/components/schemas/api.NewsRemovedItem" type: array "400": description: Invalid or Missing Query Parameters content: application/json: schema: type: string text/xml: schema: type: string "499": description: Request Context Cancelled content: application/json: schema: type: string text/xml: schema: type: string "500": description: Internal Error content: application/json: schema: type: string text/xml: schema: type: string security: - ApiKeyAuth: [] summary: Get Removed News tags: - News /api/v2/newsquantified: get: description: Get Newsquantified Data operationId: get-newsquantified-data parameters: - description: Page number in: query name: page schema: type: integer - description: Number of results per page in: query name: pagesize schema: type: integer - description: Updated since in: query name: updated_since schema: type: integer - description: Symbols in: query name: symbols schema: type: string - description: Date in: query name: date schema: type: string - description: Date From in: query name: date_from schema: type: string - description: Date To in: query name: date_to schema: type: string responses: "200": description: OK content: application/json: schema: items: $ref: "#/components/schemas/models.Newsquantified" type: array "400": description: Bad Request content: application/json: schema: items: items: type: object type: array type: array "404": description: Not Found content: application/json: schema: $ref: "#/components/schemas/bzhttp.Resp" "500": description: Internal Server Error content: application/json: schema: items: items: type: object type: array type: array security: - ApiKeyAuth: [] summary: Get Newsquantified Data /api/v1/trending-tickers: get: description: Get ticker trend data operationId: get-ticker-trend-data parameters: - description: Interval for the data in: query name: interval required: true schema: type: string - description: Comma separated list of tickers in: query name: tickers required: true schema: type: string - description: Source of the data in: query name: source required: true schema: type: string - description: Timeframe for the data in: query name: timeframe schema: type: string - description: Page number in: query name: page schema: type: integer - description: Page size in: query name: pagesize schema: type: integer responses: "200": description: OK content: application/json: schema: $ref: "#/components/schemas/httpapi.tickerTrendAPIResponse" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/bzhttp.Resp" "500": description: Internal Server Error content: application/json: schema: $ref: "#/components/schemas/httpapi.tickerTrendAPIResponse" security: - ApiKeyAuth: [] summary: Get ticker trend data tags: - ticker-trends /api/v1/trending-tickers/list: get: description: Get ticker trend list data operationId: get-ticker-trend-list-data parameters: - description: Interval for the data in: query name: interval required: true schema: type: string - description: Comma separated list of tickers in: query name: tickers required: true schema: type: string - description: Source of the data in: query name: source required: true schema: type: string - description: Timeframe for the data in: query name: timeframe schema: type: string - description: Page number in: query name: page schema: type: integer - description: Page size in: query name: pagesize schema: type: integer responses: "200": description: OK content: application/json: schema: $ref: "#/components/schemas/httpapi.trendingTickersListAPIResponse" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/bzhttp.Resp" "500": description: Internal Server Error content: application/json: schema: $ref: "#/components/schemas/httpapi.trendingTickersListAPIResponse" security: - ApiKeyAuth: [] summary: Get ticker trend list data tags: - ticker-trends components: securitySchemes: ApiKeyAuth: in: query name: token type: apiKey schemas: models.AnalystReportRawText: title: AnalystReportRawText properties: date: type: string exchange: type: string extracted_paragraphs: items: type: string type: array firm_id: type: string id: type: string ticker: type: string type: object api.AggregateRating: title: AggregateRating properties: buy: type: integer hold: type: integer sell: type: integer strong_buy: type: integer strong_sell: type: integer type: object api.ConsensusRating: title: ConsensusRating properties: aggregate_ratings: $ref: "#/components/schemas/api.AggregateRating" aggregate_type: type: string consensus_price_target: type: number consensus_rating: type: string consensus_rating_val: type: number high_price_target: type: number low_price_target: type: number total_analyst_count: type: integer unique_analyst_count: type: integer updated_at: type: string type: object api.ErrorResponse: title: ErrorResponse properties: text: type: string type: object models.AcquisitionJSON: title: AcquisitionJSON properties: ma: items: additionalProperties: true type: object type: array type: object models.AnalystInsightsJSON: title: AnalystInsightsJSON properties: analystInsights: items: additionalProperties: true type: object type: array type: object models.BullsSayBearsSayJSON: title: BullsSayBearsSayJSON properties: bullsSayBearsSay: items: additionalProperties: true type: object type: array type: object models.ConferenceJSON: title: ConferenceJSON properties: conference: items: additionalProperties: true type: object type: array type: object models.DividendJSON: title: DividendJSON properties: dividends: items: additionalProperties: true type: object type: array type: object models.EarningJSON: title: EarningJSON properties: earnings: items: additionalProperties: true type: object type: array type: object models.EconomicJSON: title: EconomicJSON properties: economics: items: additionalProperties: true type: object type: array type: object models.EventsJSON: title: EventsJSON properties: events: items: additionalProperties: true type: object type: array type: object models.FDAJSON: title: FDAJSON properties: fda: items: additionalProperties: true type: object type: array type: object models.GovernmentTradeJSON: title: GovernmentTradeJSON properties: data: items: additionalProperties: true type: object type: array type: object models.GuidanceJSON: title: GuidanceJSON properties: guidance: items: additionalProperties: true type: object type: array type: object models.IPOJSON: title: IPOJSON properties: ipos: items: additionalProperties: true type: object type: array type: object models.InsiderTransactionFilingJSON: title: InsiderTransactionFilingJSON properties: data: items: additionalProperties: true type: object type: array type: object models.OfferingJSON: title: OfferingJSON properties: offerings: items: additionalProperties: true type: object type: array type: object models.OptionActivityJSON: title: OptionActivityJSON properties: optionActivity: items: additionalProperties: true type: object type: array type: object models.RatingJSON: title: RatingJSON properties: ratings: items: additionalProperties: true type: object type: array type: object models.RatingsAnalystJSON: title: RatingsAnalystJSON properties: analystRatingsAnalyst: items: additionalProperties: true type: object type: array type: object models.RatingsFirmJSON: title: RatingsFirmJSON properties: analystRatingsFirm: items: additionalProperties: true type: object type: array type: object models.Rmvd: title: Rmvd properties: id: type: string type: type: string updated: type: integer type: object models.RmvdJSON: title: RmvdJSON properties: removed: items: $ref: "#/components/schemas/models.Rmvd" type: array type: object models.SplitJSON: title: SplitJSON properties: splits: items: additionalProperties: true type: object type: array type: object bzhttp.Error: title: Error properties: code: $ref: "#/components/schemas/bzhttp.ErrorCode" id: type: string value: type: string type: object bzhttp.ErrorCode: title: ErrorCode enum: - unsupported_message_type - database_query_error - json_unmarshaling_error - no_data_found - no_matching_endpoint - bad_request - db_error - internal_server_error - auth_failed - forbidden - failed_dependency - service_unavailable - upstream_api_error type: string x-enum-varnames: - ErrorUnsupportedMessageType - ErrorDBQueryError - ErrorJSONUnmarshaling - ErrorNoDataFound - ErrorNoMatchingEndpoint - ErrorBadRequest - ErrorDBError - ErrorInternalServerError - ErrorAuthFailed - ErrorForbidden - ErrorFailedDependency - ErrorServiceUnavailable - ErrorUpstreamAPIError bzhttp.Resp: title: Resp properties: data: additionalProperties: true type: object errors: items: $ref: "#/components/schemas/bzhttp.Error" type: array ok: type: boolean type: object models.Security: title: Security properties: cik: type: string company_name: type: string exchange: type: string isin: type: string ticker: type: string type: object models.Summary: title: Summary properties: summary: type: string time: type: number type: object models.TranscriptAudioFile: title: TranscriptAudioFile properties: file_url: type: string type: object models.TranscriptSummary: title: TranscriptSummary properties: call_id: type: string created: type: integer date: type: string id: type: string reviewed: type: boolean security: $ref: "#/components/schemas/models.Security" start_time: type: string summaries: items: $ref: "#/components/schemas/models.Summary" type: array summary_full: type: string title: type: string transcript_full: type: string transcript_timestamped: items: $ref: "#/components/schemas/models.TranscriptTimestamp" type: array updated: type: integer user_id: type: integer type: object models.TranscriptSummaryAudio: title: TranscriptSummaryAudio properties: audio_file: $ref: "#/components/schemas/models.TranscriptAudioFile" call_id: type: string created: type: integer date: type: string id: type: string security: $ref: "#/components/schemas/models.Security" start_time: type: string updated: type: integer type: object models.TranscriptTimestamp: title: TranscriptTimestamp properties: time: type: number transcript: type: string type: object logoapi.LogoColors: title: LogoColors properties: background_dark: type: string background_light: type: string type: object logoapi.LogoRevision: title: LogoRevision properties: colors: $ref: "#/components/schemas/logoapi.LogoColors" company_cik: type: string company_url: type: string created_at: type: string deleted_at: type: string files: $ref: "#/components/schemas/logoapi.LogoRevisionFiles" id: type: string isin: type: string last_audited: type: string mic_code: type: string symbol: type: string type: type: string updated_at: type: string updated_by_user_id: type: string type: object logoapi.LogoRevisionFiles: title: LogoRevisionFiles properties: logo_dark: type: string logo_light: type: string logo_vector_dark: type: string logo_vector_light: type: string mark_composite_dark: type: string mark_composite_light: type: string mark_dark: type: string mark_light: type: string mark_vector_composite_dark: type: string mark_vector_composite_light: type: string mark_vector_dark: type: string mark_vector_light: type: string type: object api.ChannelTag: title: ChannelTag properties: name: type: string type: object api.Image: title: Image properties: size: type: string url: type: string type: object api.NewsItem: title: NewsItem properties: author: type: string body: type: string channels: items: $ref: "#/components/schemas/api.ChannelTag" type: array created: type: string id: type: integer image: items: $ref: "#/components/schemas/api.Image" type: array original_id: type: integer stocks: items: $ref: "#/components/schemas/api.Stock" type: array tags: items: $ref: "#/components/schemas/api.ChannelTag" type: array teaser: type: string title: type: string updated: type: string url: type: string type: object api.NewsRemovedItem: title: NewsRemovedItem properties: id: type: integer updated: type: string type: object api.Stock: title: Stock properties: cusip: type: string isin: type: string name: type: string type: object models.Newsquantified: title: Newsquantified properties: _id: type: string 1_Minute%: type: string 5_Minutes%: type: string 10_Minutes%: type: string 30_Minutes%: type: string 30_Seconds%: type: string 60_Minutes%: type: string 90_Minutes%: type: string 120_Minutes%: type: string ATR_Ratio: type: string ATR14: type: string AllTicks: type: string AllVWAP: type: string AnalystAction: type: string AnalystActionFrom: type: string AnalystActionTo: type: string AnalystFirm: type: string Close_Vol: type: string Comments: type: string Curr_Vol: type: string Date: type: string DayOpen: type: string DividendYield%: type: string EODClose: type: string EODHigh: type: string EODLow: type: string EODVWAP: type: string EPSAction: type: string EPSActual: type: string Ex: type: string Headlines: type: string HighExcStdDev: type: string L1: type: string L2: type: string L3: type: string L4: type: string L5: type: string L10: type: string L20: type: string L75: type: string LS: type: string LowExcStdDev: type: string MainVWAP: type: string MaxDnAmt: type: string MaxUpAmt: type: string MktCap(1000): type: string Mov_Vol: type: string NewsSess: type: string Open_Vol: type: string OpenGap%: type: string P1: type: string P2: type: string P3: type: string P4: type: string P5: type: string P10: type: string P20: type: string P75: type: string PERatio: type: string PID: type: string PUBt: type: string PostVWAP: type: string PreVWAP: type: string Prev_Vol: type: string PrevClose: type: string Provider: type: string RECt: type: string Range%: type: string RangeAmt: type: string RangeStdDev: type: string ReportSess: type: string ResourceID: type: string Result%: type: string Result_Vs_Index%: type: string S1: type: string S2: type: string S3: type: string S4: type: string S5: type: string S10: type: string S20: type: string S75: type: string SPYLast: type: string SPYclose: type: string ShortInterest%: type: string Symb: type: string TONHigh: type: string TONLast: type: string TONLow: type: string Topics: type: string Vol_Ratio: type: string VolumeStdDev: type: string created: type: integer maxDown%: type: string maxUp%: type: string prevDay%: type: string type: object httpapi.security: title: security properties: exchange: type: string name: type: string ticker: type: string type: object httpapi.tickerTrendAPIResponse: title: tickerTrendAPIResponse properties: data: items: $ref: "#/components/schemas/httpapi.tickerTrendData" type: array ok: type: boolean type: object httpapi.tickerTrendData: title: tickerTrendData properties: exchange: type: string metrics: items: $ref: "#/components/schemas/httpapi.tickerTrendMetrics" type: array ticker: type: string type: object httpapi.tickerTrendMetrics: title: tickerTrendMetrics properties: count: type: integer count_mavg: type: number market_count_average: type: number scaled_count: type: number scaled_count_mavg: type: number time_bucket: type: string type: object httpapi.trendingTickersListAPIResponse: title: trendingTickersListAPIResponse properties: data: items: $ref: "#/components/schemas/httpapi.trendingTickersListData" type: array ok: type: boolean type: object httpapi.trendingTickersListData: title: trendingTickersListData properties: count: type: integer pct_chg: type: integer security: $ref: "#/components/schemas/httpapi.security" type: object servers: - url: https://api.benzinga.com description: Default - url: https://api.benzinga.com/api/v1 description: V1 - url: https://api.benzinga.com/api/v2 description: V2 - url: https://api.benzinga.com/api/v2.1 description: V2.1 - url: https://api.benzinga.com/api/v2.2 description: V2.2 x-speakeasy-retries: strategy: backoff backoff: initialInterval: 500 # 500 milliseconds maxInterval: 60000 # 60 seconds maxElapsedTime: 3600000 # 5 minutes exponent: 1.5 statusCodes: - 5XX retryConnectionErrors: true