bull-bear.yml

openapi: 3.0.1
info:
  title: Bulls Say / Bears Say API
  version: '1.0'
servers:
  - url: https://api.benzinga.com/api/v1
paths:
  /bulls_bears_say:
    get:
      summary: Get the latest bull and bear cases for a given ticker symbol.
      operationId: getBullsBearsSay
      parameters:
        - name: symbols
          in: query
          required: true
          description: Stock ticker symbol to query for bull/bear cases.
          schema:
            type: string
        - name: token
          in: query
          required: true
          description: Authentication token for the API access.
          schema:
            type: string
      responses:
        '200':
          description: An array of bull and bear cases for the requested ticker symbol.
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/BullBearCase'
        '401':
          description: Authentication information is missing or invalid.
        '404':
          description: A bull/bear case for the provided ticker symbol was not found.
components:
  schemas:
    BullBearCase:
      type: object
      properties:
        bear_case:
          type: string
          description: Description of the bear case scenario.
        bull_case:
          type: string
          description: Description of the bull case scenario.
        id:
          type: string
          format: uuid
          description: Unique identifier for the bull/bear case.
        ticker:
          type: string
          description: Stock ticker symbol related to the bull/bear case.
        updated:
          type: integer
          format: int64
          description: Timestamp of when the case was last updated.
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: query
      name: token
security:
  - ApiKeyAuth: []