openapi: 3.0.3
servers:
  - url: https://prod.api.market/api/v1/polygon.io/polygon
info:
  description: At Polygon.io, we're on a mission to modernize the financial
    industry. We believe that the industry runs on old technology, and we're
    here to change that
  title: Polygon.io Stock Market API
  version: 1.0.1
paths:
  /v1/indicators/ema/{cryptoTicker}:
    get:
      description: Get the exponential moving average (EMA) for a ticker symbol over a
        given time range.
      operationId: CryptoEMA
      parameters:
        - description: The ticker symbol for which to get exponential moving average (EMA)
            data.
          example: X:BTCUSD
          in: path
          name: cryptoTicker
          required: true
          schema:
            type: string
          x-polygon-go-id: Ticker
        - description: Query by timestamp. Either a date with the format YYYY-MM-DD or a
            millisecond timestamp.
          in: query
          name: timestamp
          schema:
            type: string
          x-polygon-filter-field:
            range: true
        - description: The size of the aggregate time window.
          example: day
          in: query
          name: timespan
          schema:
            default: day
            enum:
              - minute
              - hour
              - day
              - week
              - month
              - quarter
              - year
            type: string
        - description: The window size used to calculate the exponential moving average
            (EMA). i.e. a window size of 10 with daily aggregates would result
            in a 10 day moving average.
          example: 50
          in: query
          name: window
          schema:
            default: 50
            type: integer
        - description: >-
            The price in the aggregate which will be used to calculate the
            exponential moving average. i.e. 'close' will result in using close
            prices to 

            calculate the exponential moving average (EMA).
          example: close
          in: query
          name: series_type
          schema:
            default: close
            enum:
              - open
              - high
              - low
              - close
            type: string
        - description: Whether or not to include the aggregates used to calculate this
            indicator in the response.
          in: query
          name: expand_underlying
          schema:
            default: false
            type: boolean
        - description: The order in which to return the results, ordered by timestamp.
          example: desc
          in: query
          name: order
          schema:
            default: desc
            enum:
              - asc
              - desc
            type: string
        - description: Limit the number of results returned, default is 10 and max is 5000
          in: query
          name: limit
          schema:
            default: 10
            maximum: 5000
            type: integer
        - description: Range by timestamp.
          in: query
          name: timestamp.gte
          schema:
            type: string
        - description: Range by timestamp.
          in: query
          name: timestamp.gt
          schema:
            type: string
        - description: Range by timestamp.
          in: query
          name: timestamp.lte
          schema:
            type: string
        - description: Range by timestamp.
          in: query
          name: timestamp.lt
          schema:
            type: string
      responses:
        "200":
          content:
            application/json:
              example:
                next_url: https://api.polygon.io/v1/indicators/ema/X:BTCUSD?cursor=YWN0aXZlPXRydWUmZGF0ZT0yMDIxLTA0LTI1JmxpbWl0PTEmb3JkZXI9YXNjJnBhZ2VfbWFya2VyPUElN0M5YWRjMjY0ZTgyM2E1ZjBiOGUyNDc5YmZiOGE1YmYwNDVkYzU0YjgwMDcyMWE2YmI1ZjBjMjQwMjU4MjFmNGZiJnNvcnQ9dGlja2Vy
                request_id: a47d1beb8c11b6ae897ab76cdbbf35a3
                results:
                  underlying:
                    url: https://api.polygon.io/v2/aggs/ticker/X:BTCUSD/range/1/day/2003-01-01/2022-07-25
                  values:
                    - timestamp: 1517562000016
                      value: 140.139
                status: OK
              schema:
                properties:
                  next_url:
                    description: If present, this value can be used to fetch the next page of data.
                    type: string
                  request_id:
                    description: A request id assigned by the server.
                    type: string
                  results:
                    properties:
                      underlying:
                        properties:
                          aggregates:
                            items:
                              properties:
                                c:
                                  description: The close price for the symbol in the given time period.
                                  format: float
                                  type: number
                                h:
                                  description: The highest price for the symbol in the given time period.
                                  format: float
                                  type: number
                                l:
                                  description: The lowest price for the symbol in the given time period.
                                  format: float
                                  type: number
                                n:
                                  description: The number of transactions in the aggregate window.
                                  type: integer
                                o:
                                  description: The open price for the symbol in the given time period.
                                  format: float
                                  type: number
                                otc:
                                  description: Whether or not this aggregate is for an OTC ticker. This field will
                                    be left off if false.
                                  type: boolean
                                t:
                                  description: The Unix Msec timestamp for the start of the aggregate window.
                                  format: float
                                  type: number
                                v:
                                  description: The trading volume of the symbol in the given time period.
                                  format: float
                                  type: number
                                vw:
                                  description: The volume weighted average price.
                                  format: float
                                  type: number
                              required:
                                - v
                                - vw
                                - o
                                - c
                                - h
                                - l
                                - t
                                - n
                              type: object
                              x-polygon-go-type:
                                name: Aggregate
                                path: github.com/polygon-io/go-lib-models/v2/globals
                            type: array
                          url:
                            description: The URL which can be used to request the underlying aggregates used
                              in this request.
                            type: string
                        type: object
                      values:
                        items:
                          properties:
                            timestamp:
                              description: The Unix Msec timestamp from the last aggregate used in this
                                calculation.
                              format: int64
                              type: integer
                              x-polygon-go-type:
                                name: IMicroseconds
                                path: github.com/polygon-io/ptime
                            value:
                              description: The indicator value for this period.
                              format: float
                              type: number
                              x-polygon-go-type:
                                name: "*float64"
                          type: object
                        type: array
                    type: object
                    x-polygon-go-type:
                      name: EMAResults
                  status:
                    description: The status of this request's response.
                    type: string
                type: object
            text/csv:
              example: |
                aggregate_T,aggregate_v,aggregate_vw,aggregate_a,aggregate_o,aggregate_c,aggregate_h,aggregate_l,aggregate_t,aggregate_n,aggregate_m,aggregate_x,aggregate_g,aggregate_op,aggregate_z,aggregate_av,aggregate_s,aggregate_e,aggregate_otc,timestamp,value
                X:BTCUSD,55188.33773657,18970.3019,0,18816.66899332,19165.98,19333,18690,1664164800000,297389,,0,,0,0,0,0,0,false,1664164800000,19846.01135387188
                X:BTCUSD,4798.38258637,18914.0766,0,18928,18784.41,19184.3,18636,1664078400000,78936,,0,,0,0,0,0,0,false,1664078400000,19902.65703099573
                X:BTCUSD,4798.38258637,18914.0766,0,18928,18784.41,19184.3,18636,1664064000000,78936,,0,,0,0,0,0,0,false,1664064000000,19948.29976695474
                X:BTCUSD,15457.24362826,19317.486,0,19529.04,19475.84,19651.2772302,18846.67,1664409600000,191936,,0,,0,0,0,0,0,false,1664409600000,19751.714760699124
                X:BTCUSD,23180.93663313,19103.9189,0,19090,19416.20352522,19791,18461,1664337600000,225076,,0,,0,0,0,0,0,false,1664337600000,19762.974955013375
                X:BTCUSD,17479.00092209,19776.6697,0,19228.2,19141.78,20372.17374536,18821.55,1664251200000,183075,,0,,0,0,0,0,0,false,1664251200000,19791.86053850303
                X:BTCUSD,2868.09828007,19069.8521,0,19210.31,18925.87,19400,18805.1,1663992000000,58721,,0,,0,0,0,0,0,false,1663992000000,19995.805471728403
                X:BTCUSD,23180.93663313,19103.9189,0,19090,19416.20352522,19791,18461,1664323200000,225076,,0,,0,0,0,0,0,false,1664323200000,19777.128890923308
                X:BTCUSD,17479.00092209,19776.6697,0,19228.2,19141.78,20372.17374536,18821.55,1664236800000,183075,,0,,0,0,0,0,0,false,1664236800000,19818.394438033767
                X:BTCUSD,55188.33773657,18970.3019,0,18816.66899332,19165.98,19333,18690,1664150400000,297389,,0,,0,0,0,0,0,false,1664150400000,19873.767735662568
              schema:
                type: string
          description: Exponential Moving Average (EMA) data for each period.
      summary: Exponential Moving Average (EMA)
      tags:
        - crpyto:aggregates
      x-polygon-entitlement-data-type:
        description: Aggregate data
        name: aggregates
      x-polygon-entitlement-market-type:
        description: Crypto data
        name: crypto
    x-polygon-ignore: true
    parameters:
      - &a1
        description: API.market API Key
        in: header
        name: x-api-market-key
        value: Please Login/Signup to get an API Key
        required: true
        schema:
          type: string
  /v1/indicators/ema/{fxTicker}:
    get:
      description: Get the exponential moving average (EMA) for a ticker symbol over a
        given time range.
      operationId: ForexEMA
      parameters:
        - description: The ticker symbol for which to get exponential moving average (EMA)
            data.
          example: C:EURUSD
          in: path
          name: fxTicker
          required: true
          schema:
            type: string
          x-polygon-go-id: Ticker
        - description: Query by timestamp. Either a date with the format YYYY-MM-DD or a
            millisecond timestamp.
          in: query
          name: timestamp
          schema:
            type: string
          x-polygon-filter-field:
            range: true
        - description: The size of the aggregate time window.
          example: day
          in: query
          name: timespan
          schema:
            default: day
            enum:
              - minute
              - hour
              - day
              - week
              - month
              - quarter
              - year
            type: string
        - description: >-
            Whether or not the aggregates used to calculate the exponential
            moving average are adjusted for splits. By default, aggregates are
            adjusted.

            Set this to false to get results that are NOT adjusted for splits.
          example: true
          in: query
          name: adjusted
          schema:
            default: true
            type: boolean
        - description: The window size used to calculate the exponential moving average
            (EMA). i.e. a window size of 10 with daily aggregates would result
            in a 10 day moving average.
          example: 50
          in: query
          name: window
          schema:
            default: 50
            type: integer
        - description: >-
            The price in the aggregate which will be used to calculate the
            exponential moving average. i.e. 'close' will result in using close
            prices to 

            calculate the exponential moving average (EMA).
          example: close
          in: query
          name: series_type
          schema:
            default: close
            enum:
              - open
              - high
              - low
              - close
            type: string
        - description: Whether or not to include the aggregates used to calculate this
            indicator in the response.
          in: query
          name: expand_underlying
          schema:
            default: false
            type: boolean
        - description: The order in which to return the results, ordered by timestamp.
          example: desc
          in: query
          name: order
          schema:
            default: desc
            enum:
              - asc
              - desc
            type: string
        - description: Limit the number of results returned, default is 10 and max is 5000
          in: query
          name: limit
          schema:
            default: 10
            maximum: 5000
            type: integer
        - description: Range by timestamp.
          in: query
          name: timestamp.gte
          schema:
            type: string
        - description: Range by timestamp.
          in: query
          name: timestamp.gt
          schema:
            type: string
        - description: Range by timestamp.
          in: query
          name: timestamp.lte
          schema:
            type: string
        - description: Range by timestamp.
          in: query
          name: timestamp.lt
          schema:
            type: string
      responses:
        "200":
          content:
            application/json:
              example:
                next_url: https://api.polygon.io/v1/indicators/ema/C:USDAUD?cursor=YWN0aXZlPXRydWUmZGF0ZT0yMDIxLTA0LTI1JmxpbWl0PTEmb3JkZXI9YXNjJnBhZ2VfbWFya2VyPUElN0M5YWRjMjY0ZTgyM2E1ZjBiOGUyNDc5YmZiOGE1YmYwNDVkYzU0YjgwMDcyMWE2YmI1ZjBjMjQwMjU4MjFmNGZiJnNvcnQ9dGlja2Vy
                request_id: a47d1beb8c11b6ae897ab76cdbbf35a3
                results:
                  underlying:
                    url: https://api.polygon.io/v2/aggs/ticker/C:USDAUD/range/1/day/2003-01-01/2022-07-25
                  values:
                    - timestamp: 1517562000016
                      value: 140.139
                status: OK
              schema:
                properties:
                  next_url:
                    description: If present, this value can be used to fetch the next page of data.
                    type: string
                  request_id:
                    description: A request id assigned by the server.
                    type: string
                  results:
                    properties:
                      underlying:
                        properties:
                          aggregates:
                            items:
                              properties:
                                c:
                                  description: The close price for the symbol in the given time period.
                                  format: float
                                  type: number
                                h:
                                  description: The highest price for the symbol in the given time period.
                                  format: float
                                  type: number
                                l:
                                  description: The lowest price for the symbol in the given time period.
                                  format: float
                                  type: number
                                n:
                                  description: The number of transactions in the aggregate window.
                                  type: integer
                                o:
                                  description: The open price for the symbol in the given time period.
                                  format: float
                                  type: number
                                otc:
                                  description: Whether or not this aggregate is for an OTC ticker. This field will
                                    be left off if false.
                                  type: boolean
                                t:
                                  description: The Unix Msec timestamp for the start of the aggregate window.
                                  format: float
                                  type: number
                                v:
                                  description: The trading volume of the symbol in the given time period.
                                  format: float
                                  type: number
                                vw:
                                  description: The volume weighted average price.
                                  format: float
                                  type: number
                              required:
                                - v
                                - vw
                                - o
                                - c
                                - h
                                - l
                                - t
                                - n
                              type: object
                              x-polygon-go-type:
                                name: Aggregate
                                path: github.com/polygon-io/go-lib-models/v2/globals
                            type: array
                          url:
                            description: The URL which can be used to request the underlying aggregates used
                              in this request.
                            type: string
                        type: object
                      values:
                        items:
                          properties:
                            timestamp:
                              description: The Unix Msec timestamp from the last aggregate used in this
                                calculation.
                              format: int64
                              type: integer
                              x-polygon-go-type:
                                name: IMicroseconds
                                path: github.com/polygon-io/ptime
                            value:
                              description: The indicator value for this period.
                              format: float
                              type: number
                              x-polygon-go-type:
                                name: "*float64"
                          type: object
                        type: array
                    type: object
                    x-polygon-go-type:
                      name: EMAResults
                  status:
                    description: The status of this request's response.
                    type: string
                type: object
            text/csv:
              example: |
                aggregate_T,aggregate_v,aggregate_vw,aggregate_a,aggregate_o,aggregate_c,aggregate_h,aggregate_l,aggregate_t,aggregate_n,aggregate_m,aggregate_x,aggregate_g,aggregate_op,aggregate_z,aggregate_av,aggregate_s,aggregate_e,aggregate_otc,timestamp,value
                C:USDAUD,685,1.5537,0,1.5539533,1.5371372,1.5705737,1.5316281,1664323200000,685,,0,,0,0,0,0,0,false,1664323200000,1.4915199239999994
                C:USDAUD,550,1.5405,0,1.5298,1.54531,1.5526263,1.5298,1664164800000,550,,0,,0,0,0,0,0,false,1664164800000,1.4863299679999997
                C:USDAUD,10,1.5312,0,1.5324261,1.53107,1.5326375,1.5301,1664078400000,10,,0,,0,0,0,0,0,false,1664078400000,1.4826388699999997
                C:USDAUD,686,1.5442,0,1.53763,1.5404,1.5526022,1.537279,1664409600000,686,,0,,0,0,0,0,0,false,1664409600000,1.4942168479999998
                C:USDAUD,536,1.5459,0,1.5446162,1.5550165,1.5587,1.5364287,1664251200000,536,,0,,0,0,0,0,0,false,1664251200000,1.4900704799999993
                C:USDAUD,536,1.5459,0,1.5446162,1.5550165,1.5587,1.5364287,1664236800000,536,,0,,0,0,0,0,0,false,1664236800000,1.4882634499999994
                C:USDAUD,550,1.5405,0,1.5298,1.54531,1.5526263,1.5298,1664150400000,550,,0,,0,0,0,0,0,false,1664150400000,1.4845906159999998
                C:USDAUD,10,1.5312,0,1.5324261,1.53107,1.5326375,1.5301,1664064000000,10,,0,,0,0,0,0,0,false,1664064000000,1.4809719239999999
                C:USDAUD,1,1.5314,0,1.5313936,1.5313936,1.5313936,1.5313936,1663977600000,1,,0,,0,0,0,0,0,false,1663977600000,1.4794745239999998
                C:USDAUD,685,1.5537,0,1.5539533,1.5371372,1.5705737,1.5316281,1664337600000,685,,0,,0,0,0,0,0,false,1664337600000,1.4928357579999996
              schema:
                type: string
          description: Exponential Moving Average (EMA) data for each period.
      summary: Exponential Moving Average (EMA)
      tags:
        - fx:aggregates
      x-polygon-entitlement-data-type:
        description: Aggregate data
        name: aggregates
      x-polygon-entitlement-market-type:
        description: Forex data
        name: fx
    x-polygon-ignore: true
    parameters:
      - *a1
  /v1/indicators/ema/{indicesTicker}:
    get:
      description: Get the exponential moving average (EMA) for a ticker symbol over a
        given time range.
      operationId: IndicesEMA
      parameters:
        - description: The ticker symbol for which to get exponential moving average (EMA)
            data.
          example: I:NDX
          in: path
          name: indicesTicker
          required: true
          schema:
            type: string
          x-polygon-go-id: Ticker
        - description: Query by timestamp. Either a date with the format YYYY-MM-DD or a
            millisecond timestamp.
          in: query
          name: timestamp
          schema:
            type: string
          x-polygon-filter-field:
            range: true
        - description: The size of the aggregate time window.
          example: day
          in: query
          name: timespan
          schema:
            default: day
            enum:
              - minute
              - hour
              - day
              - week
              - month
              - quarter
              - year
            type: string
        - description: >-
            Whether or not the aggregates used to calculate the exponential
            moving average are adjusted for splits. By default, aggregates are
            adjusted.

            Set this to false to get results that are NOT adjusted for splits.
          example: true
          in: query
          name: adjusted
          schema:
            default: true
            type: boolean
        - description: The window size used to calculate the exponential moving average
            (EMA). i.e. a window size of 10 with daily aggregates would result
            in a 10 day moving average.
          example: 50
          in: query
          name: window
          schema:
            default: 50
            type: integer
        - description: >-
            The value in the aggregate which will be used to calculate the
            exponential moving average. i.e. 'close' will result in using close
            values to 

            calculate the exponential moving average (EMA).
          example: close
          in: query
          name: series_type
          schema:
            default: close
            enum:
              - open
              - high
              - low
              - close
            type: string
        - description: Whether or not to include the aggregates used to calculate this
            indicator in the response.
          in: query
          name: expand_underlying
          schema:
            default: false
            type: boolean
        - description: The order in which to return the results, ordered by timestamp.
          example: desc
          in: query
          name: order
          schema:
            default: desc
            enum:
              - asc
              - desc
            type: string
        - description: Limit the number of results returned, default is 10 and max is 5000
          in: query
          name: limit
          schema:
            default: 10
            maximum: 5000
            type: integer
        - description: Range by timestamp.
          in: query
          name: timestamp.gte
          schema:
            type: string
        - description: Range by timestamp.
          in: query
          name: timestamp.gt
          schema:
            type: string
        - description: Range by timestamp.
          in: query
          name: timestamp.lte
          schema:
            type: string
        - description: Range by timestamp.
          in: query
          name: timestamp.lt
          schema:
            type: string
      responses:
        "200":
          content:
            application/json:
              example:
                next_url: https://api.polygon.io/v1/indicators/ema/I:NDX?cursor=YWRqdXN0ZWQ9dHJ1ZSZhcD0lN0IlMjJ2JTIyJTNBMCUyQyUyMm8lMjIlM0EwJTJDJTIyYyUyMiUzQTE1MDg0Ljk5OTM4OTgyMDAzJTJDJTIyaCUyMiUzQTAlMkMlMjJsJTIyJTNBMCUyQyUyMnQlMjIlM0ExNjg3MjE5MjAwMDAwJTdEJmFzPSZleHBhbmRfdW5kZXJseWluZz1mYWxzZSZsaW1pdD0xJm9yZGVyPWRlc2Mmc2VyaWVzX3R5cGU9Y2xvc2UmdGltZXNwYW49ZGF5JnRpbWVzdGFtcC5sdD0xNjg3MjM3MjAwMDAwJndpbmRvdz01MA
                request_id: b9201816341441eed663a90443c0623a
                results:
                  underlying:
                    url: https://api.polygon.io/v2/aggs/ticker/I:NDX/range/1/day/1678338000000/1687366449650?limit=226&sort=desc
                  values:
                    - timestamp: 1687237200000
                      value: 14452.002555459003
                status: OK
              schema:
                properties:
                  next_url:
                    description: If present, this value can be used to fetch the next page of data.
                    type: string
                  request_id:
                    description: A request id assigned by the server.
                    type: string
                  results:
                    properties:
                      underlying:
                        properties:
                          aggregates:
                            items:
                              properties:
                                c:
                                  description: The close price for the symbol in the given time period.
                                  format: float
                                  type: number
                                h:
                                  description: The highest price for the symbol in the given time period.
                                  format: float
                                  type: number
                                l:
                                  description: The lowest price for the symbol in the given time period.
                                  format: float
                                  type: number
                                n:
                                  description: The number of transactions in the aggregate window.
                                  type: integer
                                o:
                                  description: The open price for the symbol in the given time period.
                                  format: float
                                  type: number
                                otc:
                                  description: Whether or not this aggregate is for an OTC ticker. This field will
                                    be left off if false.
                                  type: boolean
                                t:
                                  description: The Unix Msec timestamp for the start of the aggregate window.
                                  format: float
                                  type: number
                                v:
                                  description: The trading volume of the symbol in the given time period.
                                  format: float
                                  type: number
                                vw:
                                  description: The volume weighted average price.
                                  format: float
                                  type: number
                              required:
                                - v
                                - vw
                                - o
                                - c
                                - h
                                - l
                                - t
                                - n
                              type: object
                              x-polygon-go-type:
                                name: Aggregate
                                path: github.com/polygon-io/go-lib-models/v2/globals
                            type: array
                          url:
                            description: The URL which can be used to request the underlying aggregates used
                              in this request.
                            type: string
                        type: object
                      values:
                        items:
                          properties:
                            timestamp:
                              description: The Unix Msec timestamp from the last aggregate used in this
                                calculation.
                              format: int64
                              type: integer
                              x-polygon-go-type:
                                name: IMicroseconds
                                path: github.com/polygon-io/ptime
                            value:
                              description: The indicator value for this period.
                              format: float
                              type: number
                              x-polygon-go-type:
                                name: "*float64"
                          type: object
                        type: array
                    type: object
                    x-polygon-go-type:
                      name: EMAResults
                  status:
                    description: The status of this request's response.
                    type: string
                type: object
          description: Exponential Moving Average (EMA) data for each period.
      summary: Exponential Moving Average (EMA)
      tags:
        - indices:aggregates
      x-polygon-entitlement-allowed-limited-tickers: true
      x-polygon-entitlement-data-type:
        description: Aggregate data
        name: aggregates
      x-polygon-entitlement-market-type:
        description: Indices data
        name: indices
    x-polygon-ignore: true
    parameters:
      - *a1
  /v1/indicators/ema/{optionsTicker}:
    get:
      description: Get the exponential moving average (EMA) for a ticker symbol over a
        given time range.
      operationId: OptionsEMA
      parameters:
        - description: The ticker symbol for which to get exponential moving average (EMA)
            data.
          example: O:SPY241220P00720000
          in: path
          name: optionsTicker
          required: true
          schema:
            type: string
          x-polygon-go-id: Ticker
        - description: Query by timestamp. Either a date with the format YYYY-MM-DD or a
            millisecond timestamp.
          in: query
          name: timestamp
          schema:
            type: string
          x-polygon-filter-field:
            range: true
        - description: The size of the aggregate time window.
          example: day
          in: query
          name: timespan
          schema:
            default: day
            enum:
              - minute
              - hour
              - day
              - week
              - month
              - quarter
              - year
            type: string
        - description: >-
            Whether or not the aggregates used to calculate the exponential
            moving average are adjusted for splits. By default, aggregates are
            adjusted.

            Set this to false to get results that are NOT adjusted for splits.
          example: true
          in: query
          name: adjusted
          schema:
            default: true
            type: boolean
        - description: The window size used to calculate the exponential moving average
            (EMA). i.e. a window size of 10 with daily aggregates would result
            in a 10 day moving average.
          example: 50
          in: query
          name: window
          schema:
            default: 50
            type: integer
        - description: >-
            The price in the aggregate which will be used to calculate the
            exponential moving average. i.e. 'close' will result in using close
            prices to 

            calculate the exponential moving average (EMA).
          example: close
          in: query
          name: series_type
          schema:
            default: close
            enum:
              - open
              - high
              - low
              - close
            type: string
        - description: Whether or not to include the aggregates used to calculate this
            indicator in the response.
          in: query
          name: expand_underlying
          schema:
            default: false
            type: boolean
        - description: The order in which to return the results, ordered by timestamp.
          example: desc
          in: query
          name: order
          schema:
            default: desc
            enum:
              - asc
              - desc
            type: string
        - description: Limit the number of results returned, default is 10 and max is 5000
          in: query
          name: limit
          schema:
            default: 10
            maximum: 5000
            type: integer
        - description: Range by timestamp.
          in: query
          name: timestamp.gte
          schema:
            type: string
        - description: Range by timestamp.
          in: query
          name: timestamp.gt
          schema:
            type: string
        - description: Range by timestamp.
          in: query
          name: timestamp.lte
          schema:
            type: string
        - description: Range by timestamp.
          in: query
          name: timestamp.lt
          schema:
            type: string
      responses:
        "200":
          content:
            application/json:
              example:
                next_url: https://api.polygon.io/v1/indicators/ema/O:SPY241220P00720000?cursor=YWN0aXZlPXRydWUmZGF0ZT0yMDIxLTA0LTI1JmxpbWl0PTEmb3JkZXI9YXNjJnBhZ2VfbWFya2VyPUElN0M5YWRjMjY0ZTgyM2E1ZjBiOGUyNDc5YmZiOGE1YmYwNDVkYzU0YjgwMDcyMWE2YmI1ZjBjMjQwMjU4MjFmNGZiJnNvcnQ9dGlja2Vy
                request_id: a47d1beb8c11b6ae897ab76cdbbf35a3
                results:
                  underlying:
                    url: https://api.polygon.io/v2/aggs/ticker/O:SPY241220P00720000/range/1/day/2003-01-01/2022-07-25
                  values:
                    - timestamp: 1517562000016
                      value: 140.139
                status: OK
              schema:
                properties:
                  next_url:
                    description: If present, this value can be used to fetch the next page of data.
                    type: string
                  request_id:
                    description: A request id assigned by the server.
                    type: string
                  results:
                    properties:
                      underlying:
                        properties:
                          aggregates:
                            items:
                              properties:
                                c:
                                  description: The close price for the symbol in the given time period.
                                  format: float
                                  type: number
                                h:
                                  description: The highest price for the symbol in the given time period.
                                  format: float
                                  type: number
                                l:
                                  description: The lowest price for the symbol in the given time period.
                                  format: float
                                  type: number
                                n:
                                  description: The number of transactions in the aggregate window.
                                  type: integer
                                o:
                                  description: The open price for the symbol in the given time period.
                                  format: float
                                  type: number
                                otc:
                                  description: Whether or not this aggregate is for an OTC ticker. This field will
                                    be left off if false.
                                  type: boolean
                                t:
                                  description: The Unix Msec timestamp for the start of the aggregate window.
                                  format: float
                                  type: number
                                v:
                                  description: The trading volume of the symbol in the given time period.
                                  format: float
                                  type: number
                                vw:
                                  description: The volume weighted average price.
                                  format: float
                                  type: number
                              required:
                                - v
                                - vw
                                - o
                                - c
                                - h
                                - l
                                - t
                                - n
                              type: object
                              x-polygon-go-type:
                                name: Aggregate
                                path: github.com/polygon-io/go-lib-models/v2/globals
                            type: array
                          url:
                            description: The URL which can be used to request the underlying aggregates used
                              in this request.
                            type: string
                        type: object
                      values:
                        items:
                          properties:
                            timestamp:
                              description: The Unix Msec timestamp from the last aggregate used in this
                                calculation.
                              format: int64
                              type: integer
                              x-polygon-go-type:
                                name: IMicroseconds
                                path: github.com/polygon-io/ptime
                            value:
                              description: The indicator value for this period.
                              format: float
                              type: number
                              x-polygon-go-type:
                                name: "*float64"
                          type: object
                        type: array
                    type: object
                    x-polygon-go-type:
                      name: EMAResults
                  status:
                    description: The status of this request's response.
                    type: string
                type: object
            text/csv:
              example: aggregate_T,aggregate_v,aggregate_vw,aggregate_a,aggregate_o,aggregate_c,aggregate_h,aggregate_l,aggregate_t,aggregate_n,aggregate_m,aggregate_x,aggregate_g,aggregate_op,aggregate_z,aggregate_av,aggregate_s,aggregate_e,aggregate_otc,timestamp,value
                O:SPY241220P00720000,1,299.97,0,299.97,299.97,299.97,299.97,1649217600000,1,,0,,0,0,0,0,0,false,1649217600000,286.1730473491824
                O:SPY241220P00720000,1,299.97,0,299.97,299.97,299.97,299.97,1649131200000,1,,0,,0,0,0,0,0,false,1649131200000,285.60990642465924
                O:SPY241220P00720000,1,299.97,0,299.97,299.97,299.97,299.97,1649044800000,1,,0,,0,0,0,0,0,false,1649044800000,285.023780156278
                O:SPY241220P00720000,1,299.97,0,299.97,299.97,299.97,299.97,1648785600000,1,,0,,0,0,0,0,0,false,1648785600000,284.4137303667383
                O:SPY241220P00720000,1,299.97,0,299.97,299.97,299.97,299.97,1648526400000,1,,0,,0,0,0,0,0,false,1648526400000,282.43007426223943
                O:SPY241220P00720000,1,299.97,0,299.97,299.97,299.97,299.97,1649304000000,1,,0,,0,0,0,0,0,false,1649304000000,286.7141043158811
                O:SPY241220P00720000,2,270.49,0,270.49,270.49,270.49,270.49,1649390400000,1,,0,,0,0,0,0,0,false,1649390400000,286.0778649309446
                O:SPY241220P00720000,1,299.97,0,299.97,299.97,299.97,299.97,1648699200000,1,,0,,0,0,0,0,0,false,1648699200000,283.77878058578887
                O:SPY241220P00720000,1,299.97,0,299.97,299.97,299.97,299.97,1648612800000,1,,0,,0,0,0,0,0,false,1648612800000,283.11791448724966
                O:SPY241220P00720000,3,277.8267,0,277.82,277.83,277.83,277.82,1649649600000,2,,0,,0,0,0,0,0,false,1649649600000,285.7544192473781
              schema:
                type: string
          description: Exponential Moving Average (EMA) data for each period.
      summary: Exponential Moving Average (EMA)
      tags:
        - options:aggregates
      x-polygon-entitlement-data-type:
        description: Aggregate data
        name: aggregates
      x-polygon-entitlement-market-type:
        description: Options data
        name: options
    x-polygon-ignore: true
    parameters:
      - *a1
  /v1/indicators/ema/{stockTicker}:
    get:
      description: Get the exponential moving average (EMA) for a ticker symbol over a
        given time range.
      operationId: EMA
      parameters:
        - description: Specify a case-sensitive ticker symbol for which to get exponential
            moving average (EMA) data. For example, AAPL represents Apple Inc.
          example: AAPL
          in: path
          name: stockTicker
          required: true
          schema:
            type: string
          x-polygon-go-id: Ticker
        - description: Query by timestamp. Either a date with the format YYYY-MM-DD or a
            millisecond timestamp.
          in: query
          name: timestamp
          schema:
            type: string
          x-polygon-filter-field:
            range: true
        - description: The size of the aggregate time window.
          example: day
          in: query
          name: timespan
          schema:
            default: day
            enum:
              - minute
              - hour
              - day
              - week
              - month
              - quarter
              - year
            type: string
        - description: Whether or not the aggregates used to calculate the exponential
            moving average are adjusted for splits. By default, aggregates are
            adjusted. Set this to false to get results that are NOT adjusted for
            splits.
          example: true
          in: query
          name: adjusted
          schema:
            default: true
            type: boolean
        - description: The window size used to calculate the exponential moving average
            (EMA). i.e. a window size of 10 with daily aggregates would result
            in a 10 day moving average.
          example: 50
          in: query
          name: window
          schema:
            default: 50
            type: integer
        - description: >-
            The price in the aggregate which will be used to calculate the
            exponential moving average. i.e. 'close' will result in using close
            prices to 

            calculate the exponential moving average (EMA).
          example: close
          in: query
          name: series_type
          schema:
            default: close
            enum:
              - open
              - high
              - low
              - close
            type: string
        - description: Whether or not to include the aggregates used to calculate this
            indicator in the response.
          in: query
          name: expand_underlying
          schema:
            default: false
            type: boolean
        - description: The order in which to return the results, ordered by timestamp.
          example: desc
          in: query
          name: order
          schema:
            default: desc
            enum:
              - asc
              - desc
            type: string
        - description: Limit the number of results returned, default is 10 and max is 5000
          in: query
          name: limit
          schema:
            default: 10
            maximum: 5000
            type: integer
        - description: Range by timestamp.
          in: query
          name: timestamp.gte
          schema:
            type: string
        - description: Range by timestamp.
          in: query
          name: timestamp.gt
          schema:
            type: string
        - description: Range by timestamp.
          in: query
          name: timestamp.lte
          schema:
            type: string
        - description: Range by timestamp.
          in: query
          name: timestamp.lt
          schema:
            type: string
      responses:
        "200":
          content:
            application/json:
              example:
                next_url: https://api.polygon.io/v1/indicators/ema/AAPL?cursor=YWN0aXZlPXRydWUmZGF0ZT0yMDIxLTA0LTI1JmxpbWl0PTEmb3JkZXI9YXNjJnBhZ2VfbWFya2VyPUElN0M5YWRjMjY0ZTgyM2E1ZjBiOGUyNDc5YmZiOGE1YmYwNDVkYzU0YjgwMDcyMWE2YmI1ZjBjMjQwMjU4MjFmNGZiJnNvcnQ9dGlja2Vy
                request_id: a47d1beb8c11b6ae897ab76cdbbf35a3
                results:
                  underlying:
                    url: https://api.polygon.io/v2/aggs/ticker/AAPL/range/1/day/2003-01-01/2022-07-25
                  values:
                    - timestamp: 1517562000016
                      value: 140.139
                status: OK
              schema:
                properties:
                  next_url:
                    description: If present, this value can be used to fetch the next page of data.
                    type: string
                  request_id:
                    description: A request id assigned by the server.
                    type: string
                  results:
                    properties:
                      underlying:
                        properties:
                          aggregates:
                            items:
                              properties:
                                c:
                                  description: The close price for the symbol in the given time period.
                                  format: float
                                  type: number
                                h:
                                  description: The highest price for the symbol in the given time period.
                                  format: float
                                  type: number
                                l:
                                  description: The lowest price for the symbol in the given time period.
                                  format: float
                                  type: number
                                n:
                                  description: The number of transactions in the aggregate window.
                                  type: integer
                                o:
                                  description: The open price for the symbol in the given time period.
                                  format: float
                                  type: number
                                otc:
                                  description: Whether or not this aggregate is for an OTC ticker. This field will
                                    be left off if false.
                                  type: boolean
                                t:
                                  description: The Unix Msec timestamp for the start of the aggregate window.
                                  format: float
                                  type: number
                                v:
                                  description: The trading volume of the symbol in the given time period.
                                  format: float
                                  type: number
                                vw:
                                  description: The volume weighted average price.
                                  format: float
                                  type: number
                              required:
                                - v
                                - vw
                                - o
                                - c
                                - h
                                - l
                                - t
                                - n
                              type: object
                              x-polygon-go-type:
                                name: Aggregate
                                path: github.com/polygon-io/go-lib-models/v2/globals
                            type: array
                          url:
                            description: The URL which can be used to request the underlying aggregates used
                              in this request.
                            type: string
                        type: object
                      values:
                        items:
                          properties:
                            timestamp:
                              description: The Unix Msec timestamp from the last aggregate used in this
                                calculation.
                              format: int64
                              type: integer
                              x-polygon-go-type:
                                name: IMicroseconds
                                path: github.com/polygon-io/ptime
                            value:
                              description: The indicator value for this period.
                              format: float
                              type: number
                              x-polygon-go-type:
                                name: "*float64"
                          type: object
                        type: array
                    type: object
                    x-polygon-go-type:
                      name: EMAResults
                  status:
                    description: The status of this request's response.
                    type: string
                type: object
            text/csv:
              example: |
                aggregate_T,aggregate_v,aggregate_vw,aggregate_a,aggregate_o,aggregate_c,aggregate_h,aggregate_l,aggregate_t,aggregate_n,aggregate_m,aggregate_x,aggregate_g,aggregate_op,aggregate_z,aggregate_av,aggregate_s,aggregate_e,aggregate_otc,timestamp,value
                AAPL,8.1599225E+07,152.5505,0,149.31,154.48,154.56,149.1,1663560000000,671961,,0,,0,0,0,0,0,false,1663560000000,163.17972071441582
                AAPL,8.4461761E+07,152.1354,0,152.74,151.76,154.72,149.945,1664251200000,683781,,0,,0,0,0,0,0,false,1664251200000,160.92194334973746
                AAPL,9.3308449E+07,156.1877,0,157.34,153.72,158.61,153.6,1663732800000,712645,,0,,0,0,0,0,0,false,1663732800000,162.5721451116157
                AAPL,1.07691097E+08,156.1317,0,153.4,156.9,158.08,153.08,1663646400000,792177,,0,,0,0,0,0,0,false,1663646400000,162.93345715698777
                AAPL,9.6031641E+07,150.0222,0,151.19,150.43,151.47,148.56,1663905600000,766888,,0,,0,0,0,0,0,false,1663905600000,161.72552880161066
                AAPL,8.6651514E+07,152.5709,0,152.38,152.74,154.47,150.91,1663819200000,686866,,0,,0,0,0,0,0,false,1663819200000,162.18657079351314
                AAPL,1.64879031E+08,150.2387,0,151.21,150.7,151.35,148.37,1663300800000,850358,,0,,0,0,0,0,0,false,1663300800000,163.53481135582055
                AAPL,1.27842348E+08,142.9013,0,146.1,142.48,146.72,140.68,1664424000000,1061605,,0,,0,0,0,0,0,false,1664424000000,159.78118646009983
                AAPL,1.46755122E+08,147.599,0,147.64,149.84,150.6414,144.84,1664337600000,1140818,,0,,0,0,0,0,0,false,1664337600000,160.48735733602226
                AAPL,9.3339409E+07,151.5222,0,149.66,150.77,153.7701,149.64,1664164800000,747666,,0,,0,0,0,0,0,false,1664164800000,161.29590022115534
              schema:
                type: string
          description: Exponential Moving Average (EMA) data for each period.
      summary: Exponential Moving Average (EMA)
      tags:
        - stocks:aggregates
      x-polygon-entitlement-data-type:
        description: Aggregate data
        name: aggregates
      x-polygon-entitlement-market-type:
        description: Stocks data
        name: stocks
    parameters:
      - *a1
  /v1/indicators/macd/{cryptoTicker}:
    get:
      description: Get moving average convergence/divergence (MACD) data for a ticker
        symbol over a given time range.
      operationId: CryptoMACD
      parameters:
        - description: The ticker symbol for which to get MACD data.
          example: X:BTCUSD
          in: path
          name: cryptoTicker
          required: true
          schema:
            type: string
          x-polygon-go-id: Ticker
        - description: Query by timestamp. Either a date with the format YYYY-MM-DD or a
            millisecond timestamp.
          in: query
          name: timestamp
          schema:
            type: string
          x-polygon-filter-field:
            range: true
        - description: The size of the aggregate time window.
          example: day
          in: query
          name: timespan
          schema:
            default: day
            enum:
              - minute
              - hour
              - day
              - week
              - month
              - quarter
              - year
            type: string
        - description: The short window size used to calculate MACD data.
          example: 12
          in: query
          name: short_window
          schema:
            default: 12
            type: integer
        - description: The long window size used to calculate MACD data.
          example: 26
          in: query
          name: long_window
          schema:
            default: 26
            type: integer
        - description: The window size used to calculate the MACD signal line.
          example: 9
          in: query
          name: signal_window
          schema:
            default: 9
            type: integer
        - description: >-
            The price in the aggregate which will be used to calculate MACD
            data. i.e. 'close' will result in using close prices to 

            calculate the MACD.
          example: close
          in: query
          name: series_type
          schema:
            default: close
            enum:
              - open
              - high
              - low
              - close
            type: string
        - description: Whether or not to include the aggregates used to calculate this
            indicator in the response.
          in: query
          name: expand_underlying
          schema:
            default: false
            type: boolean
        - description: The order in which to return the results, ordered by timestamp.
          example: desc
          in: query
          name: order
          schema:
            default: desc
            enum:
              - asc
              - desc
            type: string
        - description: Limit the number of results returned, default is 10 and max is 5000
          in: query
          name: limit
          schema:
            default: 10
            maximum: 5000
            type: integer
        - description: Range by timestamp.
          in: query
          name: timestamp.gte
          schema:
            type: string
        - description: Range by timestamp.
          in: query
          name: timestamp.gt
          schema:
            type: string
        - description: Range by timestamp.
          in: query
          name: timestamp.lte
          schema:
            type: string
        - description: Range by timestamp.
          in: query
          name: timestamp.lt
          schema:
            type: string
      responses:
        "200":
          content:
            application/json:
              example:
                next_url: https://api.polygon.io/v1/indicators/macd/X:BTCUSD?cursor=YWN0aXZlPXRydWUmZGF0ZT0yMDIxLTA0LTI1JmxpbWl0PTEmb3JkZXI9YXNjJnBhZ2VfbWFya2VyPUElN0M5YWRjMjY0ZTgyM2E1ZjBiOGUyNDc5YmZiOGE1YmYwNDVkYzU0YjgwMDcyMWE2YmI1ZjBjMjQwMjU4MjFmNGZiJnNvcnQ9dGlja2Vy
                request_id: a47d1beb8c11b6ae897ab76cdbbf35a3
                results:
                  underlying:
                    url: https://api.polygon.io/v2/aggs/ticker/X:BTCUSD/range/1/day/2003-01-01/2022-07-25
                  values:
                    - histogram: 38.3801666667
                      signal: 106.9811666667
                      timestamp: 1517562000016
                      value: 145.3613333333
                    - histogram: 41.098859136
                      signal: 102.7386283473
                      timestamp: 1517562001016
                      value: 143.8374874833
                status: OK
              schema:
                properties:
                  next_url:
                    description: If present, this value can be used to fetch the next page of data.
                    type: string
                  request_id:
                    description: A request id assigned by the server.
                    type: string
                  results:
                    properties:
                      underlying:
                        properties:
                          aggregates:
                            items:
                              properties:
                                c:
                                  description: The close price for the symbol in the given time period.
                                  format: float
                                  type: number
                                h:
                                  description: The highest price for the symbol in the given time period.
                                  format: float
                                  type: number
                                l:
                                  description: The lowest price for the symbol in the given time period.
                                  format: float
                                  type: number
                                n:
                                  description: The number of transactions in the aggregate window.
                                  type: integer
                                o:
                                  description: The open price for the symbol in the given time period.
                                  format: float
                                  type: number
                                otc:
                                  description: Whether or not this aggregate is for an OTC ticker. This field will
                                    be left off if false.
                                  type: boolean
                                t:
                                  description: The Unix Msec timestamp for the start of the aggregate window.
                                  format: float
                                  type: number
                                v:
                                  description: The trading volume of the symbol in the given time period.
                                  format: float
                                  type: number
                                vw:
                                  description: The volume weighted average price.
                                  format: float
                                  type: number
                              required:
                                - v
                                - vw
                                - o
                                - c
                                - h
                                - l
                                - t
                                - n
                              type: object
                              x-polygon-go-type:
                                name: Aggregate
                                path: github.com/polygon-io/go-lib-models/v2/globals
                            type: array
                          url:
                            description: The URL which can be used to request the underlying aggregates used
                              in this request.
                            type: string
                        type: object
                      values:
                        items:
                          properties:
                            histogram:
                              description: The indicator value for this period.
                              format: float
                              type: number
                              x-polygon-go-type:
                                name: "*float64"
                            signal:
                              description: The indicator value for this period.
                              format: float
                              type: number
                              x-polygon-go-type:
                                name: "*float64"
                            timestamp:
                              description: The Unix Msec timestamp from the last aggregate used in this
                                calculation.
                              format: int64
                              type: integer
                              x-polygon-go-type:
                                name: IMicroseconds
                                path: github.com/polygon-io/ptime
                            value:
                              description: The indicator value for this period.
                              format: float
                              type: number
                              x-polygon-go-type:
                                name: "*float64"
                          type: object
                        type: array
                    type: object
                    x-polygon-go-type:
                      name: MACDResults
                  status:
                    description: The status of this request's response.
                    type: string
                type: object
            text/csv:
              example: |
                aggregate_T,aggregate_v,aggregate_vw,aggregate_a,aggregate_o,aggregate_c,aggregate_h,aggregate_l,aggregate_t,aggregate_n,aggregate_m,aggregate_x,aggregate_g,aggregate_op,aggregate_z,aggregate_av,aggregate_s,aggregate_e,aggregate_otc,timestamp,value,signal,histogram
                X:BTCUSD,23180.93663313,19103.9189,0,19090,19416.20352522,19791,18461,1664323200000,225076,,0,,0,0,0,0,0,false,1664323200000,-200.79662915774315,-281.5009533935604,80.70432423581724
                X:BTCUSD,17479.00092209,19776.6697,0,19228.2,19141.78,20372.17374536,18821.55,1664236800000,183075,,0,,0,0,0,0,0,false,1664236800000,-264.55324270273195,-316.4388906203941,51.88564791766214
                X:BTCUSD,55188.33773657,18970.3019,0,18816.66899332,19165.98,19333,18690,1664150400000,297389,,0,,0,0,0,0,0,false,1664150400000,-317.75700272815084,-339.5909474061525,21.83394467800167
                X:BTCUSD,4798.38258637,18914.0766,0,18928,18784.41,19184.3,18636,1664078400000,78936,,0,,0,0,0,0,0,false,1664078400000,-350.23805379084297,-345.0494335756529,-5.188620215190042
                X:BTCUSD,4798.38258637,18914.0766,0,18928,18784.41,19184.3,18636,1664064000000,78936,,0,,0,0,0,0,0,false,1664064000000,-347.75055091027025,-343.7522785218554,-3.9982723884148754
                X:BTCUSD,2868.09828007,19069.8521,0,19210.31,18925.87,19400,18805.1,1663992000000,58721,,0,,0,0,0,0,0,false,1663992000000,-339.51740285673077,-342.7527104247516,3.2353075680208576
                X:BTCUSD,11337.77105153,19346.509,0,19527.23,19487.24,19640,18846.95,1664409600000,142239,,0,,0,0,0,0,0,false,1664409600000,-130.70646519456568,-232.81921860513586,102.11275341057018
                X:BTCUSD,23180.93663313,19103.9189,0,19090,19416.20352522,19791,18461,1664337600000,225076,,0,,0,0,0,0,0,false,1664337600000,-165.73322121465026,-258.3474069577784,92.61418574312813
                X:BTCUSD,17479.00092209,19776.6697,0,19228.2,19141.78,20372.17374536,18821.55,1664251200000,183075,,0,,0,0,0,0,0,false,1664251200000,-242.62960978099727,-301.6770344525147,59.04742467151743
                X:BTCUSD,55188.33773657,18970.3019,0,18816.66899332,19165.98,19333,18690,1664164800000,297389,,0,,0,0,0,0,0,false,1664164800000,-288.68772337443806,-329.4103025998096,40.72257922537153
              schema:
                type: string
          description: Moving Average Convergence/Divergence (MACD) data for each period.
      summary: Moving Average Convergence/Divergence (MACD)
      tags:
        - crypto:aggregates
      x-polygon-entitlement-data-type:
        description: Aggregate data
        name: aggregates
      x-polygon-entitlement-market-type:
        description: Crypto data
        name: crypto
    x-polygon-ignore: true
    parameters:
      - *a1
  /v1/indicators/macd/{fxTicker}:
    get:
      description: Get moving average convergence/divergence (MACD) data for a ticker
        symbol over a given time range.
      operationId: ForexMACD
      parameters:
        - description: The ticker symbol for which to get MACD data.
          example: C:EURUSD
          in: path
          name: fxTicker
          required: true
          schema:
            type: string
          x-polygon-go-id: Ticker
        - description: Query by timestamp. Either a date with the format YYYY-MM-DD or a
            millisecond timestamp.
          in: query
          name: timestamp
          schema:
            type: string
          x-polygon-filter-field:
            range: true
        - description: The size of the aggregate time window.
          example: day
          in: query
          name: timespan
          schema:
            default: day
            enum:
              - minute
              - hour
              - day
              - week
              - month
              - quarter
              - year
            type: string
        - description: >-
            Whether or not the aggregates used to calculate the MACD are
            adjusted for splits. By default, aggregates are adjusted.

            Set this to false to get results that are NOT adjusted for splits.
          example: true
          in: query
          name: adjusted
          schema:
            default: true
            type: boolean
        - description: The short window size used to calculate MACD data.
          example: 12
          in: query
          name: short_window
          schema:
            default: 12
            type: integer
        - description: The long window size used to calculate MACD data.
          example: 26
          in: query
          name: long_window
          schema:
            default: 26
            type: integer
        - description: The window size used to calculate the MACD signal line.
          example: 9
          in: query
          name: signal_window
          schema:
            default: 9
            type: integer
        - description: >-
            The price in the aggregate which will be used to calculate the MACD.
            i.e. 'close' will result in using close prices to 

            calculate the MACD.
          example: close
          in: query
          name: series_type
          schema:
            default: close
            enum:
              - open
              - high
              - low
              - close
            type: string
        - description: Whether or not to include the aggregates used to calculate this
            indicator in the response.
          in: query
          name: expand_underlying
          schema:
            default: false
            type: boolean
        - description: The order in which to return the results, ordered by timestamp.
          example: desc
          in: query
          name: order
          schema:
            default: desc
            enum:
              - asc
              - desc
            type: string
        - description: Limit the number of results returned, default is 10 and max is 5000
          in: query
          name: limit
          schema:
            default: 10
            maximum: 5000
            type: integer
        - description: Range by timestamp.
          in: query
          name: timestamp.gte
          schema:
            type: string
        - description: Range by timestamp.
          in: query
          name: timestamp.gt
          schema:
            type: string
        - description: Range by timestamp.
          in: query
          name: timestamp.lte
          schema:
            type: string
        - description: Range by timestamp.
          in: query
          name: timestamp.lt
          schema:
            type: string
      responses:
        "200":
          content:
            application/json:
              example:
                next_url: https://api.polygon.io/v1/indicators/macd/C:USDAUD?cursor=YWN0aXZlPXRydWUmZGF0ZT0yMDIxLTA0LTI1JmxpbWl0PTEmb3JkZXI9YXNjJnBhZ2VfbWFya2VyPUElN0M5YWRjMjY0ZTgyM2E1ZjBiOGUyNDc5YmZiOGE1YmYwNDVkYzU0YjgwMDcyMWE2YmI1ZjBjMjQwMjU4MjFmNGZiJnNvcnQ9dGlja2Vy
                request_id: a47d1beb8c11b6ae897ab76cdbbf35a3
                results:
                  underlying:
                    url: https://api.polygon.io/v2/aggs/ticker/C:USDAUD/range/1/day/2003-01-01/2022-07-25
                  values:
                    - histogram: 38.3801666667
                      signal: 106.9811666667
                      timestamp: 1517562000016
                      value: 145.3613333333
                    - histogram: 41.098859136
                      signal: 102.7386283473
                      timestamp: 1517562001016
                      value: 143.8374874833
                status: OK
              schema:
                properties:
                  next_url:
                    description: If present, this value can be used to fetch the next page of data.
                    type: string
                  request_id:
                    description: A request id assigned by the server.
                    type: string
                  results:
                    properties:
                      underlying:
                        properties:
                          aggregates:
                            items:
                              properties:
                                c:
                                  description: The close price for the symbol in the given time period.
                                  format: float
                                  type: number
                                h:
                                  description: The highest price for the symbol in the given time period.
                                  format: float
                                  type: number
                                l:
                                  description: The lowest price for the symbol in the given time period.
                                  format: float
                                  type: number
                                n:
                                  description: The number of transactions in the aggregate window.
                                  type: integer
                                o:
                                  description: The open price for the symbol in the given time period.
                                  format: float
                                  type: number
                                otc:
                                  description: Whether or not this aggregate is for an OTC ticker. This field will
                                    be left off if false.
                                  type: boolean
                                t:
                                  description: The Unix Msec timestamp for the start of the aggregate window.
                                  format: float
                                  type: number
                                v:
                                  description: The trading volume of the symbol in the given time period.
                                  format: float
                                  type: number
                                vw:
                                  description: The volume weighted average price.
                                  format: float
                                  type: number
                              required:
                                - v
                                - vw
                                - o
                                - c
                                - h
                                - l
                                - t
                                - n
                              type: object
                              x-polygon-go-type:
                                name: Aggregate
                                path: github.com/polygon-io/go-lib-models/v2/globals
                            type: array
                          url:
                            description: The URL which can be used to request the underlying aggregates used
                              in this request.
                            type: string
                        type: object
                      values:
                        items:
                          properties:
                            histogram:
                              description: The indicator value for this period.
                              format: float
                              type: number
                              x-polygon-go-type:
                                name: "*float64"
                            signal:
                              description: The indicator value for this period.
                              format: float
                              type: number
                              x-polygon-go-type:
                                name: "*float64"
                            timestamp:
                              description: The Unix Msec timestamp from the last aggregate used in this
                                calculation.
                              format: int64
                              type: integer
                              x-polygon-go-type:
                                name: IMicroseconds
                                path: github.com/polygon-io/ptime
                            value:
                              description: The indicator value for this period.
                              format: float
                              type: number
                              x-polygon-go-type:
                                name: "*float64"
                          type: object
                        type: array
                    type: object
                    x-polygon-go-type:
                      name: MACDResults
                  status:
                    description: The status of this request's response.
                    type: string
                type: object
            text/csv:
              example: |
                aggregate_T,aggregate_v,aggregate_vw,aggregate_a,aggregate_o,aggregate_c,aggregate_h,aggregate_l,aggregate_t,aggregate_n,aggregate_m,aggregate_x,aggregate_g,aggregate_op,aggregate_z,aggregate_av,aggregate_s,aggregate_e,aggregate_otc,timestamp,value,signal,histogram
                C:USDAUD,687,1.5442,0,1.53763,1.5386983,1.5526022,1.537279,1664409600000,687,,0,,0,0,0,0,0,false,1664409600000,0.0160095063995076,0.016240853664654657,-0.0002313472651470569
                C:USDAUD,536,1.5459,0,1.5446162,1.5550165,1.5587,1.5364287,1664251200000,536,,0,,0,0,0,0,0,false,1664251200000,0.019060448457087098,0.015690709670065223,0.0033697387870218753
                C:USDAUD,550,1.5405,0,1.5298,1.54531,1.5526263,1.5298,1664164800000,550,,0,,0,0,0,0,0,false,1664164800000,0.017190795754692623,0.013971241529748895,0.003219554224943728
                C:USDAUD,1,1.5314,0,1.5313936,1.5313936,1.5313936,1.5313936,1663977600000,1,,0,,0,0,0,0,0,false,1663977600000,0.014349509127189686,0.010792069356789809,0.0035574397703998766
                C:USDAUD,685,1.5537,0,1.5539533,1.5371372,1.5705737,1.5316281,1664337600000,685,,0,,0,0,0,0,0,false,1664337600000,0.0169083298713677,0.016298690480941423,0.0006096393904262767
                C:USDAUD,685,1.5537,0,1.5539533,1.5371372,1.5705737,1.5316281,1664323200000,685,,0,,0,0,0,0,0,false,1664323200000,0.017968564486413374,0.016146280633334852,0.001822283853078522
                C:USDAUD,536,1.5459,0,1.5446162,1.5550165,1.5587,1.5364287,1664236800000,536,,0,,0,0,0,0,0,false,1664236800000,0.018356408747553177,0.014848274973309752,0.0035081337742434247
                C:USDAUD,550,1.5405,0,1.5298,1.54531,1.5526263,1.5298,1664150400000,550,,0,,0,0,0,0,0,false,1664150400000,0.016441299960100686,0.01316635297351296,0.0032749469865877255
                C:USDAUD,10,1.5312,0,1.5324261,1.53107,1.5326375,1.5301,1664078400000,10,,0,,0,0,0,0,0,false,1664078400000,0.015245524601038118,0.012347616226866026,0.002897908374172092
                C:USDAUD,10,1.5312,0,1.5324261,1.53107,1.5326375,1.5301,1664064000000,10,,0,,0,0,0,0,0,false,1664064000000,0.014947418239455779,0.011623139133323003,0.0033242791061327756
              schema:
                type: string
          description: Moving Average Convergence/Divergence (MACD) data for each period.
      summary: Moving Average Convergence/Divergence (MACD)
      tags:
        - fx:aggregates
      x-polygon-entitlement-data-type:
        description: Aggregate data
        name: aggregates
      x-polygon-entitlement-market-type:
        description: Forex data
        name: fx
    x-polygon-ignore: true
    parameters:
      - *a1
  /v1/indicators/macd/{indicesTicker}:
    get:
      description: Get moving average convergence/divergence (MACD) for a ticker
        symbol over a given time range.
      operationId: IndicesMACD
      parameters:
        - description: The ticker symbol for which to get MACD data.
          example: I:NDX
          in: path
          name: indicesTicker
          required: true
          schema:
            type: string
          x-polygon-go-id: Ticker
        - description: Query by timestamp. Either a date with the format YYYY-MM-DD or a
            millisecond timestamp.
          in: query
          name: timestamp
          schema:
            type: string
          x-polygon-filter-field:
            range: true
        - description: The size of the aggregate time window.
          example: day
          in: query
          name: timespan
          schema:
            default: day
            enum:
              - minute
              - hour
              - day
              - week
              - month
              - quarter
              - year
            type: string
        - description: >-
            Whether or not the aggregates used to calculate the MACD are
            adjusted for splits. By default, aggregates are adjusted.

            Set this to false to get results that are NOT adjusted for splits.
          example: true
          in: query
          name: adjusted
          schema:
            default: true
            type: boolean
        - description: The short window size used to calculate MACD data.
          example: 12
          in: query
          name: short_window
          schema:
            default: 12
            type: integer
        - description: The long window size used to calculate MACD data.
          example: 26
          in: query
          name: long_window
          schema:
            default: 26
            type: integer
        - description: The window size used to calculate the MACD signal line.
          example: 9
          in: query
          name: signal_window
          schema:
            default: 9
            type: integer
        - description: >-
            The value in the aggregate which will be used to calculate the MACD.
            i.e. 'close' will result in using close values to 

            calculate the MACD.
          example: close
          in: query
          name: series_type
          schema:
            default: close
            enum:
              - open
              - high
              - low
              - close
            type: string
        - description: Whether or not to include the aggregates used to calculate this
            indicator in the response.
          in: query
          name: expand_underlying
          schema:
            default: false
            type: boolean
        - description: The order in which to return the results, ordered by timestamp.
          example: desc
          in: query
          name: order
          schema:
            default: desc
            enum:
              - asc
              - desc
            type: string
        - description: Limit the number of results returned, default is 10 and max is 5000
          in: query
          name: limit
          schema:
            default: 10
            maximum: 5000
            type: integer
        - description: Range by timestamp.
          in: query
          name: timestamp.gte
          schema:
            type: string
        - description: Range by timestamp.
          in: query
          name: timestamp.gt
          schema:
            type: string
        - description: Range by timestamp.
          in: query
          name: timestamp.lte
          schema:
            type: string
        - description: Range by timestamp.
          in: query
          name: timestamp.lt
          schema:
            type: string
      responses:
        "200":
          content:
            application/json:
              example:
                next_url: https://api.polygon.io/v1/indicators/macd/I:NDX?cursor=YWRqdXN0ZWQ9dHJ1ZSZhcD0lN0IlMjJ2JTIyJTNBMCUyQyUyMm8lMjIlM0EwJTJDJTIyYyUyMiUzQTE1MDg0Ljk5OTM4OTgyMDAzJTJDJTIyaCUyMiUzQTAlMkMlMjJsJTIyJTNBMCUyQyUyMnQlMjIlM0ExNjg3MTUwODAwMDAwJTdEJmFzPSZleHBhbmRfdW5kZXJseWluZz1mYWxzZSZsaW1pdD0yJmxvbmdfd2luZG93PTI2Jm9yZGVyPWRlc2Mmc2VyaWVzX3R5cGU9Y2xvc2Umc2hvcnRfd2luZG93PTEyJnNpZ25hbF93aW5kb3c9OSZ0aW1lc3Bhbj1kYXkmdGltZXN0YW1wLmx0PTE2ODcyMTkyMDAwMDA
                request_id: 2eeda0be57e83cbc64cc8d1a74e84dbd
                results:
                  underlying:
                    url: https://api.polygon.io/v2/aggs/ticker/I:NDX/range/1/day/1678338000000/1687366537196?limit=121&sort=desc
                  values:
                    - histogram: -4.7646219788108795
                      signal: 220.7596784587801
                      timestamp: 1687237200000
                      value: 215.9950564799692
                    - histogram: 3.4518937661882205
                      signal: 221.9508339534828
                      timestamp: 1687219200000
                      value: 225.40272771967102
                status: OK
              schema:
                properties:
                  next_url:
                    description: If present, this value can be used to fetch the next page of data.
                    type: string
                  request_id:
                    description: A request id assigned by the server.
                    type: string
                  results:
                    properties:
                      underlying:
                        properties:
                          aggregates:
                            items:
                              properties:
                                c:
                                  description: The close price for the symbol in the given time period.
                                  format: float
                                  type: number
                                h:
                                  description: The highest price for the symbol in the given time period.
                                  format: float
                                  type: number
                                l:
                                  description: The lowest price for the symbol in the given time period.
                                  format: float
                                  type: number
                                n:
                                  description: The number of transactions in the aggregate window.
                                  type: integer
                                o:
                                  description: The open price for the symbol in the given time period.
                                  format: float
                                  type: number
                                otc:
                                  description: Whether or not this aggregate is for an OTC ticker. This field will
                                    be left off if false.
                                  type: boolean
                                t:
                                  description: The Unix Msec timestamp for the start of the aggregate window.
                                  format: float
                                  type: number
                                v:
                                  description: The trading volume of the symbol in the given time period.
                                  format: float
                                  type: number
                                vw:
                                  description: The volume weighted average price.
                                  format: float
                                  type: number
                              required:
                                - v
                                - vw
                                - o
                                - c
                                - h
                                - l
                                - t
                                - n
                              type: object
                              x-polygon-go-type:
                                name: Aggregate
                                path: github.com/polygon-io/go-lib-models/v2/globals
                            type: array
                          url:
                            description: The URL which can be used to request the underlying aggregates used
                              in this request.
                            type: string
                        type: object
                      values:
                        items:
                          properties:
                            histogram:
                              description: The indicator value for this period.
                              format: float
                              type: number
                              x-polygon-go-type:
                                name: "*float64"
                            signal:
                              description: The indicator value for this period.
                              format: float
                              type: number
                              x-polygon-go-type:
                                name: "*float64"
                            timestamp:
                              description: The Unix Msec timestamp from the last aggregate used in this
                                calculation.
                              format: int64
                              type: integer
                              x-polygon-go-type:
                                name: IMicroseconds
                                path: github.com/polygon-io/ptime
                            value:
                              description: The indicator value for this period.
                              format: float
                              type: number
                              x-polygon-go-type:
                                name: "*float64"
                          type: object
                        type: array
                    type: object
                    x-polygon-go-type:
                      name: MACDResults
                  status:
                    description: The status of this request's response.
                    type: string
                type: object
          description: Moving Average Convergence/Divergence (MACD) data for each period.
      summary: Moving Average Convergence/Divergence (MACD)
      tags:
        - indices:aggregates
      x-polygon-entitlement-allowed-limited-tickers: true
      x-polygon-entitlement-data-type:
        description: Aggregate data
        name: aggregates
      x-polygon-entitlement-market-type:
        description: Indices data
        name: indices
    x-polygon-ignore: true
    parameters:
      - *a1
  /v1/indicators/macd/{optionsTicker}:
    get:
      description: Get moving average convergence/divergence (MACD) for a ticker
        symbol over a given time range.
      operationId: OptionsMACD
      parameters:
        - description: The ticker symbol for which to get MACD data.
          example: O:SPY241220P00720000
          in: path
          name: optionsTicker
          required: true
          schema:
            type: string
          x-polygon-go-id: Ticker
        - description: Query by timestamp. Either a date with the format YYYY-MM-DD or a
            millisecond timestamp.
          in: query
          name: timestamp
          schema:
            type: string
          x-polygon-filter-field:
            range: true
        - description: The size of the aggregate time window.
          example: day
          in: query
          name: timespan
          schema:
            default: day
            enum:
              - minute
              - hour
              - day
              - week
              - month
              - quarter
              - year
            type: string
        - description: >-
            Whether or not the aggregates used to calculate the MACD are
            adjusted for splits. By default, aggregates are adjusted.

            Set this to false to get results that are NOT adjusted for splits.
          example: true
          in: query
          name: adjusted
          schema:
            default: true
            type: boolean
        - description: The short window size used to calculate MACD data.
          example: 12
          in: query
          name: short_window
          schema:
            default: 12
            type: integer
        - description: The long window size used to calculate MACD data.
          example: 26
          in: query
          name: long_window
          schema:
            default: 26
            type: integer
        - description: The window size used to calculate the MACD signal line.
          example: 9
          in: query
          name: signal_window
          schema:
            default: 9
            type: integer
        - description: >-
            The price in the aggregate which will be used to calculate the MACD.
            i.e. 'close' will result in using close prices to 

            calculate the MACD.
          example: close
          in: query
          name: series_type
          schema:
            default: close
            enum:
              - open
              - high
              - low
              - close
            type: string
        - description: Whether or not to include the aggregates used to calculate this
            indicator in the response.
          in: query
          name: expand_underlying
          schema:
            default: false
            type: boolean
        - description: The order in which to return the results, ordered by timestamp.
          example: desc
          in: query
          name: order
          schema:
            default: desc
            enum:
              - asc
              - desc
            type: string
        - description: Limit the number of results returned, default is 10 and max is 5000
          in: query
          name: limit
          schema:
            default: 10
            maximum: 5000
            type: integer
        - description: Range by timestamp.
          in: query
          name: timestamp.gte
          schema:
            type: string
        - description: Range by timestamp.
          in: query
          name: timestamp.gt
          schema:
            type: string
        - description: Range by timestamp.
          in: query
          name: timestamp.lte
          schema:
            type: string
        - description: Range by timestamp.
          in: query
          name: timestamp.lt
          schema:
            type: string
      responses:
        "200":
          content:
            application/json:
              example:
                next_url: https://api.polygon.io/v1/indicators/macd/O:SPY241220P00720000?cursor=YWN0aXZlPXRydWUmZGF0ZT0yMDIxLTA0LTI1JmxpbWl0PTEmb3JkZXI9YXNjJnBhZ2VfbWFya2VyPUElN0M5YWRjMjY0ZTgyM2E1ZjBiOGUyNDc5YmZiOGE1YmYwNDVkYzU0YjgwMDcyMWE2YmI1ZjBjMjQwMjU4MjFmNGZiJnNvcnQ9dGlja2Vy
                request_id: a47d1beb8c11b6ae897ab76cdbbf35a3
                results:
                  underlying:
                    url: https://api.polygon.io/v2/aggs/ticker/O:SPY241220P00720000/range/1/day/2003-01-01/2022-07-25
                  values:
                    - histogram: 38.3801666667
                      signal: 106.9811666667
                      timestamp: 1517562000016
                      value: 145.3613333333
                    - histogram: 41.098859136
                      signal: 102.7386283473
                      timestamp: 1517562001016
                      value: 143.8374874833
                status: OK
              schema:
                properties:
                  next_url:
                    description: If present, this value can be used to fetch the next page of data.
                    type: string
                  request_id:
                    description: A request id assigned by the server.
                    type: string
                  results:
                    properties:
                      underlying:
                        properties:
                          aggregates:
                            items:
                              properties:
                                c:
                                  description: The close price for the symbol in the given time period.
                                  format: float
                                  type: number
                                h:
                                  description: The highest price for the symbol in the given time period.
                                  format: float
                                  type: number
                                l:
                                  description: The lowest price for the symbol in the given time period.
                                  format: float
                                  type: number
                                n:
                                  description: The number of transactions in the aggregate window.
                                  type: integer
                                o:
                                  description: The open price for the symbol in the given time period.
                                  format: float
                                  type: number
                                otc:
                                  description: Whether or not this aggregate is for an OTC ticker. This field will
                                    be left off if false.
                                  type: boolean
                                t:
                                  description: The Unix Msec timestamp for the start of the aggregate window.
                                  format: float
                                  type: number
                                v:
                                  description: The trading volume of the symbol in the given time period.
                                  format: float
                                  type: number
                                vw:
                                  description: The volume weighted average price.
                                  format: float
                                  type: number
                              required:
                                - v
                                - vw
                                - o
                                - c
                                - h
                                - l
                                - t
                                - n
                              type: object
                              x-polygon-go-type:
                                name: Aggregate
                                path: github.com/polygon-io/go-lib-models/v2/globals
                            type: array
                          url:
                            description: The URL which can be used to request the underlying aggregates used
                              in this request.
                            type: string
                        type: object
                      values:
                        items:
                          properties:
                            histogram:
                              description: The indicator value for this period.
                              format: float
                              type: number
                              x-polygon-go-type:
                                name: "*float64"
                            signal:
                              description: The indicator value for this period.
                              format: float
                              type: number
                              x-polygon-go-type:
                                name: "*float64"
                            timestamp:
                              description: The Unix Msec timestamp from the last aggregate used in this
                                calculation.
                              format: int64
                              type: integer
                              x-polygon-go-type:
                                name: IMicroseconds
                                path: github.com/polygon-io/ptime
                            value:
                              description: The indicator value for this period.
                              format: float
                              type: number
                              x-polygon-go-type:
                                name: "*float64"
                          type: object
                        type: array
                    type: object
                    x-polygon-go-type:
                      name: MACDResults
                  status:
                    description: The status of this request's response.
                    type: string
                type: object
            text/csv:
              example: |
                aggregate_T,aggregate_v,aggregate_vw,aggregate_a,aggregate_o,aggregate_c,aggregate_h,aggregate_l,aggregate_t,aggregate_n,aggregate_m,aggregate_x,aggregate_g,aggregate_op,aggregate_z,aggregate_av,aggregate_s,aggregate_e,aggregate_otc,timestamp,value,signal,histogram
                O:SPY241220P00720000,3,277.8267,0,277.82,277.83,277.83,277.82,1649649600000,2,,0,,0,0,0,0,0,false,1649649600000,-0.05105556065990413,3.5771695836806834,-3.6282251443405875
                O:SPY241220P00720000,1,299.97,0,299.97,299.97,299.97,299.97,1649304000000,1,,0,,0,0,0,0,0,false,1649304000000,4.047960862047148,5.247666286053219,-1.199705424006071
                O:SPY241220P00720000,1,299.97,0,299.97,299.97,299.97,299.97,1648785600000,1,,0,,0,0,0,0,0,false,1648785600000,5.255380647906861,6.466477305754766,-1.2110966578479045
                O:SPY241220P00720000,1,299.97,0,299.97,299.97,299.97,299.97,1648699200000,1,,0,,0,0,0,0,0,false,1648699200000,5.591072756938104,6.769251470216741,-1.178178713278637
                O:SPY241220P00720000,2,270.49,0,270.49,270.49,270.49,270.49,1649390400000,1,,0,,0,0,0,0,0,false,1649390400000,1.4304642046162712,4.48422586976583,-3.053761665149559
                O:SPY241220P00720000,1,299.97,0,299.97,299.97,299.97,299.97,1649217600000,1,,0,,0,0,0,0,0,false,1649217600000,4.32835898317461,5.547592642054737,-1.2192336588801274
                O:SPY241220P00720000,1,299.97,0,299.97,299.97,299.97,299.97,1649131200000,1,,0,,0,0,0,0,0,false,1649131200000,4.623290999840208,5.852401056774768,-1.2291100569345605
                O:SPY241220P00720000,1,299.97,0,299.97,299.97,299.97,299.97,1649044800000,1,,0,,0,0,0,0,0,false,1649044800000,4.932483632022979,6.159678571008409,-1.2271949389854298
                O:SPY241220P00720000,1,299.97,0,299.97,299.97,299.97,299.97,1648612800000,1,,0,,0,0,0,0,0,false,1648612800000,5.93821326327344,7.063796148536399,-1.1255828852629595
                O:SPY241220P00720000,1,299.97,0,299.97,299.97,299.97,299.97,1648526400000,1,,0,,0,0,0,0,0,false,1648526400000,6.294916771166584,7.345191869852139,-1.050275098685555
              schema:
                type: string
          description: Moving Average Convergence/Divergence (MACD) data for each period.
      summary: Moving Average Convergence/Divergence (MACD)
      tags:
        - options:aggregates
      x-polygon-entitlement-data-type:
        description: Aggregate data
        name: aggregates
      x-polygon-entitlement-market-type:
        description: Options data
        name: options
    x-polygon-ignore: true
    parameters:
      - *a1
  /v1/indicators/macd/{stockTicker}:
    get:
      description: Get moving average convergence/divergence (MACD) data for a ticker
        symbol over a given time range.
      operationId: MACD
      parameters:
        - description: Specify a case-sensitive ticker symbol for which to get moving
            average convergence/divergence (MACD) data. For example, AAPL
            represents Apple Inc.
          example: AAPL
          in: path
          name: stockTicker
          required: true
          schema:
            type: string
          x-polygon-go-id: Ticker
        - description: Query by timestamp. Either a date with the format YYYY-MM-DD or a
            millisecond timestamp.
          in: query
          name: timestamp
          schema:
            type: string
          x-polygon-filter-field:
            range: true
        - description: The size of the aggregate time window.
          example: day
          in: query
          name: timespan
          schema:
            default: day
            enum:
              - minute
              - hour
              - day
              - week
              - month
              - quarter
              - year
            type: string
        - description: Whether or not the aggregates used to calculate the MACD are
            adjusted for splits. By default, aggregates are adjusted. Set this
            to false to get results that are NOT adjusted for splits.
          example: true
          in: query
          name: adjusted
          schema:
            default: true
            type: boolean
        - description: The short window size used to calculate MACD data.
          example: 12
          in: query
          name: short_window
          schema:
            default: 12
            type: integer
        - description: The long window size used to calculate MACD data.
          example: 26
          in: query
          name: long_window
          schema:
            default: 26
            type: integer
        - description: The window size used to calculate the MACD signal line.
          example: 9
          in: query
          name: signal_window
          schema:
            default: 9
            type: integer
        - description: >-
            The price in the aggregate which will be used to calculate the MACD.
            i.e. 'close' will result in using close prices to 

            calculate the MACD.
          example: close
          in: query
          name: series_type
          schema:
            default: close
            enum:
              - open
              - high
              - low
              - close
            type: string
        - description: Whether or not to include the aggregates used to calculate this
            indicator in the response.
          in: query
          name: expand_underlying
          schema:
            default: false
            type: boolean
        - description: The order in which to return the results, ordered by timestamp.
          example: desc
          in: query
          name: order
          schema:
            default: desc
            enum:
              - asc
              - desc
            type: string
        - description: Limit the number of results returned, default is 10 and max is 5000
          in: query
          name: limit
          schema:
            default: 10
            maximum: 5000
            type: integer
        - description: Range by timestamp.
          in: query
          name: timestamp.gte
          schema:
            type: string
        - description: Range by timestamp.
          in: query
          name: timestamp.gt
          schema:
            type: string
        - description: Range by timestamp.
          in: query
          name: timestamp.lte
          schema:
            type: string
        - description: Range by timestamp.
          in: query
          name: timestamp.lt
          schema:
            type: string
      responses:
        "200":
          content:
            application/json:
              example:
                next_url: https://api.polygon.io/v1/indicators/macd/AAPL?cursor=YWN0aXZlPXRydWUmZGF0ZT0yMDIxLTA0LTI1JmxpbWl0PTEmb3JkZXI9YXNjJnBhZ2VfbWFya2VyPUElN0M5YWRjMjY0ZTgyM2E1ZjBiOGUyNDc5YmZiOGE1YmYwNDVkYzU0YjgwMDcyMWE2YmI1ZjBjMjQwMjU4MjFmNGZiJnNvcnQ9dGlja2Vy
                request_id: a47d1beb8c11b6ae897ab76cdbbf35a3
                results:
                  underlying:
                    url: https://api.polygon.io/v2/aggs/ticker/AAPL/range/1/day/2003-01-01/2022-07-25
                  values:
                    - histogram: 38.3801666667
                      signal: 106.9811666667
                      timestamp: 1517562000016
                      value: 145.3613333333
                    - histogram: 41.098859136
                      signal: 102.7386283473
                      timestamp: 1517562001016
                      value: 143.8374874833
                status: OK
              schema:
                properties:
                  next_url:
                    description: If present, this value can be used to fetch the next page of data.
                    type: string
                  request_id:
                    description: A request id assigned by the server.
                    type: string
                  results:
                    properties:
                      underlying:
                        properties:
                          aggregates:
                            items:
                              properties:
                                c:
                                  description: The close price for the symbol in the given time period.
                                  format: float
                                  type: number
                                h:
                                  description: The highest price for the symbol in the given time period.
                                  format: float
                                  type: number
                                l:
                                  description: The lowest price for the symbol in the given time period.
                                  format: float
                                  type: number
                                n:
                                  description: The number of transactions in the aggregate window.
                                  type: integer
                                o:
                                  description: The open price for the symbol in the given time period.
                                  format: float
                                  type: number
                                otc:
                                  description: Whether or not this aggregate is for an OTC ticker. This field will
                                    be left off if false.
                                  type: boolean
                                t:
                                  description: The Unix Msec timestamp for the start of the aggregate window.
                                  format: float
                                  type: number
                                v:
                                  description: The trading volume of the symbol in the given time period.
                                  format: float
                                  type: number
                                vw:
                                  description: The volume weighted average price.
                                  format: float
                                  type: number
                              required:
                                - v
                                - vw
                                - o
                                - c
                                - h
                                - l
                                - t
                                - n
                              type: object
                              x-polygon-go-type:
                                name: Aggregate
                                path: github.com/polygon-io/go-lib-models/v2/globals
                            type: array
                          url:
                            description: The URL which can be used to request the underlying aggregates used
                              in this request.
                            type: string
                        type: object
                      values:
                        items:
                          properties:
                            histogram:
                              description: The indicator value for this period.
                              format: float
                              type: number
                              x-polygon-go-type:
                                name: "*float64"
                            signal:
                              description: The indicator value for this period.
                              format: float
                              type: number
                              x-polygon-go-type:
                                name: "*float64"
                            timestamp:
                              description: The Unix Msec timestamp from the last aggregate used in this
                                calculation.
                              format: int64
                              type: integer
                              x-polygon-go-type:
                                name: IMicroseconds
                                path: github.com/polygon-io/ptime
                            value:
                              description: The indicator value for this period.
                              format: float
                              type: number
                              x-polygon-go-type:
                                name: "*float64"
                          type: object
                        type: array
                    type: object
                    x-polygon-go-type:
                      name: MACDResults
                  status:
                    description: The status of this request's response.
                    type: string
                type: object
            text/csv:
              example: |
                aggregate_T,aggregate_v,aggregate_vw,aggregate_a,aggregate_o,aggregate_c,aggregate_h,aggregate_l,aggregate_t,aggregate_n,aggregate_m,aggregate_x,aggregate_g,aggregate_op,aggregate_z,aggregate_av,aggregate_s,aggregate_e,aggregate_otc,timestamp,value,signal,histogram
                AAPL,1.27842348E+08,142.9013,0,146.1,142.48,146.72,140.68,1664424000000,1061605,,0,,0,0,0,0,0,false,1664424000000,-5.413804946923619,-3.8291158739479005,-1.5846890729757188
                AAPL,8.4461761E+07,152.1354,0,152.74,151.76,154.72,149.945,1664251200000,683781,,0,,0,0,0,0,0,false,1664251200000,-4.63165683097526,-3.098305244715017,-1.5333515862602427
                AAPL,9.3339409E+07,151.5222,0,149.66,150.77,153.7701,149.64,1664164800000,747666,,0,,0,0,0,0,0,false,1664164800000,-4.581291216131007,-2.7149673481499565,-1.86632386798105
                AAPL,9.3308449E+07,156.1877,0,157.34,153.72,158.61,153.6,1663732800000,712645,,0,,0,0,0,0,0,false,1663732800000,-3.6311474313744156,-1.1648824074663984,-2.4662650239080173
                AAPL,1.64879031E+08,150.2387,0,151.21,150.7,151.35,148.37,1663300800000,850358,,0,,0,0,0,0,0,false,1663300800000,-2.533545758578896,0.9308104167079131,-3.464356175286809
                AAPL,1.46755122E+08,147.599,0,147.64,149.84,150.6414,144.84,1664337600000,1140818,,0,,0,0,0,0,0,false,1664337600000,-4.771497049659786,-3.432943605703971,-1.3385534439558149
                AAPL,9.6031641E+07,150.0222,0,151.19,150.43,151.47,148.56,1663905600000,766888,,0,,0,0,0,0,0,false,1663905600000,-4.349569413677017,-2.2483863811546936,-2.1011830325223233
                AAPL,8.6651514E+07,152.5709,0,152.38,152.74,154.47,150.91,1663819200000,686866,,0,,0,0,0,0,0,false,1663819200000,-3.9559234852549707,-1.7230906230241128,-2.232832862230858
                AAPL,1.07691097E+08,156.1317,0,153.4,156.9,158.08,153.08,1663646400000,792177,,0,,0,0,0,0,0,false,1663646400000,-3.2635802145105117,-0.548316151489394,-2.7152640630211176
                AAPL,8.1599225E+07,152.5505,0,149.31,154.48,154.56,149.1,1663560000000,671961,,0,,0,0,0,0,0,false,1663560000000,-3.070742345502225,0.13049986426588545,-3.2012422097681106
              schema:
                type: string
          description: Moving Average Convergence/Divergence (MACD) data for each period.
      summary: Moving Average Convergence/Divergence (MACD)
      tags:
        - stocks:aggregates
      x-polygon-entitlement-data-type:
        description: Aggregate data
        name: aggregates
      x-polygon-entitlement-market-type:
        description: Stocks data
        name: stocks
    parameters:
      - *a1
  /v1/indicators/rsi/{cryptoTicker}:
    get:
      description: Get the relative strength index (RSI) for a ticker symbol over a
        given time range.
      operationId: CryptoRSI
      parameters:
        - description: The ticker symbol for which to get relative strength index (RSI)
            data.
          example: X:BTCUSD
          in: path
          name: cryptoTicker
          required: true
          schema:
            type: string
          x-polygon-go-id: Ticker
        - description: Query by timestamp. Either a date with the format YYYY-MM-DD or a
            millisecond timestamp.
          in: query
          name: timestamp
          schema:
            type: string
          x-polygon-filter-field:
            range: true
        - description: The size of the aggregate time window.
          example: day
          in: query
          name: timespan
          schema:
            default: day
            enum:
              - minute
              - hour
              - day
              - week
              - month
              - quarter
              - year
            type: string
        - description: The window size used to calculate the relative strength index
            (RSI). i.e. a window size of 10 with daily aggregates would result
            in a 10 day moving average.
          example: 14
          in: query
          name: window
          schema:
            default: 14
            type: integer
        - description: >-
            The price in the aggregate which will be used to calculate the
            relative strength index. i.e. 'close' will result in using close
            prices to 

            calculate the relative strength index (RSI).
          example: close
          in: query
          name: series_type
          schema:
            default: close
            enum:
              - open
              - high
              - low
              - close
            type: string
        - description: Whether or not to include the aggregates used to calculate this
            indicator in the response.
          in: query
          name: expand_underlying
          schema:
            default: false
            type: boolean
        - description: The order in which to return the results, ordered by timestamp.
          example: desc
          in: query
          name: order
          schema:
            default: desc
            enum:
              - asc
              - desc
            type: string
        - description: Limit the number of results returned, default is 10 and max is 5000
          in: query
          name: limit
          schema:
            default: 10
            maximum: 5000
            type: integer
        - description: Range by timestamp.
          in: query
          name: timestamp.gte
          schema:
            type: string
        - description: Range by timestamp.
          in: query
          name: timestamp.gt
          schema:
            type: string
        - description: Range by timestamp.
          in: query
          name: timestamp.lte
          schema:
            type: string
        - description: Range by timestamp.
          in: query
          name: timestamp.lt
          schema:
            type: string
      responses:
        "200":
          content:
            application/json:
              example:
                next_url: https://api.polygon.io/v1/indicators/rsi/X:BTCUSD?cursor=YWN0aXZlPXRydWUmZGF0ZT0yMDIxLTA0LTI1JmxpbWl0PTEmb3JkZXI9YXNjJnBhZ2VfbWFya2VyPUElN0M5YWRjMjY0ZTgyM2E1ZjBiOGUyNDc5YmZiOGE1YmYwNDVkYzU0YjgwMDcyMWE2YmI1ZjBjMjQwMjU4MjFmNGZiJnNvcnQ9dGlja2Vy
                request_id: a47d1beb8c11b6ae897ab76cdbbf35a3
                results:
                  underlying:
                    url: https://api.polygon.io/v2/aggs/ticker/X:BTCUSD/range/1/day/2003-01-01/2022-07-25
                  values:
                    - timestamp: 1517562000016
                      value: 82.19
                status: OK
              schema:
                properties:
                  next_url:
                    description: If present, this value can be used to fetch the next page of data.
                    type: string
                  request_id:
                    description: A request id assigned by the server.
                    type: string
                  results:
                    properties:
                      underlying:
                        properties:
                          aggregates:
                            items:
                              properties:
                                c:
                                  description: The close price for the symbol in the given time period.
                                  format: float
                                  type: number
                                h:
                                  description: The highest price for the symbol in the given time period.
                                  format: float
                                  type: number
                                l:
                                  description: The lowest price for the symbol in the given time period.
                                  format: float
                                  type: number
                                n:
                                  description: The number of transactions in the aggregate window.
                                  type: integer
                                o:
                                  description: The open price for the symbol in the given time period.
                                  format: float
                                  type: number
                                otc:
                                  description: Whether or not this aggregate is for an OTC ticker. This field will
                                    be left off if false.
                                  type: boolean
                                t:
                                  description: The Unix Msec timestamp for the start of the aggregate window.
                                  format: float
                                  type: number
                                v:
                                  description: The trading volume of the symbol in the given time period.
                                  format: float
                                  type: number
                                vw:
                                  description: The volume weighted average price.
                                  format: float
                                  type: number
                              required:
                                - v
                                - vw
                                - o
                                - c
                                - h
                                - l
                                - t
                                - n
                              type: object
                              x-polygon-go-type:
                                name: Aggregate
                                path: github.com/polygon-io/go-lib-models/v2/globals
                            type: array
                          url:
                            description: The URL which can be used to request the underlying aggregates used
                              in this request.
                            type: string
                        type: object
                      values:
                        items:
                          properties:
                            timestamp:
                              description: The Unix Msec timestamp from the last aggregate used in this
                                calculation.
                              format: int64
                              type: integer
                              x-polygon-go-type:
                                name: IMicroseconds
                                path: github.com/polygon-io/ptime
                            value:
                              description: The indicator value for this period.
                              format: float
                              type: number
                              x-polygon-go-type:
                                name: "*float64"
                          type: object
                        type: array
                    type: object
                    x-polygon-go-type:
                      name: RSIResults
                  status:
                    description: The status of this request's response.
                    type: string
                type: object
            text/csv:
              example: |
                aggregate_T,aggregate_v,aggregate_vw,aggregate_a,aggregate_o,aggregate_c,aggregate_h,aggregate_l,aggregate_t,aggregate_n,aggregate_m,aggregate_x,aggregate_g,aggregate_op,aggregate_z,aggregate_av,aggregate_s,aggregate_e,aggregate_otc,timestamp,value
                X:BTCUSD,15457.24362826,19317.486,0,19529.04,19475.84,19651.2772302,18846.67,1664409600000,191936,,0,,0,0,0,0,0,false,1664409600000,52.040915721136884
                X:BTCUSD,17479.00092209,19776.6697,0,19228.2,19141.78,20372.17374536,18821.55,1664251200000,183075,,0,,0,0,0,0,0,false,1664251200000,44.813590401722564
                X:BTCUSD,17479.00092209,19776.6697,0,19228.2,19141.78,20372.17374536,18821.55,1664236800000,183075,,0,,0,0,0,0,0,false,1664236800000,44.813590401722564
                X:BTCUSD,55188.33773657,18970.3019,0,18816.66899332,19165.98,19333,18690,1664164800000,297389,,0,,0,0,0,0,0,false,1664164800000,45.22751170711286
                X:BTCUSD,55188.33773657,18970.3019,0,18816.66899332,19165.98,19333,18690,1664150400000,297389,,0,,0,0,0,0,0,false,1664150400000,45.22751170711286
                X:BTCUSD,4798.38258637,18914.0766,0,18928,18784.41,19184.3,18636,1664078400000,78936,,0,,0,0,0,0,0,false,1664078400000,37.361825384231004
                X:BTCUSD,4798.38258637,18914.0766,0,18928,18784.41,19184.3,18636,1664064000000,78936,,0,,0,0,0,0,0,false,1664064000000,37.361825384231004
                X:BTCUSD,23180.93663313,19103.9189,0,19090,19416.20352522,19791,18461,1664337600000,225076,,0,,0,0,0,0,0,false,1664337600000,50.74235333598462
                X:BTCUSD,23180.93663313,19103.9189,0,19090,19416.20352522,19791,18461,1664323200000,225076,,0,,0,0,0,0,0,false,1664323200000,50.74235333598462
                X:BTCUSD,2868.09828007,19069.8521,0,19210.31,18925.87,19400,18805.1,1663992000000,58721,,0,,0,0,0,0,0,false,1663992000000,39.159457782344376
              schema:
                type: string
          description: Relative strength index data for each period.
      summary: Relative Strength Index (RSI)
      tags:
        - crpyto:aggregates
      x-polygon-entitlement-data-type:
        description: Aggregate data
        name: aggregates
      x-polygon-entitlement-market-type:
        description: Crypto data
        name: crypto
    x-polygon-ignore: true
    parameters:
      - *a1
  /v1/indicators/rsi/{fxTicker}:
    get:
      description: Get the relative strength index (RSI) for a ticker symbol over a
        given time range.
      operationId: ForexRSI
      parameters:
        - description: The ticker symbol for which to get relative strength index (RSI)
            data.
          example: C:EURUSD
          in: path
          name: fxTicker
          required: true
          schema:
            type: string
          x-polygon-go-id: Ticker
        - description: Query by timestamp. Either a date with the format YYYY-MM-DD or a
            millisecond timestamp.
          in: query
          name: timestamp
          schema:
            type: string
          x-polygon-filter-field:
            range: true
        - description: The size of the aggregate time window.
          example: day
          in: query
          name: timespan
          schema:
            default: day
            enum:
              - minute
              - hour
              - day
              - week
              - month
              - quarter
              - year
            type: string
        - description: >-
            Whether or not the aggregates used to calculate the relative
            strength index are adjusted for splits. By default, aggregates are
            adjusted.

            Set this to false to get results that are NOT adjusted for splits.
          example: true
          in: query
          name: adjusted
          schema:
            default: true
            type: boolean
        - description: The window size used to calculate the relative strength index (RSI).
          example: 14
          in: query
          name: window
          schema:
            default: 14
            type: integer
        - description: >-
            The price in the aggregate which will be used to calculate the
            relative strength index. i.e. 'close' will result in using close
            prices to 

            calculate the relative strength index (RSI).
          example: close
          in: query
          name: series_type
          schema:
            default: close
            enum:
              - open
              - high
              - low
              - close
            type: string
        - description: Whether or not to include the aggregates used to calculate this
            indicator in the response.
          in: query
          name: expand_underlying
          schema:
            default: false
            type: boolean
        - description: The order in which to return the results, ordered by timestamp.
          example: desc
          in: query
          name: order
          schema:
            default: desc
            enum:
              - asc
              - desc
            type: string
        - description: Limit the number of results returned, default is 10 and max is 5000
          in: query
          name: limit
          schema:
            default: 10
            maximum: 5000
            type: integer
        - description: Range by timestamp.
          in: query
          name: timestamp.gte
          schema:
            type: string
        - description: Range by timestamp.
          in: query
          name: timestamp.gt
          schema:
            type: string
        - description: Range by timestamp.
          in: query
          name: timestamp.lte
          schema:
            type: string
        - description: Range by timestamp.
          in: query
          name: timestamp.lt
          schema:
            type: string
      responses:
        "200":
          content:
            application/json:
              example:
                next_url: https://api.polygon.io/v1/indicators/rsi/C:USDAUD?cursor=YWN0aXZlPXRydWUmZGF0ZT0yMDIxLTA0LTI1JmxpbWl0PTEmb3JkZXI9YXNjJnBhZ2VfbWFya2VyPUElN0M5YWRjMjY0ZTgyM2E1ZjBiOGUyNDc5YmZiOGE1YmYwNDVkYzU0YjgwMDcyMWE2YmI1ZjBjMjQwMjU4MjFmNGZiJnNvcnQ9dGlja2Vy
                request_id: a47d1beb8c11b6ae897ab76cdbbf35a3
                results:
                  underlying:
                    url: https://api.polygon.io/v2/aggs/ticker/C:USDAUD/range/1/day/2003-01-01/2022-07-25
                  values:
                    - timestamp: 1517562000016
                      value: 82.19
                status: OK
              schema:
                properties:
                  next_url:
                    description: If present, this value can be used to fetch the next page of data.
                    type: string
                  request_id:
                    description: A request id assigned by the server.
                    type: string
                  results:
                    properties:
                      underlying:
                        properties:
                          aggregates:
                            items:
                              properties:
                                c:
                                  description: The close price for the symbol in the given time period.
                                  format: float
                                  type: number
                                h:
                                  description: The highest price for the symbol in the given time period.
                                  format: float
                                  type: number
                                l:
                                  description: The lowest price for the symbol in the given time period.
                                  format: float
                                  type: number
                                n:
                                  description: The number of transactions in the aggregate window.
                                  type: integer
                                o:
                                  description: The open price for the symbol in the given time period.
                                  format: float
                                  type: number
                                otc:
                                  description: Whether or not this aggregate is for an OTC ticker. This field will
                                    be left off if false.
                                  type: boolean
                                t:
                                  description: The Unix Msec timestamp for the start of the aggregate window.
                                  format: float
                                  type: number
                                v:
                                  description: The trading volume of the symbol in the given time period.
                                  format: float
                                  type: number
                                vw:
                                  description: The volume weighted average price.
                                  format: float
                                  type: number
                              required:
                                - v
                                - vw
                                - o
                                - c
                                - h
                                - l
                                - t
                                - n
                              type: object
                              x-polygon-go-type:
                                name: Aggregate
                                path: github.com/polygon-io/go-lib-models/v2/globals
                            type: array
                          url:
                            description: The URL which can be used to request the underlying aggregates used
                              in this request.
                            type: string
                        type: object
                      values:
                        items:
                          properties:
                            timestamp:
                              description: The Unix Msec timestamp from the last aggregate used in this
                                calculation.
                              format: int64
                              type: integer
                              x-polygon-go-type:
                                name: IMicroseconds
                                path: github.com/polygon-io/ptime
                            value:
                              description: The indicator value for this period.
                              format: float
                              type: number
                              x-polygon-go-type:
                                name: "*float64"
                          type: object
                        type: array
                    type: object
                    x-polygon-go-type:
                      name: RSIResults
                  status:
                    description: The status of this request's response.
                    type: string
                type: object
            text/csv:
              example: |
                aggregate_T,aggregate_v,aggregate_vw,aggregate_a,aggregate_o,aggregate_c,aggregate_h,aggregate_l,aggregate_t,aggregate_n,aggregate_m,aggregate_x,aggregate_g,aggregate_op,aggregate_z,aggregate_av,aggregate_s,aggregate_e,aggregate_otc,timestamp,value
                C:USDAUD,686,1.5442,0,1.53763,1.5404,1.5526022,1.537279,1664409600000,686,,0,,0,0,0,0,0,false,1664409600000,65.97230488287764
                C:USDAUD,550,1.5405,0,1.5298,1.54531,1.5526263,1.5298,1664164800000,550,,0,,0,0,0,0,0,false,1664164800000,79.3273623194404
                C:USDAUD,550,1.5405,0,1.5298,1.54531,1.5526263,1.5298,1664150400000,550,,0,,0,0,0,0,0,false,1664150400000,79.32736231944038
                C:USDAUD,10,1.5312,0,1.5324261,1.53107,1.5326375,1.5301,1664064000000,10,,0,,0,0,0,0,0,false,1664064000000,74.64770184023104
                C:USDAUD,685,1.5537,0,1.5539533,1.5371372,1.5705737,1.5316281,1664337600000,685,,0,,0,0,0,0,0,false,1664337600000,64.43214811875563
                C:USDAUD,685,1.5537,0,1.5539533,1.5371372,1.5705737,1.5316281,1664323200000,685,,0,,0,0,0,0,0,false,1664323200000,64.43214811875563
                C:USDAUD,536,1.5459,0,1.5446162,1.5550165,1.5587,1.5364287,1664251200000,536,,0,,0,0,0,0,0,false,1664251200000,81.95981214984681
                C:USDAUD,536,1.5459,0,1.5446162,1.5550165,1.5587,1.5364287,1664236800000,536,,0,,0,0,0,0,0,false,1664236800000,81.95981214984683
                C:USDAUD,10,1.5312,0,1.5324261,1.53107,1.5326375,1.5301,1664078400000,10,,0,,0,0,0,0,0,false,1664078400000,74.64770184023104
                C:USDAUD,1,1.5314,0,1.5313936,1.5313936,1.5313936,1.5313936,1663977600000,1,,0,,0,0,0,0,0,false,1663977600000,74.98028072374902
              schema:
                type: string
          description: Relative strength index data for each period.
      summary: Relative Strength Index (RSI)
      tags:
        - fx:aggregates
      x-polygon-entitlement-data-type:
        description: Aggregate data
        name: aggregates
      x-polygon-entitlement-market-type:
        description: Forex data
        name: fx
    x-polygon-ignore: true
    parameters:
      - *a1
  /v1/indicators/rsi/{indicesTicker}:
    get:
      description: Get the relative strength index (RSI) for a ticker symbol over a
        given time range.
      operationId: IndicesRSI
      parameters:
        - description: The ticker symbol for which to get relative strength index (RSI)
            data.
          example: I:NDX
          in: path
          name: indicesTicker
          required: true
          schema:
            type: string
          x-polygon-go-id: Ticker
        - description: Query by timestamp. Either a date with the format YYYY-MM-DD or a
            millisecond timestamp.
          in: query
          name: timestamp
          schema:
            type: string
          x-polygon-filter-field:
            range: true
        - description: The size of the aggregate time window.
          example: day
          in: query
          name: timespan
          schema:
            default: day
            enum:
              - minute
              - hour
              - day
              - week
              - month
              - quarter
              - year
            type: string
        - description: >-
            Whether or not the aggregates used to calculate the relative
            strength index are adjusted for splits. By default, aggregates are
            adjusted.

            Set this to false to get results that are NOT adjusted for splits.
          example: true
          in: query
          name: adjusted
          schema:
            default: true
            type: boolean
        - description: The window size used to calculate the relative strength index (RSI).
          example: 14
          in: query
          name: window
          schema:
            default: 14
            type: integer
        - description: >-
            The value in the aggregate which will be used to calculate the
            relative strength index. i.e. 'close' will result in using close
            values to 

            calculate the relative strength index (RSI).
          example: close
          in: query
          name: series_type
          schema:
            default: close
            enum:
              - open
              - high
              - low
              - close
            type: string
        - description: Whether or not to include the aggregates used to calculate this
            indicator in the response.
          in: query
          name: expand_underlying
          schema:
            default: false
            type: boolean
        - description: The order in which to return the results, ordered by timestamp.
          example: desc
          in: query
          name: order
          schema:
            default: desc
            enum:
              - asc
              - desc
            type: string
        - description: Limit the number of results returned, default is 10 and max is 5000
          in: query
          name: limit
          schema:
            default: 10
            maximum: 5000
            type: integer
        - description: Range by timestamp.
          in: query
          name: timestamp.gte
          schema:
            type: string
        - description: Range by timestamp.
          in: query
          name: timestamp.gt
          schema:
            type: string
        - description: Range by timestamp.
          in: query
          name: timestamp.lte
          schema:
            type: string
        - description: Range by timestamp.
          in: query
          name: timestamp.lt
          schema:
            type: string
      responses:
        "200":
          content:
            application/json:
              example:
                next_url: https://api.polygon.io/v1/indicators/rsi/I:NDX?cursor=YWRqdXN0ZWQ9dHJ1ZSZhcD0lN0IlMjJ2JTIyJTNBMCUyQyUyMm8lMjIlM0EwJTJDJTIyYyUyMiUzQTE1MDg0Ljk5OTM4OTgyMDAzJTJDJTIyaCUyMiUzQTAlMkMlMjJsJTIyJTNBMCUyQyUyMnQlMjIlM0ExNjg3MjE5MjAwMDAwJTdEJmFzPSZleHBhbmRfdW5kZXJseWluZz1mYWxzZSZsaW1pdD0xJm9yZGVyPWRlc2Mmc2VyaWVzX3R5cGU9Y2xvc2UmdGltZXNwYW49ZGF5JnRpbWVzdGFtcC5sdD0xNjg3MjM3MjAwMDAwJndpbmRvdz0xNA
                request_id: 28a8417f521f98e1d08f6ed7d1fbcad3
                results:
                  underlying:
                    url: https://api.polygon.io/v2/aggs/ticker/I:NDX/range/1/day/1678338000000/1687366658253?limit=66&sort=desc
                  values:
                    - timestamp: 1687237200000
                      value: 73.98019439047955
                status: OK
              schema:
                properties:
                  next_url:
                    description: If present, this value can be used to fetch the next page of data.
                    type: string
                  request_id:
                    description: A request id assigned by the server.
                    type: string
                  results:
                    properties:
                      underlying:
                        properties:
                          aggregates:
                            items:
                              properties:
                                c:
                                  description: The close price for the symbol in the given time period.
                                  format: float
                                  type: number
                                h:
                                  description: The highest price for the symbol in the given time period.
                                  format: float
                                  type: number
                                l:
                                  description: The lowest price for the symbol in the given time period.
                                  format: float
                                  type: number
                                n:
                                  description: The number of transactions in the aggregate window.
                                  type: integer
                                o:
                                  description: The open price for the symbol in the given time period.
                                  format: float
                                  type: number
                                otc:
                                  description: Whether or not this aggregate is for an OTC ticker. This field will
                                    be left off if false.
                                  type: boolean
                                t:
                                  description: The Unix Msec timestamp for the start of the aggregate window.
                                  format: float
                                  type: number
                                v:
                                  description: The trading volume of the symbol in the given time period.
                                  format: float
                                  type: number
                                vw:
                                  description: The volume weighted average price.
                                  format: float
                                  type: number
                              required:
                                - v
                                - vw
                                - o
                                - c
                                - h
                                - l
                                - t
                                - n
                              type: object
                              x-polygon-go-type:
                                name: Aggregate
                                path: github.com/polygon-io/go-lib-models/v2/globals
                            type: array
                          url:
                            description: The URL which can be used to request the underlying aggregates used
                              in this request.
                            type: string
                        type: object
                      values:
                        items:
                          properties:
                            timestamp:
                              description: The Unix Msec timestamp from the last aggregate used in this
                                calculation.
                              format: int64
                              type: integer
                              x-polygon-go-type:
                                name: IMicroseconds
                                path: github.com/polygon-io/ptime
                            value:
                              description: The indicator value for this period.
                              format: float
                              type: number
                              x-polygon-go-type:
                                name: "*float64"
                          type: object
                        type: array
                    type: object
                    x-polygon-go-type:
                      name: RSIResults
                  status:
                    description: The status of this request's response.
                    type: string
                type: object
          description: Relative Strength Index (RSI) data for each period.
      summary: Relative Strength Index (RSI)
      tags:
        - indices:aggregates
      x-polygon-entitlement-allowed-limited-tickers: true
      x-polygon-entitlement-data-type:
        description: Aggregate data
        name: aggregates
      x-polygon-entitlement-market-type:
        description: Indices data
        name: indices
    x-polygon-ignore: true
    parameters:
      - *a1
  /v1/indicators/rsi/{optionsTicker}:
    get:
      description: Get the relative strength index (RSI) for a ticker symbol over a
        given time range.
      operationId: OptionsRSI
      parameters:
        - description: The ticker symbol for which to get relative strength index (RSI)
            data.
          example: O:SPY241220P00720000
          in: path
          name: optionsTicker
          required: true
          schema:
            type: string
          x-polygon-go-id: Ticker
        - description: Query by timestamp. Either a date with the format YYYY-MM-DD or a
            millisecond timestamp.
          in: query
          name: timestamp
          schema:
            type: string
          x-polygon-filter-field:
            range: true
        - description: The size of the aggregate time window.
          example: day
          in: query
          name: timespan
          schema:
            default: day
            enum:
              - minute
              - hour
              - day
              - week
              - month
              - quarter
              - year
            type: string
        - description: >-
            Whether or not the aggregates used to calculate the relative
            strength index are adjusted for splits. By default, aggregates are
            adjusted.

            Set this to false to get results that are NOT adjusted for splits.
          example: true
          in: query
          name: adjusted
          schema:
            default: true
            type: boolean
        - description: The window size used to calculate the relative strength index (RSI).
          example: 14
          in: query
          name: window
          schema:
            default: 14
            type: integer
        - description: >-
            The price in the aggregate which will be used to calculate the
            relative strength index. i.e. 'close' will result in using close
            prices to 

            calculate the relative strength index (RSI).
          example: close
          in: query
          name: series_type
          schema:
            default: close
            enum:
              - open
              - high
              - low
              - close
            type: string
        - description: Whether or not to include the aggregates used to calculate this
            indicator in the response.
          in: query
          name: expand_underlying
          schema:
            default: false
            type: boolean
        - description: The order in which to return the results, ordered by timestamp.
          example: desc
          in: query
          name: order
          schema:
            default: desc
            enum:
              - asc
              - desc
            type: string
        - description: Limit the number of results returned, default is 10 and max is 5000
          in: query
          name: limit
          schema:
            default: 10
            maximum: 5000
            type: integer
        - description: Range by timestamp.
          in: query
          name: timestamp.gte
          schema:
            type: string
        - description: Range by timestamp.
          in: query
          name: timestamp.gt
          schema:
            type: string
        - description: Range by timestamp.
          in: query
          name: timestamp.lte
          schema:
            type: string
        - description: Range by timestamp.
          in: query
          name: timestamp.lt
          schema:
            type: string
      responses:
        "200":
          content:
            application/json:
              example:
                next_url: https://api.polygon.io/v1/indicators/rsi/O:SPY241220P00720000?cursor=YWN0aXZlPXRydWUmZGF0ZT0yMDIxLTA0LTI1JmxpbWl0PTEmb3JkZXI9YXNjJnBhZ2VfbWFya2VyPUElN0M5YWRjMjY0ZTgyM2E1ZjBiOGUyNDc5YmZiOGE1YmYwNDVkYzU0YjgwMDcyMWE2YmI1ZjBjMjQwMjU4MjFmNGZiJnNvcnQ9dGlja2Vy
                request_id: a47d1beb8c11b6ae897ab76cdbbf35a3
                results:
                  underlying:
                    url: https://api.polygon.io/v2/aggs/ticker/O:SPY241220P00720000/range/1/day/2003-01-01/2022-07-25
                  values:
                    - timestamp: 1517562000016
                      value: 82.19
                status: OK
              schema:
                properties:
                  next_url:
                    description: If present, this value can be used to fetch the next page of data.
                    type: string
                  request_id:
                    description: A request id assigned by the server.
                    type: string
                  results:
                    properties:
                      underlying:
                        properties:
                          aggregates:
                            items:
                              properties:
                                c:
                                  description: The close price for the symbol in the given time period.
                                  format: float
                                  type: number
                                h:
                                  description: The highest price for the symbol in the given time period.
                                  format: float
                                  type: number
                                l:
                                  description: The lowest price for the symbol in the given time period.
                                  format: float
                                  type: number
                                n:
                                  description: The number of transactions in the aggregate window.
                                  type: integer
                                o:
                                  description: The open price for the symbol in the given time period.
                                  format: float
                                  type: number
                                otc:
                                  description: Whether or not this aggregate is for an OTC ticker. This field will
                                    be left off if false.
                                  type: boolean
                                t:
                                  description: The Unix Msec timestamp for the start of the aggregate window.
                                  format: float
                                  type: number
                                v:
                                  description: The trading volume of the symbol in the given time period.
                                  format: float
                                  type: number
                                vw:
                                  description: The volume weighted average price.
                                  format: float
                                  type: number
                              required:
                                - v
                                - vw
                                - o
                                - c
                                - h
                                - l
                                - t
                                - n
                              type: object
                              x-polygon-go-type:
                                name: Aggregate
                                path: github.com/polygon-io/go-lib-models/v2/globals
                            type: array
                          url:
                            description: The URL which can be used to request the underlying aggregates used
                              in this request.
                            type: string
                        type: object
                      values:
                        items:
                          properties:
                            timestamp:
                              description: The Unix Msec timestamp from the last aggregate used in this
                                calculation.
                              format: int64
                              type: integer
                              x-polygon-go-type:
                                name: IMicroseconds
                                path: github.com/polygon-io/ptime
                            value:
                              description: The indicator value for this period.
                              format: float
                              type: number
                              x-polygon-go-type:
                                name: "*float64"
                          type: object
                        type: array
                    type: object
                    x-polygon-go-type:
                      name: RSIResults
                  status:
                    description: The status of this request's response.
                    type: string
                type: object
            text/csv:
              example: |
                aggregate_T,aggregate_v,aggregate_vw,aggregate_a,aggregate_o,aggregate_c,aggregate_h,aggregate_l,aggregate_t,aggregate_n,aggregate_m,aggregate_x,aggregate_g,aggregate_op,aggregate_z,aggregate_av,aggregate_s,aggregate_e,aggregate_otc,timestamp,value
                O:SPY241220P00720000,3,277.8267,0,277.82,277.83,277.83,277.82,1649649600000,2,,0,,0,0,0,0,0,false,1649649600000,30.837887188419387
                O:SPY241220P00720000,2,270.49,0,270.49,270.49,270.49,270.49,1649390400000,1,,0,,0,0,0,0,0,false,1649390400000,15.546598157051605
                O:SPY241220P00720000,1,299.97,0,299.97,299.97,299.97,299.97,1648785600000,1,,0,,0,0,0,0,0,false,1648785600000,88.61520575036505
                O:SPY241220P00720000,1,299.97,0,299.97,299.97,299.97,299.97,1648699200000,1,,0,,0,0,0,0,0,false,1648699200000,88.61520575036505
                O:SPY241220P00720000,1,299.97,0,299.97,299.97,299.97,299.97,1648612800000,1,,0,,0,0,0,0,0,false,1648612800000,88.61520575036505
                O:SPY241220P00720000,1,299.97,0,299.97,299.97,299.97,299.97,1648526400000,1,,0,,0,0,0,0,0,false,1648526400000,88.61520575036505
                O:SPY241220P00720000,1,299.97,0,299.97,299.97,299.97,299.97,1649304000000,1,,0,,0,0,0,0,0,false,1649304000000,88.61520575036505
                O:SPY241220P00720000,1,299.97,0,299.97,299.97,299.97,299.97,1649217600000,1,,0,,0,0,0,0,0,false,1649217600000,88.61520575036505
                O:SPY241220P00720000,1,299.97,0,299.97,299.97,299.97,299.97,1649131200000,1,,0,,0,0,0,0,0,false,1649131200000,88.61520575036505
                O:SPY241220P00720000,1,299.97,0,299.97,299.97,299.97,299.97,1649044800000,1,,0,,0,0,0,0,0,false,1649044800000,88.61520575036505
              schema:
                type: string
          description: Relative Strength Index (RSI) data for each period.
      summary: Relative Strength Index (RSI)
      tags:
        - options:aggregates
      x-polygon-entitlement-data-type:
        description: Aggregate data
        name: aggregates
      x-polygon-entitlement-market-type:
        description: Options data
        name: options
    x-polygon-ignore: true
    parameters:
      - *a1
  /v1/indicators/rsi/{stockTicker}:
    get:
      description: Get the relative strength index (RSI) for a ticker symbol over a
        given time range.
      operationId: RSI
      parameters:
        - description: Specify a case-sensitive ticker symbol for which to get relative
            strength index (RSI) data. For example, AAPL represents Apple Inc.
          example: AAPL
          in: path
          name: stockTicker
          required: true
          schema:
            type: string
          x-polygon-go-id: Ticker
        - description: Query by timestamp. Either a date with the format YYYY-MM-DD or a
            millisecond timestamp.
          in: query
          name: timestamp
          schema:
            type: string
          x-polygon-filter-field:
            range: true
        - description: The size of the aggregate time window.
          example: day
          in: query
          name: timespan
          schema:
            default: day
            enum:
              - minute
              - hour
              - day
              - week
              - month
              - quarter
              - year
            type: string
        - description: Whether or not the aggregates used to calculate the relative
            strength index are adjusted for splits. By default, aggregates are
            adjusted. Set this to false to get results that are NOT adjusted for
            splits.
          example: true
          in: query
          name: adjusted
          schema:
            default: true
            type: boolean
        - description: The window size used to calculate the relative strength index (RSI).
          example: 14
          in: query
          name: window
          schema:
            default: 14
            type: integer
        - description: >-
            The price in the aggregate which will be used to calculate the
            relative strength index. i.e. 'close' will result in using close
            prices to 

            calculate the relative strength index (RSI).
          example: close
          in: query
          name: series_type
          schema:
            default: close
            enum:
              - open
              - high
              - low
              - close
            type: string
        - description: Whether or not to include the aggregates used to calculate this
            indicator in the response.
          in: query
          name: expand_underlying
          schema:
            default: false
            type: boolean
        - description: The order in which to return the results, ordered by timestamp.
          example: desc
          in: query
          name: order
          schema:
            default: desc
            enum:
              - asc
              - desc
            type: string
        - description: Limit the number of results returned, default is 10 and max is 5000
          in: query
          name: limit
          schema:
            default: 10
            maximum: 5000
            type: integer
        - description: Range by timestamp.
          in: query
          name: timestamp.gte
          schema:
            type: string
        - description: Range by timestamp.
          in: query
          name: timestamp.gt
          schema:
            type: string
        - description: Range by timestamp.
          in: query
          name: timestamp.lte
          schema:
            type: string
        - description: Range by timestamp.
          in: query
          name: timestamp.lt
          schema:
            type: string
      responses:
        "200":
          content:
            application/json:
              example:
                next_url: https://api.polygon.io/v1/indicators/rsi/AAPL?cursor=YWN0aXZlPXRydWUmZGF0ZT0yMDIxLTA0LTI1JmxpbWl0PTEmb3JkZXI9YXNjJnBhZ2VfbWFya2VyPUElN0M5YWRjMjY0ZTgyM2E1ZjBiOGUyNDc5YmZiOGE1YmYwNDVkYzU0YjgwMDcyMWE2YmI1ZjBjMjQwMjU4MjFmNGZiJnNvcnQ9dGlja2Vy
                request_id: a47d1beb8c11b6ae897ab76cdbbf35a3
                results:
                  underlying:
                    url: https://api.polygon.io/v2/aggs/ticker/AAPL/range/1/day/2003-01-01/2022-07-25
                  values:
                    - timestamp: 1517562000016
                      value: 82.19
                status: OK
              schema:
                properties:
                  next_url:
                    description: If present, this value can be used to fetch the next page of data.
                    type: string
                  request_id:
                    description: A request id assigned by the server.
                    type: string
                  results:
                    properties:
                      underlying:
                        properties:
                          aggregates:
                            items:
                              properties:
                                c:
                                  description: The close price for the symbol in the given time period.
                                  format: float
                                  type: number
                                h:
                                  description: The highest price for the symbol in the given time period.
                                  format: float
                                  type: number
                                l:
                                  description: The lowest price for the symbol in the given time period.
                                  format: float
                                  type: number
                                n:
                                  description: The number of transactions in the aggregate window.
                                  type: integer
                                o:
                                  description: The open price for the symbol in the given time period.
                                  format: float
                                  type: number
                                otc:
                                  description: Whether or not this aggregate is for an OTC ticker. This field will
                                    be left off if false.
                                  type: boolean
                                t:
                                  description: The Unix Msec timestamp for the start of the aggregate window.
                                  format: float
                                  type: number
                                v:
                                  description: The trading volume of the symbol in the given time period.
                                  format: float
                                  type: number
                                vw:
                                  description: The volume weighted average price.
                                  format: float
                                  type: number
                              required:
                                - v
                                - vw
                                - o
                                - c
                                - h
                                - l
                                - t
                                - n
                              type: object
                              x-polygon-go-type:
                                name: Aggregate
                                path: github.com/polygon-io/go-lib-models/v2/globals
                            type: array
                          url:
                            description: The URL which can be used to request the underlying aggregates used
                              in this request.
                            type: string
                        type: object
                      values:
                        items:
                          properties:
                            timestamp:
                              description: The Unix Msec timestamp from the last aggregate used in this
                                calculation.
                              format: int64
                              type: integer
                              x-polygon-go-type:
                                name: IMicroseconds
                                path: github.com/polygon-io/ptime
                            value:
                              description: The indicator value for this period.
                              format: float
                              type: number
                              x-polygon-go-type:
                                name: "*float64"
                          type: object
                        type: array
                    type: object
                    x-polygon-go-type:
                      name: RSIResults
                  status:
                    description: The status of this request's response.
                    type: string
                type: object
            text/csv:
              example: |
                aggregate_T,aggregate_v,aggregate_vw,aggregate_a,aggregate_o,aggregate_c,aggregate_h,aggregate_l,aggregate_t,aggregate_n,aggregate_m,aggregate_x,aggregate_g,aggregate_op,aggregate_z,aggregate_av,aggregate_s,aggregate_e,aggregate_otc,timestamp,value
                AAPL,1.27849501E+08,142.9012,0,146.1,142.48,146.72,140.68,1664424000000,1061692,,0,,0,0,0,0,0,false,1664424000000,23.065352237561996
                AAPL,1.46755122E+08,147.599,0,147.64,149.84,150.6414,144.84,1664337600000,1140818,,0,,0,0,0,0,0,false,1664337600000,29.877761913419718
                AAPL,9.3339409E+07,151.5222,0,149.66,150.77,153.7701,149.64,1664164800000,747666,,0,,0,0,0,0,0,false,1664164800000,29.58201330468151
                AAPL,8.1599225E+07,152.5505,0,149.31,154.48,154.56,149.1,1663560000000,671961,,0,,0,0,0,0,0,false,1663560000000,30.233508748331047
                AAPL,1.64879031E+08,150.2387,0,151.21,150.7,151.35,148.37,1663300800000,850358,,0,,0,0,0,0,0,false,1663300800000,19.857312489527956
                AAPL,8.4461761E+07,152.1354,0,152.74,151.76,154.72,149.945,1664251200000,683781,,0,,0,0,0,0,0,false,1664251200000,32.18008680069761
                AAPL,9.6031641E+07,150.0222,0,151.19,150.43,151.47,148.56,1663905600000,766888,,0,,0,0,0,0,0,false,1663905600000,28.71109953239781
                AAPL,8.6651514E+07,152.5709,0,152.38,152.74,154.47,150.91,1663819200000,686866,,0,,0,0,0,0,0,false,1663819200000,31.140902927103383
                AAPL,9.3308449E+07,156.1877,0,157.34,153.72,158.61,153.6,1663732800000,712645,,0,,0,0,0,0,0,false,1663732800000,32.21491128713248
                AAPL,1.07691097E+08,156.1317,0,153.4,156.9,158.08,153.08,1663646400000,792177,,0,,0,0,0,0,0,false,1663646400000,35.950871523070575
              schema:
                type: string
          description: Relative strength Index data for each period.
      summary: Relative Strength Index (RSI)
      tags:
        - stocks:aggregates
      x-polygon-entitlement-data-type:
        description: Aggregate data
        name: aggregates
      x-polygon-entitlement-market-type:
        description: Stocks data
        name: stocks
    parameters:
      - *a1
  /v1/indicators/sma/{cryptoTicker}:
    get:
      description: Get the simple moving average (SMA) for a ticker symbol over a
        given time range.
      operationId: CryptoSMA
      parameters:
        - description: The ticker symbol for which to get simple moving average (SMA) data.
          example: X:BTCUSD
          in: path
          name: cryptoTicker
          required: true
          schema:
            type: string
          x-polygon-go-id: Ticker
        - description: Query by timestamp. Either a date with the format YYYY-MM-DD or a
            millisecond timestamp.
          in: query
          name: timestamp
          schema:
            type: string
          x-polygon-filter-field:
            range: true
        - description: The size of the aggregate time window.
          example: day
          in: query
          name: timespan
          schema:
            default: day
            enum:
              - minute
              - hour
              - day
              - week
              - month
              - quarter
              - year
            type: string
        - description: The window size used to calculate the simple moving average (SMA).
            i.e. a window size of 10 with daily aggregates would result in a 10
            day moving average.
          example: 50
          in: query
          name: window
          schema:
            default: 50
            type: integer
        - description: >-
            The price in the aggregate which will be used to calculate the
            simple moving average. i.e. 'close' will result in using close
            prices to 

            calculate the simple moving average (SMA).
          example: close
          in: query
          name: series_type
          schema:
            default: close
            enum:
              - open
              - high
              - low
              - close
            type: string
        - description: Whether or not to include the aggregates used to calculate this
            indicator in the response.
          in: query
          name: expand_underlying
          schema:
            default: false
            type: boolean
        - description: The order in which to return the results, ordered by timestamp.
          example: desc
          in: query
          name: order
          schema:
            default: desc
            enum:
              - asc
              - desc
            type: string
        - description: Limit the number of results returned, default is 10 and max is 5000
          in: query
          name: limit
          schema:
            default: 10
            maximum: 5000
            type: integer
        - description: Range by timestamp.
          in: query
          name: timestamp.gte
          schema:
            type: string
        - description: Range by timestamp.
          in: query
          name: timestamp.gt
          schema:
            type: string
        - description: Range by timestamp.
          in: query
          name: timestamp.lte
          schema:
            type: string
        - description: Range by timestamp.
          in: query
          name: timestamp.lt
          schema:
            type: string
      responses:
        "200":
          content:
            application/json:
              example:
                next_url: https://api.polygon.io/v1/indicators/sma/X:BTCUSD?cursor=YWN0aXZlPXRydWUmZGF0ZT0yMDIxLTA0LTI1JmxpbWl0PTEmb3JkZXI9YXNjJnBhZ2VfbWFya2VyPUElN0M5YWRjMjY0ZTgyM2E1ZjBiOGUyNDc5YmZiOGE1YmYwNDVkYzU0YjgwMDcyMWE2YmI1ZjBjMjQwMjU4MjFmNGZiJnNvcnQ9dGlja2Vy
                request_id: a47d1beb8c11b6ae897ab76cdbbf35a3
                results:
                  underlying:
                    aggregates:
                      - c: 75.0875
                        h: 75.15
                        l: 73.7975
                        n: 1
                        o: 74.06
                        t: 1577941200000
                        v: 135647456
                        vw: 74.6099
                      - c: 74.3575
                        h: 75.145
                        l: 74.125
                        n: 1
                        o: 74.2875
                        t: 1578027600000
                        v: 146535512
                        vw: 74.7026
                    url: https://api.polygon.io/v2/aggs/ticker/X:BTCUSD/range/1/day/2003-01-01/2022-07-25
                  values:
                    - timestamp: 1517562000016
                      value: 140.139
                status: OK
              schema:
                properties:
                  next_url:
                    description: If present, this value can be used to fetch the next page of data.
                    type: string
                  request_id:
                    description: A request id assigned by the server.
                    type: string
                  results:
                    properties:
                      underlying:
                        properties:
                          aggregates:
                            items:
                              properties:
                                c:
                                  description: The close price for the symbol in the given time period.
                                  format: float
                                  type: number
                                h:
                                  description: The highest price for the symbol in the given time period.
                                  format: float
                                  type: number
                                l:
                                  description: The lowest price for the symbol in the given time period.
                                  format: float
                                  type: number
                                n:
                                  description: The number of transactions in the aggregate window.
                                  type: integer
                                o:
                                  description: The open price for the symbol in the given time period.
                                  format: float
                                  type: number
                                otc:
                                  description: Whether or not this aggregate is for an OTC ticker. This field will
                                    be left off if false.
                                  type: boolean
                                t:
                                  description: The Unix Msec timestamp for the start of the aggregate window.
                                  format: float
                                  type: number
                                v:
                                  description: The trading volume of the symbol in the given time period.
                                  format: float
                                  type: number
                                vw:
                                  description: The volume weighted average price.
                                  format: float
                                  type: number
                              required:
                                - v
                                - vw
                                - o
                                - c
                                - h
                                - l
                                - t
                                - n
                              type: object
                              x-polygon-go-type:
                                name: Aggregate
                                path: github.com/polygon-io/go-lib-models/v2/globals
                            type: array
                          url:
                            description: The URL which can be used to request the underlying aggregates used
                              in this request.
                            type: string
                        type: object
                      values:
                        items:
                          properties:
                            timestamp:
                              description: The Unix Msec timestamp from the last aggregate used in this
                                calculation.
                              format: int64
                              type: integer
                              x-polygon-go-type:
                                name: IMicroseconds
                                path: github.com/polygon-io/ptime
                            value:
                              description: The indicator value for this period.
                              format: float
                              type: number
                              x-polygon-go-type:
                                name: "*float64"
                          type: object
                        type: array
                    type: object
                    x-polygon-go-type:
                      name: SMAResults
                  status:
                    description: The status of this request's response.
                    type: string
                type: object
            text/csv:
              example: |
                aggregate_T,aggregate_v,aggregate_vw,aggregate_a,aggregate_o,aggregate_c,aggregate_h,aggregate_l,aggregate_t,aggregate_n,aggregate_m,aggregate_x,aggregate_g,aggregate_op,aggregate_z,aggregate_av,aggregate_s,aggregate_e,aggregate_otc,timestamp,value
                X:BTCUSD,55188.33773657,18970.3019,0,18816.66899332,19165.98,19333,18690,1664164800000,297389,,0,,0,0,0,0,0,false,1664164800000,19846.01135387188
                X:BTCUSD,4798.38258637,18914.0766,0,18928,18784.41,19184.3,18636,1664078400000,78936,,0,,0,0,0,0,0,false,1664078400000,19902.65703099573
                X:BTCUSD,4798.38258637,18914.0766,0,18928,18784.41,19184.3,18636,1664064000000,78936,,0,,0,0,0,0,0,false,1664064000000,19948.29976695474
                X:BTCUSD,15457.24362826,19317.486,0,19529.04,19475.84,19651.2772302,18846.67,1664409600000,191936,,0,,0,0,0,0,0,false,1664409600000,19751.714760699124
                X:BTCUSD,23180.93663313,19103.9189,0,19090,19416.20352522,19791,18461,1664337600000,225076,,0,,0,0,0,0,0,false,1664337600000,19762.974955013375
                X:BTCUSD,17479.00092209,19776.6697,0,19228.2,19141.78,20372.17374536,18821.55,1664251200000,183075,,0,,0,0,0,0,0,false,1664251200000,19791.86053850303
                X:BTCUSD,2868.09828007,19069.8521,0,19210.31,18925.87,19400,18805.1,1663992000000,58721,,0,,0,0,0,0,0,false,1663992000000,19995.805471728403
                X:BTCUSD,23180.93663313,19103.9189,0,19090,19416.20352522,19791,18461,1664323200000,225076,,0,,0,0,0,0,0,false,1664323200000,19777.128890923308
                X:BTCUSD,17479.00092209,19776.6697,0,19228.2,19141.78,20372.17374536,18821.55,1664236800000,183075,,0,,0,0,0,0,0,false,1664236800000,19818.394438033767
                X:BTCUSD,55188.33773657,18970.3019,0,18816.66899332,19165.98,19333,18690,1664150400000,297389,,0,,0,0,0,0,0,false,1664150400000,19873.767735662568
              schema:
                type: string
          description: Simple Moving Average (SMA) data for each period.
      summary: Simple Moving Average (SMA)
      tags:
        - crpyto:aggregates
      x-polygon-entitlement-data-type:
        description: Aggregate data
        name: aggregates
      x-polygon-entitlement-market-type:
        description: Crypto data
        name: crypto
    x-polygon-ignore: true
    parameters:
      - *a1
  /v1/indicators/sma/{fxTicker}:
    get:
      description: Get the simple moving average (SMA) for a ticker symbol over a
        given time range.
      operationId: ForexSMA
      parameters:
        - description: The ticker symbol for which to get simple moving average (SMA) data.
          example: C:EURUSD
          in: path
          name: fxTicker
          required: true
          schema:
            type: string
          x-polygon-go-id: Ticker
        - description: Query by timestamp. Either a date with the format YYYY-MM-DD or a
            millisecond timestamp.
          in: query
          name: timestamp
          schema:
            type: string
          x-polygon-filter-field:
            range: true
        - description: The size of the aggregate time window.
          example: day
          in: query
          name: timespan
          schema:
            default: day
            enum:
              - minute
              - hour
              - day
              - week
              - month
              - quarter
              - year
            type: string
        - description: >-
            Whether or not the aggregates used to calculate the simple moving
            average are adjusted for splits. By default, aggregates are
            adjusted.

            Set this to false to get results that are NOT adjusted for splits.
          example: true
          in: query
          name: adjusted
          schema:
            default: true
            type: boolean
        - description: The window size used to calculate the simple moving average (SMA).
            i.e. a window size of 10 with daily aggregates would result in a 10
            day moving average.
          example: 50
          in: query
          name: window
          schema:
            default: 50
            type: integer
        - description: >-
            The price in the aggregate which will be used to calculate the
            simple moving average. i.e. 'close' will result in using close
            prices to 

            calculate the simple moving average (SMA).
          example: close
          in: query
          name: series_type
          schema:
            default: close
            enum:
              - open
              - high
              - low
              - close
            type: string
        - description: Whether or not to include the aggregates used to calculate this
            indicator in the response.
          in: query
          name: expand_underlying
          schema:
            default: false
            type: boolean
        - description: The order in which to return the results, ordered by timestamp.
          example: desc
          in: query
          name: order
          schema:
            default: desc
            enum:
              - asc
              - desc
            type: string
        - description: Limit the number of results returned, default is 10 and max is 5000
          in: query
          name: limit
          schema:
            default: 10
            maximum: 5000
            type: integer
        - description: Range by timestamp.
          in: query
          name: timestamp.gte
          schema:
            type: string
        - description: Range by timestamp.
          in: query
          name: timestamp.gt
          schema:
            type: string
        - description: Range by timestamp.
          in: query
          name: timestamp.lte
          schema:
            type: string
        - description: Range by timestamp.
          in: query
          name: timestamp.lt
          schema:
            type: string
      responses:
        "200":
          content:
            application/json:
              example:
                next_url: https://api.polygon.io/v1/indicators/sma/C:USDAUD?cursor=YWN0aXZlPXRydWUmZGF0ZT0yMDIxLTA0LTI1JmxpbWl0PTEmb3JkZXI9YXNjJnBhZ2VfbWFya2VyPUElN0M5YWRjMjY0ZTgyM2E1ZjBiOGUyNDc5YmZiOGE1YmYwNDVkYzU0YjgwMDcyMWE2YmI1ZjBjMjQwMjU4MjFmNGZiJnNvcnQ9dGlja2Vy
                request_id: a47d1beb8c11b6ae897ab76cdbbf35a3
                results:
                  underlying:
                    aggregates:
                      - c: 75.0875
                        h: 75.15
                        l: 73.7975
                        n: 1
                        o: 74.06
                        t: 1577941200000
                        v: 135647456
                        vw: 74.6099
                      - c: 74.3575
                        h: 75.145
                        l: 74.125
                        n: 1
                        o: 74.2875
                        t: 1578027600000
                        v: 146535512
                        vw: 74.7026
                    url: https://api.polygon.io/v2/aggs/ticker/C:USDAUD/range/1/day/2003-01-01/2022-07-25
                  values:
                    - timestamp: 1517562000016
                      value: 140.139
                status: OK
              schema:
                properties:
                  next_url:
                    description: If present, this value can be used to fetch the next page of data.
                    type: string
                  request_id:
                    description: A request id assigned by the server.
                    type: string
                  results:
                    properties:
                      underlying:
                        properties:
                          aggregates:
                            items:
                              properties:
                                c:
                                  description: The close price for the symbol in the given time period.
                                  format: float
                                  type: number
                                h:
                                  description: The highest price for the symbol in the given time period.
                                  format: float
                                  type: number
                                l:
                                  description: The lowest price for the symbol in the given time period.
                                  format: float
                                  type: number
                                n:
                                  description: The number of transactions in the aggregate window.
                                  type: integer
                                o:
                                  description: The open price for the symbol in the given time period.
                                  format: float
                                  type: number
                                otc:
                                  description: Whether or not this aggregate is for an OTC ticker. This field will
                                    be left off if false.
                                  type: boolean
                                t:
                                  description: The Unix Msec timestamp for the start of the aggregate window.
                                  format: float
                                  type: number
                                v:
                                  description: The trading volume of the symbol in the given time period.
                                  format: float
                                  type: number
                                vw:
                                  description: The volume weighted average price.
                                  format: float
                                  type: number
                              required:
                                - v
                                - vw
                                - o
                                - c
                                - h
                                - l
                                - t
                                - n
                              type: object
                              x-polygon-go-type:
                                name: Aggregate
                                path: github.com/polygon-io/go-lib-models/v2/globals
                            type: array
                          url:
                            description: The URL which can be used to request the underlying aggregates used
                              in this request.
                            type: string
                        type: object
                      values:
                        items:
                          properties:
                            timestamp:
                              description: The Unix Msec timestamp from the last aggregate used in this
                                calculation.
                              format: int64
                              type: integer
                              x-polygon-go-type:
                                name: IMicroseconds
                                path: github.com/polygon-io/ptime
                            value:
                              description: The indicator value for this period.
                              format: float
                              type: number
                              x-polygon-go-type:
                                name: "*float64"
                          type: object
                        type: array
                    type: object
                    x-polygon-go-type:
                      name: SMAResults
                  status:
                    description: The status of this request's response.
                    type: string
                type: object
            text/csv:
              example: |
                aggregate_T,aggregate_v,aggregate_vw,aggregate_a,aggregate_o,aggregate_c,aggregate_h,aggregate_l,aggregate_t,aggregate_n,aggregate_m,aggregate_x,aggregate_g,aggregate_op,aggregate_z,aggregate_av,aggregate_s,aggregate_e,aggregate_otc,timestamp,value
                C:USDAUD,685,1.5537,0,1.5539533,1.5371372,1.5705737,1.5316281,1664323200000,685,,0,,0,0,0,0,0,false,1664323200000,1.4915199239999994
                C:USDAUD,550,1.5405,0,1.5298,1.54531,1.5526263,1.5298,1664164800000,550,,0,,0,0,0,0,0,false,1664164800000,1.4863299679999997
                C:USDAUD,10,1.5312,0,1.5324261,1.53107,1.5326375,1.5301,1664078400000,10,,0,,0,0,0,0,0,false,1664078400000,1.4826388699999997
                C:USDAUD,686,1.5442,0,1.53763,1.5404,1.5526022,1.537279,1664409600000,686,,0,,0,0,0,0,0,false,1664409600000,1.4942168479999998
                C:USDAUD,536,1.5459,0,1.5446162,1.5550165,1.5587,1.5364287,1664251200000,536,,0,,0,0,0,0,0,false,1664251200000,1.4900704799999993
                C:USDAUD,536,1.5459,0,1.5446162,1.5550165,1.5587,1.5364287,1664236800000,536,,0,,0,0,0,0,0,false,1664236800000,1.4882634499999994
                C:USDAUD,550,1.5405,0,1.5298,1.54531,1.5526263,1.5298,1664150400000,550,,0,,0,0,0,0,0,false,1664150400000,1.4845906159999998
                C:USDAUD,10,1.5312,0,1.5324261,1.53107,1.5326375,1.5301,1664064000000,10,,0,,0,0,0,0,0,false,1664064000000,1.4809719239999999
                C:USDAUD,1,1.5314,0,1.5313936,1.5313936,1.5313936,1.5313936,1663977600000,1,,0,,0,0,0,0,0,false,1663977600000,1.4794745239999998
                C:USDAUD,685,1.5537,0,1.5539533,1.5371372,1.5705737,1.5316281,1664337600000,685,,0,,0,0,0,0,0,false,1664337600000,1.4928357579999996
              schema:
                type: string
          description: Simple Moving Average (SMA) data for each period.
      summary: Simple Moving Average (SMA)
      tags:
        - fx:aggregates
      x-polygon-entitlement-data-type:
        description: Aggregate data
        name: aggregates
      x-polygon-entitlement-market-type:
        description: Forex data
        name: fx
    x-polygon-ignore: true
    parameters:
      - *a1
  /v1/indicators/sma/{indicesTicker}:
    get:
      description: Get the simple moving average (SMA) for a ticker symbol over a
        given time range.
      operationId: IndicesSMA
      parameters:
        - description: The ticker symbol for which to get simple moving average (SMA) data.
          example: I:NDX
          in: path
          name: indicesTicker
          required: true
          schema:
            type: string
          x-polygon-go-id: Ticker
        - description: Query by timestamp. Either a date with the format YYYY-MM-DD or a
            millisecond timestamp.
          in: query
          name: timestamp
          schema:
            type: string
          x-polygon-filter-field:
            range: true
        - description: The size of the aggregate time window.
          example: day
          in: query
          name: timespan
          schema:
            default: day
            enum:
              - minute
              - hour
              - day
              - week
              - month
              - quarter
              - year
            type: string
        - description: >-
            Whether or not the aggregates used to calculate the simple moving
            average are adjusted for splits. By default, aggregates are
            adjusted.

            Set this to false to get results that are NOT adjusted for splits.
          example: true
          in: query
          name: adjusted
          schema:
            default: true
            type: boolean
        - description: The window size used to calculate the simple moving average (SMA).
            i.e. a window size of 10 with daily aggregates would result in a 10
            day moving average.
          example: 50
          in: query
          name: window
          schema:
            default: 50
            type: integer
        - description: >-
            The value in the aggregate which will be used to calculate the
            simple moving average. i.e. 'close' will result in using close
            values to 

            calculate the simple moving average (SMA).
          example: close
          in: query
          name: series_type
          schema:
            default: close
            enum:
              - open
              - high
              - low
              - close
            type: string
        - description: Whether or not to include the aggregates used to calculate this
            indicator in the response.
          in: query
          name: expand_underlying
          schema:
            default: false
            type: boolean
        - description: The order in which to return the results, ordered by timestamp.
          example: desc
          in: query
          name: order
          schema:
            default: desc
            enum:
              - asc
              - desc
            type: string
        - description: Limit the number of results returned, default is 10 and max is 5000
          in: query
          name: limit
          schema:
            default: 10
            maximum: 5000
            type: integer
        - description: Range by timestamp.
          in: query
          name: timestamp.gte
          schema:
            type: string
        - description: Range by timestamp.
          in: query
          name: timestamp.gt
          schema:
            type: string
        - description: Range by timestamp.
          in: query
          name: timestamp.lte
          schema:
            type: string
        - description: Range by timestamp.
          in: query
          name: timestamp.lt
          schema:
            type: string
      responses:
        "200":
          content:
            application/json:
              example:
                next_url: https://api.polygon.io/v1/indicators/sma/I:NDX?cursor=YWRqdXN0ZWQ9dHJ1ZSZhcD0lN0IlMjJ2JTIyJTNBMCUyQyUyMm8lMjIlM0EwJTJDJTIyYyUyMiUzQTE1MDg0Ljk5OTM4OTgyMDAzJTJDJTIyaCUyMiUzQTAlMkMlMjJsJTIyJTNBMCUyQyUyMnQlMjIlM0ExNjg3MjE5MjAwMDAwJTdEJmFzPSZleHBhbmRfdW5kZXJseWluZz1mYWxzZSZsaW1pdD0xJm9yZGVyPWRlc2Mmc2VyaWVzX3R5cGU9Y2xvc2UmdGltZXNwYW49ZGF5JnRpbWVzdGFtcC5sdD0xNjg3MjM3MjAwMDAwJndpbmRvdz01Mw
                request_id: 4cae270008cb3f947e3f92c206e3888a
                results:
                  underlying:
                    url: https://api.polygon.io/v2/aggs/ticker/I:NDX/range/1/day/1678338000000/1687366378997?limit=240&sort=desc
                  values:
                    - timestamp: 1687237200000
                      value: 14362.676417589264
                status: OK
              schema:
                properties:
                  next_url:
                    description: If present, this value can be used to fetch the next page of data.
                    type: string
                  request_id:
                    description: A request id assigned by the server.
                    type: string
                  results:
                    properties:
                      underlying:
                        properties:
                          aggregates:
                            items:
                              properties:
                                c:
                                  description: The close price for the symbol in the given time period.
                                  format: float
                                  type: number
                                h:
                                  description: The highest price for the symbol in the given time period.
                                  format: float
                                  type: number
                                l:
                                  description: The lowest price for the symbol in the given time period.
                                  format: float
                                  type: number
                                n:
                                  description: The number of transactions in the aggregate window.
                                  type: integer
                                o:
                                  description: The open price for the symbol in the given time period.
                                  format: float
                                  type: number
                                otc:
                                  description: Whether or not this aggregate is for an OTC ticker. This field will
                                    be left off if false.
                                  type: boolean
                                t:
                                  description: The Unix Msec timestamp for the start of the aggregate window.
                                  format: float
                                  type: number
                                v:
                                  description: The trading volume of the symbol in the given time period.
                                  format: float
                                  type: number
                                vw:
                                  description: The volume weighted average price.
                                  format: float
                                  type: number
                              required:
                                - v
                                - vw
                                - o
                                - c
                                - h
                                - l
                                - t
                                - n
                              type: object
                              x-polygon-go-type:
                                name: Aggregate
                                path: github.com/polygon-io/go-lib-models/v2/globals
                            type: array
                          url:
                            description: The URL which can be used to request the underlying aggregates used
                              in this request.
                            type: string
                        type: object
                      values:
                        items:
                          properties:
                            timestamp:
                              description: The Unix Msec timestamp from the last aggregate used in this
                                calculation.
                              format: int64
                              type: integer
                              x-polygon-go-type:
                                name: IMicroseconds
                                path: github.com/polygon-io/ptime
                            value:
                              description: The indicator value for this period.
                              format: float
                              type: number
                              x-polygon-go-type:
                                name: "*float64"
                          type: object
                        type: array
                    type: object
                    x-polygon-go-type:
                      name: SMAResults
                  status:
                    description: The status of this request's response.
                    type: string
                type: object
          description: Simple Moving Average (SMA) data for each period.
      summary: Simple Moving Average (SMA)
      tags:
        - indices:aggregates
      x-polygon-entitlement-allowed-limited-tickers: true
      x-polygon-entitlement-data-type:
        description: Aggregate data
        name: aggregates
      x-polygon-entitlement-market-type:
        description: Indices data
        name: indices
    x-polygon-ignore: true
    parameters:
      - *a1
  /v1/indicators/sma/{optionsTicker}:
    get:
      description: Get the simple moving average (SMA) for a ticker symbol over a
        given time range.
      operationId: OptionsSMA
      parameters:
        - description: The ticker symbol for which to get simple moving average (SMA) data.
          example: O:SPY241220P00720000
          in: path
          name: optionsTicker
          required: true
          schema:
            type: string
          x-polygon-go-id: Ticker
        - description: Query by timestamp. Either a date with the format YYYY-MM-DD or a
            millisecond timestamp.
          in: query
          name: timestamp
          schema:
            type: string
          x-polygon-filter-field:
            range: true
        - description: The size of the aggregate time window.
          example: day
          in: query
          name: timespan
          schema:
            default: day
            enum:
              - minute
              - hour
              - day
              - week
              - month
              - quarter
              - year
            type: string
        - description: >-
            Whether or not the aggregates used to calculate the simple moving
            average are adjusted for splits. By default, aggregates are
            adjusted.

            Set this to false to get results that are NOT adjusted for splits.
          example: true
          in: query
          name: adjusted
          schema:
            default: true
            type: boolean
        - description: The window size used to calculate the simple moving average (SMA).
            i.e. a window size of 10 with daily aggregates would result in a 10
            day moving average.
          example: 50
          in: query
          name: window
          schema:
            default: 50
            type: integer
        - description: >-
            The price in the aggregate which will be used to calculate the
            simple moving average. i.e. 'close' will result in using close
            prices to 

            calculate the simple moving average (SMA).
          example: close
          in: query
          name: series_type
          schema:
            default: close
            enum:
              - open
              - high
              - low
              - close
            type: string
        - description: Whether or not to include the aggregates used to calculate this
            indicator in the response.
          in: query
          name: expand_underlying
          schema:
            default: false
            type: boolean
        - description: The order in which to return the results, ordered by timestamp.
          example: desc
          in: query
          name: order
          schema:
            default: desc
            enum:
              - asc
              - desc
            type: string
        - description: Limit the number of results returned, default is 10 and max is 5000
          in: query
          name: limit
          schema:
            default: 10
            maximum: 5000
            type: integer
        - description: Range by timestamp.
          in: query
          name: timestamp.gte
          schema:
            type: string
        - description: Range by timestamp.
          in: query
          name: timestamp.gt
          schema:
            type: string
        - description: Range by timestamp.
          in: query
          name: timestamp.lte
          schema:
            type: string
        - description: Range by timestamp.
          in: query
          name: timestamp.lt
          schema:
            type: string
      responses:
        "200":
          content:
            application/json:
              example:
                next_url: https://api.polygon.io/v1/indicators/sma/O:SPY241220P00720000?cursor=YWN0aXZlPXRydWUmZGF0ZT0yMDIxLTA0LTI1JmxpbWl0PTEmb3JkZXI9YXNjJnBhZ2VfbWFya2VyPUElN0M5YWRjMjY0ZTgyM2E1ZjBiOGUyNDc5YmZiOGE1YmYwNDVkYzU0YjgwMDcyMWE2YmI1ZjBjMjQwMjU4MjFmNGZiJnNvcnQ9dGlja2Vy
                request_id: a47d1beb8c11b6ae897ab76cdbbf35a3
                results:
                  underlying:
                    aggregates:
                      - c: 75.0875
                        h: 75.15
                        l: 73.7975
                        n: 1
                        o: 74.06
                        t: 1577941200000
                        v: 135647456
                        vw: 74.6099
                      - c: 74.3575
                        h: 75.145
                        l: 74.125
                        n: 1
                        o: 74.2875
                        t: 1578027600000
                        v: 146535512
                        vw: 74.7026
                    url: https://api.polygon.io/v2/aggs/ticker/O:SPY241220P00720000/range/1/day/2003-01-01/2022-07-25
                  values:
                    - timestamp: 1517562000016
                      value: 140.139
                status: OK
              schema:
                properties:
                  next_url:
                    description: If present, this value can be used to fetch the next page of data.
                    type: string
                  request_id:
                    description: A request id assigned by the server.
                    type: string
                  results:
                    properties:
                      underlying:
                        properties:
                          aggregates:
                            items:
                              properties:
                                c:
                                  description: The close price for the symbol in the given time period.
                                  format: float
                                  type: number
                                h:
                                  description: The highest price for the symbol in the given time period.
                                  format: float
                                  type: number
                                l:
                                  description: The lowest price for the symbol in the given time period.
                                  format: float
                                  type: number
                                n:
                                  description: The number of transactions in the aggregate window.
                                  type: integer
                                o:
                                  description: The open price for the symbol in the given time period.
                                  format: float
                                  type: number
                                otc:
                                  description: Whether or not this aggregate is for an OTC ticker. This field will
                                    be left off if false.
                                  type: boolean
                                t:
                                  description: The Unix Msec timestamp for the start of the aggregate window.
                                  format: float
                                  type: number
                                v:
                                  description: The trading volume of the symbol in the given time period.
                                  format: float
                                  type: number
                                vw:
                                  description: The volume weighted average price.
                                  format: float
                                  type: number
                              required:
                                - v
                                - vw
                                - o
                                - c
                                - h
                                - l
                                - t
                                - n
                              type: object
                              x-polygon-go-type:
                                name: Aggregate
                                path: github.com/polygon-io/go-lib-models/v2/globals
                            type: array
                          url:
                            description: The URL which can be used to request the underlying aggregates used
                              in this request.
                            type: string
                        type: object
                      values:
                        items:
                          properties:
                            timestamp:
                              description: The Unix Msec timestamp from the last aggregate used in this
                                calculation.
                              format: int64
                              type: integer
                              x-polygon-go-type:
                                name: IMicroseconds
                                path: github.com/polygon-io/ptime
                            value:
                              description: The indicator value for this period.
                              format: float
                              type: number
                              x-polygon-go-type:
                                name: "*float64"
                          type: object
                        type: array
                    type: object
                    x-polygon-go-type:
                      name: SMAResults
                  status:
                    description: The status of this request's response.
                    type: string
                type: object
            text/csv:
              example: |
                aggregate_T,aggregate_v,aggregate_vw,aggregate_a,aggregate_o,aggregate_c,aggregate_h,aggregate_l,aggregate_t,aggregate_n,aggregate_m,aggregate_x,aggregate_g,aggregate_op,aggregate_z,aggregate_av,aggregate_s,aggregate_e,aggregate_otc,timestamp,value
                O:SPY241220P00720000,1,299.97,0,299.97,299.97,299.97,299.97,1649304000000,1,,0,,0,0,0,0,0,false,1649304000000,286.0121999999996
                O:SPY241220P00720000,1,299.97,0,299.97,299.97,299.97,299.97,1649131200000,1,,0,,0,0,0,0,0,false,1649131200000,284.61099999999965
                O:SPY241220P00720000,1,299.97,0,299.97,299.97,299.97,299.97,1648699200000,1,,0,,0,0,0,0,0,false,1648699200000,282.50919999999974
                O:SPY241220P00720000,1,299.97,0,299.97,299.97,299.97,299.97,1648612800000,1,,0,,0,0,0,0,0,false,1648612800000,281.80859999999973
                O:SPY241220P00720000,1,299.97,0,299.97,299.97,299.97,299.97,1648526400000,1,,0,,0,0,0,0,0,false,1648526400000,281.1079999999998
                O:SPY241220P00720000,3,277.8267,0,277.82,277.83,277.83,277.82,1649649600000,2,,0,,0,0,0,0,0,false,1649649600000,285.4949999999996
                O:SPY241220P00720000,2,270.49,0,270.49,270.49,270.49,270.49,1649390400000,1,,0,,0,0,0,0,0,false,1649390400000,285.6801999999996
                O:SPY241220P00720000,1,299.97,0,299.97,299.97,299.97,299.97,1649217600000,1,,0,,0,0,0,0,0,false,1649217600000,285.31159999999966
                O:SPY241220P00720000,1,299.97,0,299.97,299.97,299.97,299.97,1649044800000,1,,0,,0,0,0,0,0,false,1649044800000,283.9103999999997
                O:SPY241220P00720000,1,299.97,0,299.97,299.97,299.97,299.97,1648785600000,1,,0,,0,0,0,0,0,false,1648785600000,283.2097999999997
              schema:
                type: string
          description: Simple Moving Average (SMA) data for each period.
      summary: Simple Moving Average (SMA)
      tags:
        - options:aggregates
      x-polygon-entitlement-data-type:
        description: Aggregate data
        name: aggregates
      x-polygon-entitlement-market-type:
        description: Options data
        name: options
    x-polygon-ignore: true
    parameters:
      - *a1
  /v1/indicators/sma/{stockTicker}:
    get:
      description: Get the simple moving average (SMA) for a ticker symbol over a
        given time range.
      operationId: SMA
      parameters:
        - description: Specify a case-sensitive ticker symbol for which to get simple
            moving average (SMA) data. For example, AAPL represents Apple Inc.
          example: AAPL
          in: path
          name: stockTicker
          required: true
          schema:
            type: string
          x-polygon-go-id: Ticker
        - description: Query by timestamp. Either a date with the format YYYY-MM-DD or a
            millisecond timestamp.
          in: query
          name: timestamp
          schema:
            type: string
          x-polygon-filter-field:
            range: true
        - description: The size of the aggregate time window.
          example: day
          in: query
          name: timespan
          schema:
            default: day
            enum:
              - minute
              - hour
              - day
              - week
              - month
              - quarter
              - year
            type: string
        - description: >-
            Whether or not the aggregates used to calculate the simple moving
            average are adjusted for splits. By default, aggregates are
            adjusted.

            Set this to false to get results that are NOT adjusted for splits.
          example: true
          in: query
          name: adjusted
          schema:
            default: true
            type: boolean
        - description: The window size used to calculate the simple moving average (SMA).
            i.e. a window size of 10 with daily aggregates would result in a 10
            day moving average.
          example: 50
          in: query
          name: window
          schema:
            default: 50
            type: integer
        - description: >-
            The price in the aggregate which will be used to calculate the
            simple moving average. i.e. 'close' will result in using close
            prices to 

            calculate the simple moving average (SMA).
          example: close
          in: query
          name: series_type
          schema:
            default: close
            enum:
              - open
              - high
              - low
              - close
            type: string
        - description: Whether or not to include the aggregates used to calculate this
            indicator in the response.
          in: query
          name: expand_underlying
          schema:
            default: false
            type: boolean
        - description: The order in which to return the results, ordered by timestamp.
          example: desc
          in: query
          name: order
          schema:
            default: desc
            enum:
              - asc
              - desc
            type: string
        - description: Limit the number of results returned, default is 10 and max is 5000
          in: query
          name: limit
          schema:
            default: 10
            maximum: 5000
            type: integer
        - description: Range by timestamp.
          in: query
          name: timestamp.gte
          schema:
            type: string
        - description: Range by timestamp.
          in: query
          name: timestamp.gt
          schema:
            type: string
        - description: Range by timestamp.
          in: query
          name: timestamp.lte
          schema:
            type: string
        - description: Range by timestamp.
          in: query
          name: timestamp.lt
          schema:
            type: string
      responses:
        "200":
          content:
            application/json:
              example:
                next_url: https://api.polygon.io/v1/indicators/sma/AAPL?cursor=YWN0aXZlPXRydWUmZGF0ZT0yMDIxLTA0LTI1JmxpbWl0PTEmb3JkZXI9YXNjJnBhZ2VfbWFya2VyPUElN0M5YWRjMjY0ZTgyM2E1ZjBiOGUyNDc5YmZiOGE1YmYwNDVkYzU0YjgwMDcyMWE2YmI1ZjBjMjQwMjU4MjFmNGZiJnNvcnQ9dGlja2Vy
                request_id: a47d1beb8c11b6ae897ab76cdbbf35a3
                results:
                  underlying:
                    aggregates:
                      - c: 75.0875
                        h: 75.15
                        l: 73.7975
                        n: 1
                        o: 74.06
                        t: 1577941200000
                        v: 135647456
                        vw: 74.6099
                      - c: 74.3575
                        h: 75.145
                        l: 74.125
                        n: 1
                        o: 74.2875
                        t: 1578027600000
                        v: 146535512
                        vw: 74.7026
                    url: https://api.polygon.io/v2/aggs/ticker/AAPL/range/1/day/2003-01-01/2022-07-25
                  values:
                    - timestamp: 1517562000016
                      value: 140.139
                status: OK
              schema:
                properties:
                  next_url:
                    description: If present, this value can be used to fetch the next page of data.
                    type: string
                  request_id:
                    description: A request id assigned by the server.
                    type: string
                  results:
                    properties:
                      underlying:
                        properties:
                          aggregates:
                            items:
                              properties:
                                c:
                                  description: The close price for the symbol in the given time period.
                                  format: float
                                  type: number
                                h:
                                  description: The highest price for the symbol in the given time period.
                                  format: float
                                  type: number
                                l:
                                  description: The lowest price for the symbol in the given time period.
                                  format: float
                                  type: number
                                n:
                                  description: The number of transactions in the aggregate window.
                                  type: integer
                                o:
                                  description: The open price for the symbol in the given time period.
                                  format: float
                                  type: number
                                otc:
                                  description: Whether or not this aggregate is for an OTC ticker. This field will
                                    be left off if false.
                                  type: boolean
                                t:
                                  description: The Unix Msec timestamp for the start of the aggregate window.
                                  format: float
                                  type: number
                                v:
                                  description: The trading volume of the symbol in the given time period.
                                  format: float
                                  type: number
                                vw:
                                  description: The volume weighted average price.
                                  format: float
                                  type: number
                              required:
                                - v
                                - vw
                                - o
                                - c
                                - h
                                - l
                                - t
                                - n
                              type: object
                              x-polygon-go-type:
                                name: Aggregate
                                path: github.com/polygon-io/go-lib-models/v2/globals
                            type: array
                          url:
                            description: The URL which can be used to request the underlying aggregates used
                              in this request.
                            type: string
                        type: object
                      values:
                        items:
                          properties:
                            timestamp:
                              description: The Unix Msec timestamp from the last aggregate used in this
                                calculation.
                              format: int64
                              type: integer
                              x-polygon-go-type:
                                name: IMicroseconds
                                path: github.com/polygon-io/ptime
                            value:
                              description: The indicator value for this period.
                              format: float
                              type: number
                              x-polygon-go-type:
                                name: "*float64"
                          type: object
                        type: array
                    type: object
                    x-polygon-go-type:
                      name: SMAResults
                  status:
                    description: The status of this request's response.
                    type: string
                type: object
            text/csv:
              example: |
                aggregate_T,aggregate_v,aggregate_vw,aggregate_a,aggregate_o,aggregate_c,aggregate_h,aggregate_l,aggregate_t,aggregate_n,aggregate_m,aggregate_x,aggregate_g,aggregate_op,aggregate_z,aggregate_av,aggregate_s,aggregate_e,aggregate_otc,timestamp,value
                AAPL,1.27849501E+08,142.9012,0,146.1,142.48,146.72,140.68,1664424000000,1061692,,0,,0,0,0,0,0,false,1664424000000,164.19240000000005
                AAPL,1.46755122E+08,147.599,0,147.64,149.84,150.6414,144.84,1664337600000,1140818,,0,,0,0,0,0,0,false,1664337600000,164.40360000000007
                AAPL,8.4461761E+07,152.1354,0,152.74,151.76,154.72,149.945,1664251200000,683781,,0,,0,0,0,0,0,false,1664251200000,164.42680000000007
                AAPL,9.3339409E+07,151.5222,0,149.66,150.77,153.7701,149.64,1664164800000,747666,,0,,0,0,0,0,0,false,1664164800000,164.33300000000006
                AAPL,9.3308449E+07,156.1877,0,157.34,153.72,158.61,153.6,1663732800000,712645,,0,,0,0,0,0,0,false,1663732800000,164.13680000000005
                AAPL,9.6031641E+07,150.0222,0,151.19,150.43,151.47,148.56,1663905600000,766888,,0,,0,0,0,0,0,false,1663905600000,164.32100000000005
                AAPL,8.6651514E+07,152.5709,0,152.38,152.74,154.47,150.91,1663819200000,686866,,0,,0,0,0,0,0,false,1663819200000,164.28180000000003
                AAPL,1.07691097E+08,156.1317,0,153.4,156.9,158.08,153.08,1663646400000,792177,,0,,0,0,0,0,0,false,1663646400000,163.97960000000006
                AAPL,8.1599225E+07,152.5505,0,149.31,154.48,154.56,149.1,1663560000000,671961,,0,,0,0,0,0,0,false,1663560000000,163.73900000000006
                AAPL,1.64879031E+08,150.2387,0,151.21,150.7,151.35,148.37,1663300800000,850358,,0,,0,0,0,0,0,false,1663300800000,163.59020000000007
              schema:
                type: string
          description: Simple Moving Average (SMA) data for each period.
      summary: Simple Moving Average (SMA)
      tags:
        - stocks:aggregates
      x-polygon-entitlement-data-type:
        description: Aggregate data
        name: aggregates
      x-polygon-entitlement-market-type:
        description: Stocks data
        name: stocks
    parameters:
      - *a1
  /v1/marketstatus/now:
    get:
      description: Get the current trading status of the exchanges and overall
        financial markets.
      operationId: GetMarketStatus
      responses:
        "200":
          content:
            application/json:
              example:
                afterHours: true
                currencies:
                  crypto: open
                  fx: open
                earlyHours: false
                exchanges:
                  nasdaq: extended-hours
                  nyse: extended-hours
                  otc: closed
                market: extended-hours
                serverTime: 2020-11-10T17:37:37-05:00
              schema:
                properties:
                  afterHours:
                    description: Whether or not the market is in post-market hours.
                    type: boolean
                    x-polygon-go-type:
                      name: "*bool"
                  currencies:
                    properties:
                      crypto:
                        description: The status of the crypto market.
                        type: string
                      fx:
                        description: The status of the forex market.
                        type: string
                    type: object
                    x-polygon-go-type:
                      name: Currencies
                  earlyHours:
                    description: Whether or not the market is in pre-market hours.
                    type: boolean
                    x-polygon-go-type:
                      name: "*bool"
                  exchanges:
                    properties:
                      nasdaq:
                        description: The status of the Nasdaq market.
                        type: string
                      nyse:
                        description: The status of the NYSE market.
                        type: string
                      otc:
                        description: The status of the OTC market.
                        type: string
                    type: object
                    x-polygon-go-type:
                      name: Exchanges
                  indicesGroups:
                    properties:
                      cccy:
                        description: The status of Cboe Streaming Market Indices Cryptocurrency ("CCCY")
                          indices trading hours.
                        type: string
                      dow_jones:
                        description: The status of Dow Jones indices trading hours
                        type: string
                      ftse_russell:
                        description: The status of Financial Times Stock Exchange Group ("FTSE") Russell
                          indices trading hours.
                        type: string
                      msci:
                        description: The status of Morgan Stanley Capital International ("MSCI") indices
                          trading hours.
                        type: string
                      mstar:
                        description: The status of Morningstar ("MSTAR") indices trading hours.
                        type: string
                      mstarc:
                        description: The status of Morningstar Customer ("MSTARC") indices trading
                          hours.
                      nasdaq:
                        description: The status of National Association of Securities Dealers Automated
                          Quotations ("Nasdaq") indices trading hours.
                        type: string
                      s_and_p:
                        description: The status of Standard & Poors's ("S&P") indices trading hours.
                        type: string
                      societe_generale:
                        description: The status of Societe Generale indices trading hours.
                        type: string
                    type: object
                    x-polygon-go-type:
                      name: IndicesGroups
                  market:
                    description: The status of the market as a whole.
                    type: string
                  serverTime:
                    description: The current time of the server, returned as a date-time in RFC3339
                      format.
                    type: string
                type: object
          description: OK
      summary: Market Status
      tags:
        - reference:stocks:market
      x-polygon-entitlement-data-type:
        description: Reference data
        name: reference
    parameters:
      - *a1
  /v1/marketstatus/upcoming:
    get:
      description: Get upcoming market holidays and their open/close times.
      operationId: GetMarketHolidays
      responses:
        "200":
          content:
            application/json:
              example:
                - date: 2020-11-26
                  exchange: NYSE
                  name: Thanksgiving
                  status: closed
                - date: 2020-11-26
                  exchange: NASDAQ
                  name: Thanksgiving
                  status: closed
                - date: 2020-11-26
                  exchange: OTC
                  name: Thanksgiving
                  status: closed
                - close: 2020-11-27T18:00:00.000Z
                  date: 2020-11-27
                  exchange: NASDAQ
                  name: Thanksgiving
                  open: 2020-11-27T14:30:00.000Z
                  status: early-close
                - close: 2020-11-27T18:00:00.000Z
                  date: 2020-11-27
                  exchange: NYSE
                  name: Thanksgiving
                  open: 2020-11-27T14:30:00.000Z
                  status: early-close
              schema:
                items:
                  properties:
                    close:
                      description: The market close time on the holiday (if it's not closed).
                      type: string
                    date:
                      description: The date of the holiday.
                      type: string
                    exchange:
                      description: Which market the record is for.
                      type: string
                    name:
                      description: The name of the holiday.
                      type: string
                    open:
                      description: The market open time on the holiday (if it's not closed).
                      type: string
                    status:
                      description: The status of the market on the holiday.
                      type: string
                  type: object
                  x-polygon-go-type:
                    name: MarketHoliday
                type: array
          description: OK
      summary: Market Holidays
      tags:
        - reference:stocks:market
      x-polygon-entitlement-data-type:
        description: Reference data
        name: reference
    parameters:
      - *a1
  /v1/open-close/crypto/{from}/{to}/{date}:
    get:
      description: |
        Get the open, close prices of a cryptocurrency symbol on a certain day.
      parameters:
        - description: The "from" symbol of the pair.
          example: BTC
          in: path
          name: from
          required: true
          schema:
            type: string
        - description: The "to" symbol of the pair.
          example: USD
          in: path
          name: to
          required: true
          schema:
            type: string
        - description: The date of the requested open/close in the format YYYY-MM-DD.
          example: 2023-01-09
          in: path
          name: date
          required: true
          schema:
            format: date
            type: string
        - description: >
            Whether or not the results are adjusted for splits.  By default,
            results are adjusted.

            Set this to false to get results that are NOT adjusted for splits.
          example: true
          in: query
          name: adjusted
          schema:
            type: boolean
      responses:
        "200":
          content:
            application/json:
              example:
                close: 11050.64
                closingTrades:
                  - c:
                      - 2
                    i: "973323250"
                    p: 11050.64
                    s: 0.006128
                    t: 1602287999795
                    x: 4
                  - c:
                      - 1
                    i: "105717893"
                    p: 11049.4
                    s: 0.014
                    t: 1602287999659
                    x: 17
                day: 2020-10-09T00:00:00.000Z
                isUTC: true
                open: 10932.44
                openTrades:
                  - c:
                      - 2
                    i: "511235746"
                    p: 10932.44
                    s: 0.002
                    t: 1602201600056
                    x: 1
                  - c:
                      - 2
                    i: "511235751"
                    p: 10923.76
                    s: 0.02
                    t: 1602201600141
                    x: 4
                symbol: BTC-USD
              schema:
                properties:
                  close:
                    description: The close price for the symbol in the given time period.
                    format: double
                    type: number
                  closingTrades:
                    items:
                      properties:
                        c:
                          description: |
                            A list of condition codes.
                          items:
                            description: |
                              The condition code. These are the conditions of this message. See
                              [Condition Mappings](https://polygon.io/docs/get_v3_reference_conditions)
                              for a mapping to exchange conditions.
                            type: integer
                          type: array
                        i:
                          description: >
                            The Trade ID which uniquely identifies a trade.
                            These are unique per

                            combination of ticker, exchange, and TRF. For
                            example: A trade for AAPL

                            executed on NYSE and a trade for AAPL executed on
                            NASDAQ could potentially

                            have the same Trade ID.
                          type: string
                        p:
                          description: >
                            The price of the trade. This is the actual dollar
                            value per whole share of

                            this trade. A trade of 100 shares with a price of
                            $2.00 would be worth a

                            total dollar value of $200.00.
                          format: double
                          type: number
                        s:
                          description: |
                            The size of a trade (also known as volume).
                          format: double
                          type: number
                        t:
                          description: The Unix Msec timestamp for the start of the aggregate window.
                          type: integer
                        x:
                          description: |
                            The exchange that this crypto trade happened on.  
                            See <a href="https://polygon.io/docs/crypto/get_v3_reference_exchanges">Exchanges</a> for a mapping of exchanges to IDs.
                          type: integer
                      required:
                        - p
                        - s
                        - x
                        - c
                        - t
                        - i
                      type: object
                    type: array
                  day:
                    description: The date requested.
                    format: date
                    type: string
                  isUTC:
                    description: Whether or not the timestamps are in UTC timezone.
                    type: boolean
                  open:
                    description: The open price for the symbol in the given time period.
                    format: double
                    type: number
                  openTrades:
                    items:
                      properties:
                        c:
                          description: |
                            A list of condition codes.
                          items:
                            description: |
                              The condition code. These are the conditions of this message. See
                              [Condition Mappings](https://polygon.io/docs/get_v3_reference_conditions)
                              for a mapping to exchange conditions.
                            type: integer
                          type: array
                        i:
                          description: >
                            The Trade ID which uniquely identifies a trade.
                            These are unique per

                            combination of ticker, exchange, and TRF. For
                            example: A trade for AAPL

                            executed on NYSE and a trade for AAPL executed on
                            NASDAQ could potentially

                            have the same Trade ID.
                          type: string
                        p:
                          description: >
                            The price of the trade. This is the actual dollar
                            value per whole share of

                            this trade. A trade of 100 shares with a price of
                            $2.00 would be worth a

                            total dollar value of $200.00.
                          format: double
                          type: number
                        s:
                          description: |
                            The size of a trade (also known as volume).
                          format: double
                          type: number
                        t:
                          description: The Unix Msec timestamp for the start of the aggregate window.
                          type: integer
                        x:
                          description: |
                            The exchange that this crypto trade happened on.  
                            See <a href="https://polygon.io/docs/crypto/get_v3_reference_exchanges">Exchanges</a> for a mapping of exchanges to IDs.
                          type: integer
                      required:
                        - p
                        - s
                        - x
                        - c
                        - t
                        - i
                      type: object
                    type: array
                  symbol:
                    description: The symbol pair that was evaluated from the request.
                    type: string
                required:
                  - symbol
                  - isUTC
                  - day
                  - open
                  - close
                  - openTrades
                  - closingTrades
                type: object
            text/csv:
              example: |
                isUTC,day,open,close,openTrades,closingTrades
                true,2020-10-09,10932.44,11050.64,"[{\"s\":0.002,\"p\":10932.44,\"x\":1,\"t\":1602201600056,\"c\":[2],\"i\":\"511235746\"},{\"s\":0.02,\"p\":10923.76,\"x\":4,\"t\":1602201600141,\"c\":[2],\"i\":\"511235751\"}]","[{\"s\":0.006128,\"p\":11050.64,\"x\":4,\"t\":1602287999795,\"c\":[2],\"i\":\"973323250\"},{\"s\":0.014,\"p\":11049.4,\"x\":17,\"t\":1602287999659,\"c\":[1],\"i\":\"105717893\"}]"
              schema:
                type: string
          description: The open/close of this symbol.
        default:
          description: Unexpected error
      summary: Daily Open/Close
      tags:
        - crypto:open-close
      x-polygon-entitlement-data-type:
        description: Aggregate data
        name: aggregates
      x-polygon-entitlement-market-type:
        description: Crypto data
        name: crypto
    parameters:
      - *a1
  /v1/open-close/{indicesTicker}/{date}:
    get:
      description: >
        Get the open, close and afterhours values of a index symbol on a certain
        date.
      parameters:
        - description: The ticker symbol of Index.
          example: I:NDX
          in: path
          name: indicesTicker
          required: true
          schema:
            type: string
        - description: The date of the requested open/close in the format YYYY-MM-DD.
          example: 2023-03-10
          in: path
          name: date
          required: true
          schema:
            type: string
      responses:
        "200":
          content:
            application/json:
              example:
                afterHours: 11830.43006295237
                close: 11830.28178808306
                from: 2023-03-10T00:00:00.000Z
                high: 12069.62262033557
                low: 11789.85923449393
                open: 12001.69552583921
                preMarket: 12001.69552583921
                status: OK
                symbol: I:NDX
              schema:
                properties:
                  afterHours:
                    description: The close value of the ticker symbol in after hours trading.
                    format: double
                    type: number
                  close:
                    description: The close value for the symbol in the given time period.
                    format: double
                    type: number
                  from:
                    description: The requested date.
                    format: date
                    type: string
                  high:
                    description: The highest value for the symbol in the given time period.
                    format: double
                    type: number
                  low:
                    description: The lowest value for the symbol in the given time period.
                    format: double
                    type: number
                  open:
                    description: The open value for the symbol in the given time period.
                    format: double
                    type: number
                  preMarket:
                    description: The open value of the ticker symbol in pre-market trading.
                    type: integer
                  status:
                    description: The status of this request's response.
                    type: string
                  symbol:
                    description: The exchange symbol that this item is traded under.
                    type: string
                required:
                  - status
                  - from
                  - symbol
                  - open
                  - high
                  - low
                  - close
                type: object
            text/csv:
              example: |
                from,open,high,low,close,afterHours,preMarket
                2023-01-10,12001.69552583921,12069.62262033557,11789.85923449393,11830.28178808306,26122646,11830.43006295237,12001.69552583921
              schema:
                type: string
          description: The open/close of this stock symbol.
        default:
          description: Unexpected error
      summary: Daily Open/Close
      tags:
        - stocks:open-close
      x-polygon-entitlement-allowed-limited-tickers: true
      x-polygon-entitlement-data-type:
        description: Aggregate data
        name: aggregates
      x-polygon-entitlement-market-type:
        description: Indices data
        name: indices
    parameters:
      - *a1
  /v1/open-close/{optionsTicker}/{date}:
    get:
      description: >
        Get the open, close and afterhours prices of an options contract on a
        certain date.
      parameters:
        - description: The ticker symbol of the options contract.
          example: O:SPY251219C00650000
          in: path
          name: optionsTicker
          required: true
          schema:
            type: string
        - description: The date of the requested open/close in the format YYYY-MM-DD.
          example: 2023-01-09
          in: path
          name: date
          required: true
          schema:
            format: date
            type: string
        - description: >
            Whether or not the results are adjusted for splits.  By default,
            results are adjusted.

            Set this to false to get results that are NOT adjusted for splits.
          example: true
          in: query
          name: adjusted
          schema:
            type: boolean
      responses:
        "200":
          content:
            application/json:
              example:
                afterHours: 26.35
                close: 26.35
                from: 2023-01-09
                high: 26.35
                low: 25
                open: 25
                preMarket: 25
                status: OK
                symbol: O:TSLA210903C00700000
                volume: 2
              schema:
                properties:
                  afterHours:
                    description: The close price of the ticker symbol in after hours trading.
                    format: double
                    type: number
                  close:
                    description: The close price for the symbol in the given time period.
                    format: double
                    type: number
                  from:
                    description: The requested date.
                    format: date
                    type: string
                  high:
                    description: The highest price for the symbol in the given time period.
                    format: double
                    type: number
                  low:
                    description: The lowest price for the symbol in the given time period.
                    format: double
                    type: number
                  open:
                    description: The open price for the symbol in the given time period.
                    format: double
                    type: number
                  otc:
                    description: Whether or not this aggregate is for an OTC ticker. This field will
                      be left off if false.
                    type: boolean
                  preMarket:
                    description: The open price of the ticker symbol in pre-market trading.
                    type: integer
                  status:
                    description: The status of this request's response.
                    type: string
                  symbol:
                    description: The exchange symbol that this item is traded under.
                    type: string
                  volume:
                    description: The trading volume of the symbol in the given time period.
                    format: double
                    type: number
                required:
                  - status
                  - from
                  - symbol
                  - open
                  - high
                  - low
                  - close
                  - volume
                type: object
            text/csv:
              example: |
                from,open,high,low,close,volume,afterHours,preMarket
                2023-01-09,25,26.35,25,26.35,2,26.35,25
              schema:
                type: string
          description: The open/close of this stock symbol.
        default:
          description: Unexpected error
      summary: Daily Open/Close
      tags:
        - options:open-close
      x-polygon-entitlement-data-type:
        description: Aggregate data
        name: aggregates
      x-polygon-entitlement-market-type:
        description: Options data
        name: options
    parameters:
      - *a1
  /v1/open-close/{stocksTicker}/{date}:
    get:
      description: >
        Get the open, close and afterhours prices of a stock symbol on a certain
        date.
      parameters:
        - description: Specify a case-sensitive ticker symbol. For example, AAPL
            represents Apple Inc.
          example: AAPL
          in: path
          name: stocksTicker
          required: true
          schema:
            type: string
        - description: The date of the requested open/close in the format YYYY-MM-DD.
          example: 2023-01-09
          in: path
          name: date
          required: true
          schema:
            format: date
            type: string
        - description: >
            Whether or not the results are adjusted for splits.  By default,
            results are adjusted.

            Set this to false to get results that are NOT adjusted for splits.
          example: true
          in: query
          name: adjusted
          schema:
            type: boolean
      responses:
        "200":
          content:
            application/json:
              example:
                afterHours: 322.1
                close: 325.12
                from: 2023-01-09
                high: 326.2
                low: 322.3
                open: 324.66
                preMarket: 324.5
                status: OK
                symbol: AAPL
                volume: 26122646
              schema:
                properties:
                  afterHours:
                    description: The close price of the ticker symbol in after hours trading.
                    format: double
                    type: number
                  close:
                    description: The close price for the symbol in the given time period.
                    format: double
                    type: number
                  from:
                    description: The requested date.
                    format: date
                    type: string
                  high:
                    description: The highest price for the symbol in the given time period.
                    format: double
                    type: number
                  low:
                    description: The lowest price for the symbol in the given time period.
                    format: double
                    type: number
                  open:
                    description: The open price for the symbol in the given time period.
                    format: double
                    type: number
                  otc:
                    description: Whether or not this aggregate is for an OTC ticker. This field will
                      be left off if false.
                    type: boolean
                  preMarket:
                    description: The open price of the ticker symbol in pre-market trading.
                    type: integer
                  status:
                    description: The status of this request's response.
                    type: string
                  symbol:
                    description: The exchange symbol that this item is traded under.
                    type: string
                  volume:
                    description: The trading volume of the symbol in the given time period.
                    format: double
                    type: number
                required:
                  - status
                  - from
                  - symbol
                  - open
                  - high
                  - low
                  - close
                  - volume
                type: object
            text/csv:
              example: |
                from,open,high,low,close,volume,afterHours,preMarket
                2023-01-09,324.66,326.2,322.3,325.12,26122646,322.1,324.5
              schema:
                type: string
          description: The open/close of this stock symbol.
        default:
          description: Unexpected error
      summary: Daily Open/Close
      tags:
        - stocks:open-close
      x-polygon-entitlement-data-type:
        description: Aggregate data
        name: aggregates
      x-polygon-entitlement-market-type:
        description: Stocks data
        name: stocks
    parameters:
      - *a1
  /v1/reference/sec/filings:
    get:
      description: List filings
      operationId: ListFilings
      parameters:
        - description: Query by filing type.
          in: query
          name: type
          schema:
            description: Filing Type
            enum:
              - 10-K
              - 10-Q
            type: string
        - description: Query by filing date.
          in: query
          name: filing_date
          schema:
            description: The date when the filing was filed in YYYYMMDD format.
            example: "20210101"
            pattern: ^[0-9]{8}$
            type: string
          x-polygon-filter-field:
            range: true
        - description: Query by period of report.
          in: query
          name: period_of_report_date
          schema:
            description: The period of report for the filing in YYYYMMDD format.
            example: "20210101"
            pattern: ^[0-9]{8}$
            type: string
          x-polygon-filter-field:
            range: true
        - description: >-
            If true, query only for filings with an XBRL instance file.

            If false, query for filings without an XBRL instance file.

            If this parameter is not provided, query for filings with or without
            XBRL instance files.
          in: query
          name: has_xbrl
          schema:
            nullable: true
            type: boolean
          x-polygon-go-id: HasXBRL
        - description: Query by entity company name.
          in: query
          name: entities.company_data.name
          schema:
            example: Facebook Inc
            type: string
          x-polygon-filter-field:
            search: true
        - description: Query by entity company CIK.
          in: query
          name: entities.company_data.cik
          schema:
            description: Central Index Key (CIK) Number
            type: string
        - description: Query by entity company ticker.
          in: query
          name: entities.company_data.ticker
          schema:
            description: Ticker
            type: string
        - description: Query by entity company SIC.
          in: query
          name: entities.company_data.sic
          schema:
            description: Standard Industrial Classification (SIC)
            type: string
        - description: Search by filing_date.
          in: query
          name: filing_date.gte
          schema:
            description: The date when the filing was filed in YYYYMMDD format.
            example: "20210101"
            pattern: ^[0-9]{8}$
            type: string
        - description: Search by filing_date.
          in: query
          name: filing_date.gt
          schema:
            description: The date when the filing was filed in YYYYMMDD format.
            example: "20210101"
            pattern: ^[0-9]{8}$
            type: string
        - description: Search by filing_date.
          in: query
          name: filing_date.lte
          schema:
            description: The date when the filing was filed in YYYYMMDD format.
            example: "20210101"
            pattern: ^[0-9]{8}$
            type: string
        - description: Search by filing_date.
          in: query
          name: filing_date.lt
          schema:
            description: The date when the filing was filed in YYYYMMDD format.
            example: "20210101"
            pattern: ^[0-9]{8}$
            type: string
        - description: Search by period_of_report_date.
          in: query
          name: period_of_report_date.gte
          schema:
            description: The period of report for the filing in YYYYMMDD format.
            example: "20210101"
            pattern: ^[0-9]{8}$
            type: string
        - description: Search by period_of_report_date.
          in: query
          name: period_of_report_date.gt
          schema:
            description: The period of report for the filing in YYYYMMDD format.
            example: "20210101"
            pattern: ^[0-9]{8}$
            type: string
        - description: Search by period_of_report_date.
          in: query
          name: period_of_report_date.lte
          schema:
            description: The period of report for the filing in YYYYMMDD format.
            example: "20210101"
            pattern: ^[0-9]{8}$
            type: string
        - description: Search by period_of_report_date.
          in: query
          name: period_of_report_date.lt
          schema:
            description: The period of report for the filing in YYYYMMDD format.
            example: "20210101"
            pattern: ^[0-9]{8}$
            type: string
        - description: Search by entities.company_data.name.
          in: query
          name: entities.company_data.name.search
          schema:
            type: string
        - description: Order results based on the `sort` field.
          in: query
          name: order
          schema:
            enum:
              - asc
              - desc
            example: asc
            type: string
        - description: Limit the number of results returned, default is 10 and max is 1000.
          in: query
          name: limit
          schema:
            default: 10
            example: 10
            maximum: 1000
            minimum: 1
            type: integer
        - description: Sort field used for ordering.
          in: query
          name: sort
          schema:
            default: filing_date
            enum:
              - filing_date
              - period_of_report_date
            example: filing_date
            type: string
      responses:
        "200":
          content:
            application/json:
              description: FIXME
              example: {}
              schema:
                properties:
                  count:
                    type: integer
                  next_url:
                    type: string
                  request_id:
                    type: string
                  results:
                    items:
                      properties:
                        acceptance_datetime:
                          description: "The datetime when the filing was accepted by EDGAR in EST (format:
                            YYYYMMDDHHMMSS)"
                          type: string
                        accession_number:
                          description: Filing Accession Number
                          type: string
                        entities:
                          description: Entities related to the filing (e.g. the document filers).
                          items:
                            description: A filing entity (e.g. the document filer).
                            properties:
                              company_data:
                                properties:
                                  cik:
                                    description: Central Index Key (CIK) Number
                                    type: string
                                  name:
                                    example: Facebook Inc
                                    type: string
                                  sic:
                                    description: Standard Industrial Classification (SIC)
                                    type: string
                                  ticker:
                                    description: Ticker
                                    type: string
                                required:
                                  - name
                                  - cik
                                  - sic
                                type: object
                                x-polygon-go-type:
                                  name: SECCompanyData
                                  path: github.com/polygon-io/go-lib-models/v2/globals
                              relation:
                                description: Relationship of this entity to the filing.
                                enum:
                                  - filer
                                type: string
                            required:
                              - relation
                            type: object
                            x-polygon-go-type:
                              name: SECFilingEntity
                              path: github.com/polygon-io/go-lib-models/v2/globals
                          type: array
                        files_count:
                          description: The number of files associated with the filing.
                          format: int64
                          type: integer
                        filing_date:
                          description: The date when the filing was filed in YYYYMMDD format.
                          example: "20210101"
                          pattern: ^[0-9]{8}$
                          type: string
                        id:
                          description: Unique identifier for the filing.
                          type: string
                        period_of_report_date:
                          description: The period of report for the filing in YYYYMMDD format.
                          example: "20210101"
                          pattern: ^[0-9]{8}$
                          type: string
                        source_url:
                          description: >-
                            The source URL is a link back to the upstream source
                            for this filing

                            document.
                          example: https://www.sec.gov/Archives/edgar/data/0001326801/000132680119000037/0001326801-19-000037-index.html
                          format: uri
                          type: string
                        type:
                          description: Filing Type
                          enum:
                            - 10-K
                            - 10-Q
                          type: string
                      required:
                        - id
                        - accession_number
                        - type
                        - filing_date
                        - period_of_report_date
                        - files_count
                        - source_url
                        - download_url
                        - entities
                        - acceptance_datetime
                      type: object
                      x-polygon-go-type:
                        name: SECFiling
                        path: github.com/polygon-io/go-lib-models/v2/globals
                    type: array
                  status:
                    type: string
                required:
                  - status
                  - request_id
                  - count
                  - results
                type: object
          description: FIXME
      summary: SEC Filings
      tags:
        - reference:sec:filings
      x-polygon-entitlement-data-type:
        description: Reference data
        name: reference
      x-polygon-paginate:
        sort:
          default: filing_date
          enum:
            - filing_date
            - period_of_report_date
    x-polygon-draft: true
    parameters:
      - *a1
  /v1/reference/sec/filings/{filing_id}:
    get:
      description: Get filing
      operationId: GetFiling
      parameters:
        - description: Select by filing id.
          in: path
          name: filing_id
          schema:
            description: Unique identifier for the filing.
            type: string
      responses:
        "200":
          content:
            application/json:
              description: FIXME
              example: {}
              schema:
                properties:
                  acceptance_datetime:
                    description: "The datetime when the filing was accepted by EDGAR in EST (format:
                      YYYYMMDDHHMMSS)"
                    type: string
                  accession_number:
                    description: Filing Accession Number
                    type: string
                  entities:
                    description: Entities related to the filing (e.g. the document filers).
                    items:
                      description: A filing entity (e.g. the document filer).
                      properties:
                        company_data:
                          properties:
                            cik:
                              description: Central Index Key (CIK) Number
                              type: string
                            name:
                              example: Facebook Inc
                              type: string
                            sic:
                              description: Standard Industrial Classification (SIC)
                              type: string
                            ticker:
                              description: Ticker
                              type: string
                          required:
                            - name
                            - cik
                            - sic
                          type: object
                          x-polygon-go-type:
                            name: SECCompanyData
                            path: github.com/polygon-io/go-lib-models/v2/globals
                        relation:
                          description: Relationship of this entity to the filing.
                          enum:
                            - filer
                          type: string
                      required:
                        - relation
                      type: object
                      x-polygon-go-type:
                        name: SECFilingEntity
                        path: github.com/polygon-io/go-lib-models/v2/globals
                    type: array
                  files_count:
                    description: The number of files associated with the filing.
                    format: int64
                    type: integer
                  filing_date:
                    description: The date when the filing was filed in YYYYMMDD format.
                    example: "20210101"
                    pattern: ^[0-9]{8}$
                    type: string
                  id:
                    description: Unique identifier for the filing.
                    type: string
                  period_of_report_date:
                    description: The period of report for the filing in YYYYMMDD format.
                    example: "20210101"
                    pattern: ^[0-9]{8}$
                    type: string
                  source_url:
                    description: >-
                      The source URL is a link back to the upstream source for
                      this filing

                      document.
                    example: https://www.sec.gov/Archives/edgar/data/0001326801/000132680119000037/0001326801-19-000037-index.html
                    format: uri
                    type: string
                  type:
                    description: Filing Type
                    enum:
                      - 10-K
                      - 10-Q
                    type: string
                required:
                  - id
                  - accession_number
                  - type
                  - filing_date
                  - period_of_report_date
                  - files_count
                  - source_url
                  - download_url
                  - entities
                  - acceptance_datetime
                type: object
                x-polygon-go-type:
                  name: SECFiling
                  path: github.com/polygon-io/go-lib-models/v2/globals
          description: FIXME
      summary: SEC Filing
      tags:
        - reference:sec:filing
      x-polygon-entitlement-data-type:
        description: Reference data
        name: reference
    x-polygon-draft: true
    parameters:
      - *a1
components:
  parameters:
    AggregateAdjusted:
      description: >
        Whether or not the results are adjusted for splits.  By default, results
        are adjusted.

        Set this to false to get results that are NOT adjusted for splits.
      example: true
      in: query
      name: adjusted
      schema:
        type: boolean
    AggregateDate:
      description: The beginning date for the aggregate window.
      example: 2023-01-09
      in: path
      name: date
      required: true
      schema:
        type: string
    AggregateLimitMax50000:
      description: >
        Limits the number of base aggregates queried to create the aggregate
        results. Max 50000 and Default 5000.

        Read more about how limit is used to calculate aggregate results in our
        article on

        <a href="https://polygon.io/blog/aggs-api-updates/" target="_blank"
        alt="Aggregate Data API Improvements">Aggregate Data API
        Improvements</a>.
      example: 120
      in: query
      name: limit
      schema:
        type: integer
    AggregateMultiplier:
      description: The size of the timespan multiplier.
      example: 1
      in: path
      name: multiplier
      required: true
      schema:
        type: integer
    AggregateSort:
      description: |
        Sort the results by timestamp.
        `asc` will return results in ascending order (oldest at the top),
        `desc` will return results in descending order (newest at the top).
      example: asc
      in: query
      name: sort
      schema:
        enum:
          - asc
          - desc
    AggregateTimeFrom:
      description: The start of the aggregate time window. Either a date with the
        format YYYY-MM-DD or a millisecond timestamp.
      example: 2023-01-09
      in: path
      name: from
      required: true
      schema:
        type: string
    AggregateTimeTo:
      description: The end of the aggregate time window. Either a date with the format
        YYYY-MM-DD or a millisecond timestamp.
      example: 2023-01-09
      in: path
      name: to
      required: true
      schema:
        type: string
    AggregateTimespan:
      description: The size of the time window.
      example: day
      in: path
      name: timespan
      required: true
      schema:
        enum:
          - second
          - minute
          - hour
          - day
          - week
          - month
          - quarter
          - year
        type: string
    CryptoTickerPathParam:
      description: The ticker symbol of the currency pair.
      example: X:BTCUSD
      in: path
      name: cryptoTicker
      required: true
      schema:
        type: string
    ForexTickerPathParam:
      description: The ticker symbol of the currency pair.
      example: C:EURUSD
      in: path
      name: forexTicker
      required: true
      schema:
        type: string
    GeneralTickerPathParam:
      description: The ticker symbol of the asset.
      example: AAPL
      in: path
      name: ticker
      required: true
      schema:
        type: string
    IncludeOTC:
      description: >
        Include OTC securities in the response. Default is false (don't include
        OTC securities).
      in: query
      name: include_otc
      schema:
        type: boolean
    IndicesAggregateTimeFrom:
      description: The start of the aggregate time window. Either a date with the
        format YYYY-MM-DD or a millisecond timestamp.
      example: 2023-03-10
      in: path
      name: from
      required: true
      schema:
        type: string
    IndicesAggregateTimeTo:
      description: The end of the aggregate time window. Either a date with the format
        YYYY-MM-DD or a millisecond timestamp.
      example: 2023-03-10
      in: path
      name: to
      required: true
      schema:
        type: string
    IndicesTickerPathParam:
      description: The ticker symbol of Index.
      example: I:NDX
      in: path
      name: indicesTicker
      required: true
      schema:
        type: string
    LimitMax10000:
      description: Limit the size of the response, max 10000.
      example: 100
      in: query
      name: limit
      schema:
        type: integer
    LimitMax50000:
      description: Limit the size of the response, max 50000 and default 5000.
      example: 10
      in: query
      name: limit
      schema:
        type: integer
    LimitNoMax:
      description: |
        Limit the number of results.
      example: 5
      in: query
      name: limit
      schema:
        type: integer
    OptionsTickerPathParam:
      description: The ticker symbol of the options contract.
      example: O:SPY251219C00650000
      in: path
      name: optionsTicker
      required: true
      schema:
        type: string
    ReverseOrder:
      description: |
        Reverse the order of the results.
      example: true
      in: query
      name: reverse
      schema:
        type: boolean
    SnapshotDirection:
      description: |
        The direction of the snapshot results to return.
      example: gainers
      in: path
      name: direction
      required: true
      schema:
        enum:
          - gainers
          - losers
        type: string
    StocksTickerPathParam:
      description: Specify a case-sensitive ticker symbol. For example, AAPL
        represents Apple Inc.
      example: AAPL
      in: path
      name: stocksTicker
      required: true
      schema:
        type: string
    TickersQueryParam:
      description: A case-sensitive comma separated list of tickers to get snapshots
        for. For example, AAPL,TSLA,GOOG. Empty string defaults to querying all
        tickers.
      in: query
      name: tickers
      schema:
        items:
          type: string
        type: array
  responses:
    Conflict:
      description: Parameter is invalid or incorrect.
    DefaultError:
      description: Unexpected error
    NotFound:
      description: The specified resource was not found
    Unauthorized:
      description: Unauthorized - Check our API Key and account status
  schemas:
    Adjusted:
      description: Whether or not this response was adjusted for splits.
      type: boolean
    AskExchangeId:
      allOf:
        - description: The exchange ID. See <a
            href="https://polygon.io/docs/stocks/get_v3_reference_exchanges"
            alt="Exchanges">Exchanges</a> for Polygon.io's mapping of exchange
            IDs.
          type: integer
        - description: Ask Exchange Id
    AskPrice:
      description: The ask price.
      format: double
      type: number
    AskSize:
      description: The ask size. This represents the number of round lot orders at the
        given ask price. The normal round lot size is 100 shares. An ask size of
        2 means there are 200 shares available to purchase at the given ask
        price.
      type: integer
    BidExchangeId:
      allOf:
        - description: The exchange ID. See <a
            href="https://polygon.io/docs/stocks/get_v3_reference_exchanges"
            alt="Exchanges">Exchanges</a> for Polygon.io's mapping of exchange
            IDs.
          type: integer
        - description: Bid Exchange Id
    BidPrice:
      description: The bid price.
      format: double
      type: number
    BidSize:
      description: The bid size. This represents the number of round lot orders at the
        given bid price. The normal round lot size is 100 shares. A bid size of
        2 means there are 200 shares for purchase at the given bid price.
      type: integer
    Close:
      description: The close price for the symbol in the given time period.
      format: double
      type: number
    CloseIndices:
      description: The close value for the symbol in the given time period.
      format: double
      type: number
    Company:
      properties:
        active:
          description: Indicates if the security is actively listed.  If false, this means
            the company is no longer listed and cannot be traded.
          type: boolean
        bloomberg:
          description: The Bloomberg guid for the symbol.
          type: string
        ceo:
          description: The name of the company's current CEO.
          type: string
        cik:
          description: The official CIK guid used for SEC database/filings.
          type: string
        country:
          description: The country in which the company is registered.
          type: string
        description:
          description: A description of the company and what they do/offer.
          type: string
        employees:
          description: The approximate number of employees for the company.
          type: integer
        exchange:
          description: The symbol's primary exchange.
          type: string
        exchangeSymbol:
          description: The exchange code (id) of the symbol's primary exchange.
          type: string
        figi:
          description: The OpenFigi project guid for the symbol. (<a rel="nofollow"
            target="_blank"
            href="https://openfigi.com/">https://openfigi.com/</a>)
          type: string
        hq_address:
          description: The street address for the company's headquarters.
          type: string
        hq_country:
          description: The country in which the company's headquarters is located.
          type: string
        hq_state:
          description: The state in which the company's headquarters is located.
          type: string
        industry:
          description: The industry in which the company operates.
          type: string
        lei:
          description: The Legal Entity Identifier (LEI) guid for the symbol. (<a
            rel="nofollow" target="_blank"
            href="https://en.wikipedia.org/wiki/Legal_Entity_Identifier">https://en.wikipedia.org/wiki/Legal_Entity_Identifier</a>)
          type: string
        listdate:
          description: The date that the symbol was listed on the exchange.
          format: date
          type: string
        logo:
          description: The URL of the entity's logo.
          type: string
        marketcap:
          description: The current market cap for the company.
          type: integer
        name:
          description: The name of the company/entity.
          type: string
        phone:
          description: The phone number for the company. This is usually a corporate
            contact number.
          type: string
        sector:
          description: The sector of the indsutry in which the symbol operates.
          type: string
        sic:
          description: Standard Industrial Classification (SIC) id for the symbol. (<a
            rel="nofollow" target="_blank"
            href="https://en.wikipedia.org/wiki/Standard_Industrial_Classification">https://en.wikipedia.org/wiki/Legal_Entity_Identifier</a>)
          type: integer
        similar:
          description: A list of ticker symbols for similar companies.
          items:
            description: The exchange symbol that this item is traded under.
            type: string
          type: array
        symbol:
          description: The exchange symbol that this item is traded under.
          type: string
        tags:
          items:
            description: A list of words related to the company.
            type: string
          type: array
        type:
          description: The type or class of the security.  (<a alt="Full List of Ticker
            Types"
            href="https://polygon.io/docs/stocks/get_v3_reference_tickers_types">Full
            List of Ticker Types</a>)
          type: string
        updated:
          description: The last time this company record was updated.
          format: date
          type: string
        url:
          description: The URL of the company's website
          type: string
      type: object
    ConditionTypeMap:
      properties:
        condition:
          description: >
            Polygon.io's mapping for condition codes.  For more information, see
            our <a href="https://polygon.io/glossary/us/stocks/trade-conditions"
            alt="Trade Conditions Glossary" target="_blank">Trade Conditions
            Glossary</a>.
          type: string
      type: object
    Conditions:
      description: |
        A list of condition codes.
      items:
        description: >
          The condition code. These are the conditions of this message. See

          [Condition
          Mappings](https://polygon.io/docs/get_v3_reference_conditions)

          for a mapping to exchange conditions.
        type: integer
      type: array
    Count:
      description: The total number of results for this request.
      type: integer
    CryptoExchange:
      items:
        properties:
          id:
            description: The exchange ID. See <a
              href="https://polygon.io/docs/stocks/get_v3_reference_exchanges"
              alt="Exchanges">Exchanges</a> for Polygon.io's mapping of exchange
              IDs.
            type: integer
          market:
            description: Market data type this exchange contains ( crypto only currently )
            type: string
          name:
            description: Name of the exchange
            type: string
          type:
            description: Type of exchange feed
            type: string
          url:
            description: URL of this exchange
            type: string
        required:
          - id
          - type
          - market
          - name
          - url
        type: object
      type: array
    CryptoGroupedResults:
      properties:
        results:
          items:
            properties:
              T:
                description: The exchange symbol that this item is traded under.
                type: string
              c:
                description: The close price for the symbol in the given time period.
                format: double
                type: number
              h:
                description: The highest price for the symbol in the given time period.
                format: double
                type: number
              l:
                description: The lowest price for the symbol in the given time period.
                format: double
                type: number
              n:
                description: The number of transactions in the aggregate window.
                type: integer
              o:
                description: The open price for the symbol in the given time period.
                format: double
                type: number
              t:
                description: The Unix Msec timestamp for the start of the aggregate window.
                type: integer
              v:
                description: The trading volume of the symbol in the given time period.
                format: double
                type: number
              vw:
                description: The volume weighted average price.
                format: double
                type: number
            required:
              - o
              - h
              - l
              - c
              - v
              - t
              - T
            type: object
          type: array
      type: object
    CryptoHistoricTrades:
      properties:
        day:
          description: The date that was evaluated from the request.
          format: date
          type: string
        map:
          description: A map for shortened result keys.
          type: object
        msLatency:
          description: The milliseconds of latency for the query results.
          type: integer
        symbol:
          description: The symbol pair that was evaluated from the request.
          type: string
        ticks:
          items:
            properties:
              c:
                description: |
                  A list of condition codes.
                items:
                  description: |
                    The condition code. These are the conditions of this message. See
                    [Condition Mappings](https://polygon.io/docs/get_v3_reference_conditions)
                    for a mapping to exchange conditions.
                  type: integer
                type: array
              i:
                description: >
                  The Trade ID which uniquely identifies a trade. These are
                  unique per

                  combination of ticker, exchange, and TRF. For example: A trade
                  for AAPL

                  executed on NYSE and a trade for AAPL executed on NASDAQ could
                  potentially

                  have the same Trade ID.
                type: string
              p:
                description: >
                  The price of the trade. This is the actual dollar value per
                  whole share of

                  this trade. A trade of 100 shares with a price of $2.00 would
                  be worth a

                  total dollar value of $200.00.
                format: double
                type: number
              s:
                description: |
                  The size of a trade (also known as volume).
                format: double
                type: number
              t:
                description: The Unix Msec timestamp for the start of the aggregate window.
                type: integer
              x:
                description: |
                  The exchange that this crypto trade happened on.  
                  See <a href="https://polygon.io/docs/crypto/get_v3_reference_exchanges">Exchanges</a> for a mapping of exchanges to IDs.
                type: integer
            required:
              - p
              - s
              - x
              - c
              - t
              - i
            type: object
          type: array
      required:
        - day
        - map
        - msLatency
        - symbol
        - ticks
      type: object
    CryptoLastTrade:
      properties:
        last:
          properties:
            conditions:
              description: |
                A list of condition codes.
              items:
                description: >
                  The condition code. These are the conditions of this message.
                  See

                  [Condition
                  Mappings](https://polygon.io/docs/get_v3_reference_conditions)

                  for a mapping to exchange conditions.
                type: integer
              type: array
            exchange:
              description: |
                The exchange that this crypto trade happened on.  
                See <a href="https://polygon.io/docs/crypto/get_v3_reference_exchanges">Exchanges</a> for a mapping of exchanges to IDs.
              type: integer
            price:
              description: >
                The price of the trade. This is the actual dollar value per
                whole share of

                this trade. A trade of 100 shares with a price of $2.00 would be
                worth a

                total dollar value of $200.00.
              format: double
              type: number
            size:
              description: |
                The size of a trade (also known as volume).
              format: double
              type: number
            timestamp:
              description: The Unix Msec timestamp for the start of the aggregate window.
              type: integer
          required:
            - conditions
            - exchange
            - price
            - size
            - timestamp
          type: object
        symbol:
          description: The symbol pair that was evaluated from the request.
          type: string
      required:
        - symbol
      type: object
    CryptoOpenClose:
      properties:
        close:
          description: The close price for the symbol in the given time period.
          format: double
          type: number
        closingTrades:
          items:
            properties:
              c:
                description: |
                  A list of condition codes.
                items:
                  description: |
                    The condition code. These are the conditions of this message. See
                    [Condition Mappings](https://polygon.io/docs/get_v3_reference_conditions)
                    for a mapping to exchange conditions.
                  type: integer
                type: array
              i:
                description: >
                  The Trade ID which uniquely identifies a trade. These are
                  unique per

                  combination of ticker, exchange, and TRF. For example: A trade
                  for AAPL

                  executed on NYSE and a trade for AAPL executed on NASDAQ could
                  potentially

                  have the same Trade ID.
                type: string
              p:
                description: >
                  The price of the trade. This is the actual dollar value per
                  whole share of

                  this trade. A trade of 100 shares with a price of $2.00 would
                  be worth a

                  total dollar value of $200.00.
                format: double
                type: number
              s:
                description: |
                  The size of a trade (also known as volume).
                format: double
                type: number
              t:
                description: The Unix Msec timestamp for the start of the aggregate window.
                type: integer
              x:
                description: |
                  The exchange that this crypto trade happened on.  
                  See <a href="https://polygon.io/docs/crypto/get_v3_reference_exchanges">Exchanges</a> for a mapping of exchanges to IDs.
                type: integer
            required:
              - p
              - s
              - x
              - c
              - t
              - i
            type: object
          type: array
        day:
          description: The date requested.
          format: date
          type: string
        isUTC:
          description: Whether or not the timestamps are in UTC timezone.
          type: boolean
        open:
          description: The open price for the symbol in the given time period.
          format: double
          type: number
        openTrades:
          items:
            properties:
              c:
                description: |
                  A list of condition codes.
                items:
                  description: |
                    The condition code. These are the conditions of this message. See
                    [Condition Mappings](https://polygon.io/docs/get_v3_reference_conditions)
                    for a mapping to exchange conditions.
                  type: integer
                type: array
              i:
                description: >
                  The Trade ID which uniquely identifies a trade. These are
                  unique per

                  combination of ticker, exchange, and TRF. For example: A trade
                  for AAPL

                  executed on NYSE and a trade for AAPL executed on NASDAQ could
                  potentially

                  have the same Trade ID.
                type: string
              p:
                description: >
                  The price of the trade. This is the actual dollar value per
                  whole share of

                  this trade. A trade of 100 shares with a price of $2.00 would
                  be worth a

                  total dollar value of $200.00.
                format: double
                type: number
              s:
                description: |
                  The size of a trade (also known as volume).
                format: double
                type: number
              t:
                description: The Unix Msec timestamp for the start of the aggregate window.
                type: integer
              x:
                description: |
                  The exchange that this crypto trade happened on.  
                  See <a href="https://polygon.io/docs/crypto/get_v3_reference_exchanges">Exchanges</a> for a mapping of exchanges to IDs.
                type: integer
            required:
              - p
              - s
              - x
              - c
              - t
              - i
            type: object
          type: array
        symbol:
          description: The symbol pair that was evaluated from the request.
          type: string
      required:
        - symbol
        - isUTC
        - day
        - open
        - close
        - openTrades
        - closingTrades
      type: object
    CryptoSnapshotMinute:
      properties:
        c:
          description: The close price for the symbol in the given time period.
          format: double
          type: number
        h:
          description: The highest price for the symbol in the given time period.
          format: double
          type: number
        l:
          description: The lowest price for the symbol in the given time period.
          format: double
          type: number
        n:
          description: The number of transactions in the aggregate window.
          type: integer
        o:
          description: The open price for the symbol in the given time period.
          format: double
          type: number
        t:
          description: The Unix Msec timestamp for the start of the aggregate window.
          type: integer
        v:
          description: The trading volume of the symbol in the given time period.
          format: double
          type: number
        vw:
          description: The volume weighted average price.
          format: double
          type: number
      required:
        - o
        - h
        - l
        - c
        - v
        - vw
        - t
        - n
      type: object
    CryptoSnapshotTicker:
      properties:
        ticker:
          properties:
            day:
              description: The most recent daily bar for this ticker.
              properties:
                c:
                  description: The close price for the symbol in the given time period.
                  format: double
                  type: number
                h:
                  description: The highest price for the symbol in the given time period.
                  format: double
                  type: number
                l:
                  description: The lowest price for the symbol in the given time period.
                  format: double
                  type: number
                o:
                  description: The open price for the symbol in the given time period.
                  format: double
                  type: number
                v:
                  description: The trading volume of the symbol in the given time period.
                  format: double
                  type: number
                vw:
                  description: The volume weighted average price.
                  format: double
                  type: number
              required:
                - o
                - h
                - l
                - c
                - v
                - vw
              type: object
            fmv:
              description: Fair market value is only available on Business plans. It is our
                proprietary algorithm to generate a real-time, accurate, fair
                market value of a tradable security. For more information, <a
                rel="nofollow" target="_blank"
                href="https://polygon.io/contact">contact us</a>.
              format: double
              type: number
            lastTrade:
              allOf:
                - description: The most recent trade for this ticker.
                - properties:
                    c:
                      description: The trade conditions.
                      items:
                        type: integer
                      type: array
                    i:
                      description: >
                        The Trade ID which uniquely identifies a trade. These
                        are unique per

                        combination of ticker, exchange, and TRF. For example: A
                        trade for AAPL

                        executed on NYSE and a trade for AAPL executed on NASDAQ
                        could potentially

                        have the same Trade ID.
                      type: string
                    p:
                      description: >
                        The price of the trade. This is the actual dollar value
                        per whole share of

                        this trade. A trade of 100 shares with a price of $2.00
                        would be worth a

                        total dollar value of $200.00.
                      format: double
                      type: number
                    s:
                      description: The size (volume) of the trade.
                      type: number
                    t:
                      description: The millisecond accuracy timestamp. This is the timestamp of when
                        the trade was generated at the exchange.
                      type: integer
                    x:
                      description: |
                        The exchange that this crypto trade happened on.  
                        See <a href="https://polygon.io/docs/crypto/get_v3_reference_exchanges">Exchanges</a> for a mapping of exchanges to IDs.
                      type: integer
                  required:
                    - c
                    - i
                    - p
                    - s
                    - t
                    - x
                  type: object
            min:
              description: The most recent minute bar for this ticker.
              properties:
                c:
                  description: The close price for the symbol in the given time period.
                  format: double
                  type: number
                h:
                  description: The highest price for the symbol in the given time period.
                  format: double
                  type: number
                l:
                  description: The lowest price for the symbol in the given time period.
                  format: double
                  type: number
                n:
                  description: The number of transactions in the aggregate window.
                  type: integer
                o:
                  description: The open price for the symbol in the given time period.
                  format: double
                  type: number
                t:
                  description: The Unix Msec timestamp for the start of the aggregate window.
                  type: integer
                v:
                  description: The trading volume of the symbol in the given time period.
                  format: double
                  type: number
                vw:
                  description: The volume weighted average price.
                  format: double
                  type: number
              required:
                - o
                - h
                - l
                - c
                - v
                - vw
                - t
                - n
              type: object
            prevDay:
              description: The previous day's bar for this ticker.
              properties:
                c:
                  description: The close price for the symbol in the given time period.
                  format: double
                  type: number
                h:
                  description: The highest price for the symbol in the given time period.
                  format: double
                  type: number
                l:
                  description: The lowest price for the symbol in the given time period.
                  format: double
                  type: number
                o:
                  description: The open price for the symbol in the given time period.
                  format: double
                  type: number
                v:
                  description: The trading volume of the symbol in the given time period.
                  format: double
                  type: number
                vw:
                  description: The volume weighted average price.
                  format: double
                  type: number
              required:
                - o
                - h
                - l
                - c
                - v
                - vw
              type: object
            ticker:
              description: The exchange symbol that this item is traded under.
              type: string
            todaysChange:
              description: The value of the change from the previous day.
              format: double
              type: number
            todaysChangePerc:
              description: The percentage change since the previous day.
              format: double
              type: number
            updated:
              description: The last updated timestamp.
              type: integer
          required:
            - day
            - lastTrade
            - min
            - prevDay
            - ticker
            - todaysChange
            - todaysChangePerc
            - updated
          type: object
      type: object
    CryptoSnapshotTickerFullBook:
      properties:
        data:
          properties:
            askCount:
              description: The combined total number of asks in the book.
              format: double
              type: number
            asks:
              items:
                properties:
                  p:
                    description: The price of this book level.
                    format: double
                    type: number
                  x:
                    description: >
                      A map of the exchange ID to number of shares at this price
                      level.

                      <br />

                      <br />

                      **Example:**

                      <br />

                      `{
                        "p": 16302.94,
                        "x": {
                          "1": 0.02859424,
                          "6": 0.023455
                        }
                      }`

                      <br />

                      <br />

                      In this example, exchange ID 1 has 0.02859424 shares
                      available at $16,302.94,

                      and exchange ID 6 has 0.023455 shares at the same price
                      level.
                    type: object
                required:
                  - p
                  - x
                type: object
              type: array
            bidCount:
              description: The combined total number of bids in the book.
              format: double
              type: number
            bids:
              items:
                properties:
                  p:
                    description: The price of this book level.
                    format: double
                    type: number
                  x:
                    description: >
                      A map of the exchange ID to number of shares at this price
                      level.

                      <br />

                      <br />

                      **Example:**

                      <br />

                      `{
                        "p": 16302.94,
                        "x": {
                          "1": 0.02859424,
                          "6": 0.023455
                        }
                      }`

                      <br />

                      <br />

                      In this example, exchange ID 1 has 0.02859424 shares
                      available at $16,302.94,

                      and exchange ID 6 has 0.023455 shares at the same price
                      level.
                    type: object
                required:
                  - p
                  - x
                type: object
              type: array
            spread:
              description: The difference between the best bid and the best ask price across
                exchanges.
              format: double
              type: number
            ticker:
              description: The exchange symbol that this item is traded under.
              type: string
            updated:
              description: The last updated timestamp.
              type: integer
          required:
            - ticker
            - bids
            - asks
            - bidCount
            - askCount
            - spread
            - updated
          type: object
      type: object
    CryptoSnapshotTickers:
      properties:
        tickers:
          items:
            properties:
              day:
                description: The most recent daily bar for this ticker.
                properties:
                  c:
                    description: The close price for the symbol in the given time period.
                    format: double
                    type: number
                  h:
                    description: The highest price for the symbol in the given time period.
                    format: double
                    type: number
                  l:
                    description: The lowest price for the symbol in the given time period.
                    format: double
                    type: number
                  o:
                    description: The open price for the symbol in the given time period.
                    format: double
                    type: number
                  v:
                    description: The trading volume of the symbol in the given time period.
                    format: double
                    type: number
                  vw:
                    description: The volume weighted average price.
                    format: double
                    type: number
                required:
                  - o
                  - h
                  - l
                  - c
                  - v
                  - vw
                type: object
              fmv:
                description: Fair market value is only available on Business plans. It is our
                  proprietary algorithm to generate a real-time, accurate, fair
                  market value of a tradable security. For more information, <a
                  rel="nofollow" target="_blank"
                  href="https://polygon.io/contact">contact us</a>.
                format: double
                type: number
              lastTrade:
                allOf:
                  - description: The most recent trade for this ticker.
                  - properties:
                      c:
                        description: The trade conditions.
                        items:
                          type: integer
                        type: array
                      i:
                        description: >
                          The Trade ID which uniquely identifies a trade. These
                          are unique per

                          combination of ticker, exchange, and TRF. For example:
                          A trade for AAPL

                          executed on NYSE and a trade for AAPL executed on
                          NASDAQ could potentially

                          have the same Trade ID.
                        type: string
                      p:
                        description: >
                          The price of the trade. This is the actual dollar
                          value per whole share of

                          this trade. A trade of 100 shares with a price of
                          $2.00 would be worth a

                          total dollar value of $200.00.
                        format: double
                        type: number
                      s:
                        description: The size (volume) of the trade.
                        type: number
                      t:
                        description: The millisecond accuracy timestamp. This is the timestamp of when
                          the trade was generated at the exchange.
                        type: integer
                      x:
                        description: |
                          The exchange that this crypto trade happened on.  
                          See <a href="https://polygon.io/docs/crypto/get_v3_reference_exchanges">Exchanges</a> for a mapping of exchanges to IDs.
                        type: integer
                    required:
                      - c
                      - i
                      - p
                      - s
                      - t
                      - x
                    type: object
              min:
                description: The most recent minute bar for this ticker.
                properties:
                  c:
                    description: The close price for the symbol in the given time period.
                    format: double
                    type: number
                  h:
                    description: The highest price for the symbol in the given time period.
                    format: double
                    type: number
                  l:
                    description: The lowest price for the symbol in the given time period.
                    format: double
                    type: number
                  n:
                    description: The number of transactions in the aggregate window.
                    type: integer
                  o:
                    description: The open price for the symbol in the given time period.
                    format: double
                    type: number
                  t:
                    description: The Unix Msec timestamp for the start of the aggregate window.
                    type: integer
                  v:
                    description: The trading volume of the symbol in the given time period.
                    format: double
                    type: number
                  vw:
                    description: The volume weighted average price.
                    format: double
                    type: number
                required:
                  - o
                  - h
                  - l
                  - c
                  - v
                  - vw
                  - t
                  - n
                type: object
              prevDay:
                description: The previous day's bar for this ticker.
                properties:
                  c:
                    description: The close price for the symbol in the given time period.
                    format: double
                    type: number
                  h:
                    description: The highest price for the symbol in the given time period.
                    format: double
                    type: number
                  l:
                    description: The lowest price for the symbol in the given time period.
                    format: double
                    type: number
                  o:
                    description: The open price for the symbol in the given time period.
                    format: double
                    type: number
                  v:
                    description: The trading volume of the symbol in the given time period.
                    format: double
                    type: number
                  vw:
                    description: The volume weighted average price.
                    format: double
                    type: number
                required:
                  - o
                  - h
                  - l
                  - c
                  - v
                  - vw
                type: object
              ticker:
                description: The exchange symbol that this item is traded under.
                type: string
              todaysChange:
                description: The value of the change from the previous day.
                format: double
                type: number
              todaysChangePerc:
                description: The percentage change since the previous day.
                format: double
                type: number
              updated:
                description: The last updated timestamp.
                type: integer
            required:
              - day
              - lastTrade
              - min
              - prevDay
              - ticker
              - todaysChange
              - todaysChangePerc
              - updated
            type: object
          type: array
      type: object
    CryptoTick:
      properties:
        c:
          description: |
            A list of condition codes.
          items:
            description: >
              The condition code. These are the conditions of this message. See

              [Condition
              Mappings](https://polygon.io/docs/get_v3_reference_conditions)

              for a mapping to exchange conditions.
            type: integer
          type: array
        i:
          description: >
            The Trade ID which uniquely identifies a trade. These are unique per

            combination of ticker, exchange, and TRF. For example: A trade for
            AAPL

            executed on NYSE and a trade for AAPL executed on NASDAQ could
            potentially

            have the same Trade ID.
          type: string
        p:
          description: >
            The price of the trade. This is the actual dollar value per whole
            share of

            this trade. A trade of 100 shares with a price of $2.00 would be
            worth a

            total dollar value of $200.00.
          format: double
          type: number
        s:
          description: |
            The size of a trade (also known as volume).
          format: double
          type: number
        t:
          description: The Unix Msec timestamp for the start of the aggregate window.
          type: integer
        x:
          description: |
            The exchange that this crypto trade happened on.  
            See <a href="https://polygon.io/docs/crypto/get_v3_reference_exchanges">Exchanges</a> for a mapping of exchanges to IDs.
          type: integer
      required:
        - p
        - s
        - x
        - c
        - t
        - i
      type: object
    CryptoTradeExchange:
      description: |
        The exchange that this crypto trade happened on.  
        See <a href="https://polygon.io/docs/crypto/get_v3_reference_exchanges">Exchanges</a> for a mapping of exchanges to IDs.
      type: integer
    Date:
      oneOf:
        - format: date-time
          type: string
        - format: date
          type: string
    Exchange:
      items:
        properties:
          code:
            description: A unique identifier for the exchange internal to Polygon.io.  This
              is not an industry code or ISO standard.
            type: string
          id:
            description: The ID of the exchange.
            type: number
          market:
            description: The market data type that this exchange contains.
            type: string
          mic:
            description: The Market Identification Code or MIC as defined in ISO 10383 (<a
              rel="nofollow" target="_blank"
              href="https://en.wikipedia.org/wiki/Market_Identifier_Code">https://en.wikipedia.org/wiki/Market_Identifier_Code</a>).
            type: string
          name:
            description: The name of the exchange.
            type: string
          tape:
            description: The tape id of the exchange.
            type: string
          type:
            description: |
              The type of exchange.
              - TRF = Trade Reporting Facility
              - exchange = Reporting exchange on the tape
            type: string
        type: object
      type: array
    ExchangeId:
      description: The exchange ID. See <a
        href="https://polygon.io/docs/stocks/get_v3_reference_exchanges"
        alt="Exchanges">Exchanges</a> for Polygon.io's mapping of exchange IDs.
      type: integer
    Financial:
      properties:
        cashChange:
          example: 7202000000
          type: integer
        cashFlow:
          example: 28293000000
          type: integer
        costOfRevenue:
          example: 54381000000
          type: integer
        currentAssets:
          example: 143810000000
          type: integer
        currentCash:
          example: 27491000000
          type: integer
        currentDebt:
          example: 18478000000
          type: integer
        grossProfit:
          example: 33912000000
          type: integer
        netIncome:
          example: 20065000000
          type: integer
        operatingExpense:
          example: 7638000000
          type: integer
        operatingGainsLosses:
          type: number
        operatingIncome:
          example: 26274000000
          type: integer
        operatingRevenue:
          example: 88293000000
          type: integer
        reportDate:
          description: Report Date
          example: 2017-12-31T00:00:00.000Z
          format: date-time
          type: string
        reportDateStr:
          description: Report date as non date format
          example: 2017-12-31
          type: string
        researchAndDevelopment:
          example: 3407000000
          type: integer
        shareholderEquity:
          example: 140199000000
          type: integer
        symbol:
          description: Stock Symbol
          example: AAPL
          type: string
        totalAssets:
          example: 406794000000
          type: integer
        totalCash:
          example: 77153000000
          type: integer
        totalDebt:
          example: 122400000000
          type: integer
        totalLiabilities:
          example: 266595000000
          type: integer
        totalRevenue:
          example: 88293000000
          type: integer
      required:
        - symbol
        - reportDate
        - reportDateStr
      type: object
    Financials:
      description: Financials
      properties:
        EBITDAMargin:
          format: double
          type: number
        accumulatedOtherComprehensiveIncome:
          type: integer
        accumulatedRetainedEarningsDeficit:
          type: integer
        assetTurnover:
          type: integer
        assets:
          type: integer
        assetsAverage:
          type: integer
        assetsCurrent:
          type: integer
        assetsNonCurrent:
          type: integer
        averageEquity:
          type: integer
        bookValuePerShare:
          format: double
          type: number
        calendarDate:
          example: 2019-03-31
          format: date-time
          type: string
        capitalExpenditure:
          type: integer
        cashAndEquivalents:
          type: integer
        cashAndEquivalentsUSD:
          type: integer
        consolidatedIncome:
          type: integer
        costOfRevenue:
          type: integer
        currentLiabilities:
          type: integer
        currentRatio:
          format: double
          type: number
        debt:
          type: integer
        debtCurrent:
          type: integer
        debtNonCurrent:
          type: integer
        debtToEquityRatio:
          format: double
          type: number
        debtUSD:
          type: integer
        deferredRevenue:
          type: integer
        deposits:
          type: integer
        depreciationAmortizationAndAccretion:
          type: integer
        dividendYield:
          type: integer
        dividendsPerBasicCommonShare:
          type: integer
        earningBeforeInterestTaxes:
          type: integer
        earningBeforeInterestTaxesUSD:
          type: integer
        earningsBeforeInterestTaxesDepreciationAmortization:
          type: integer
        earningsBeforeInterestTaxesDepreciationAmortizationUSD:
          type: integer
        earningsBeforeTax:
          type: integer
        earningsPerBasicShare:
          format: double
          type: number
        earningsPerBasicShareUSD:
          format: double
          type: number
        earningsPerDilutedShare:
          format: double
          type: number
        effectOfExchangeRateChangesOnCash:
          type: integer
        enterpriseValue:
          type: integer
        enterpriseValueOverEBIT:
          type: integer
        enterpriseValueOverEBITDA:
          format: double
          type: number
        foreignCurrencyUSDExchangeRate:
          type: integer
        freeCashFlow:
          type: integer
        freeCashFlowPerShare:
          format: double
          type: number
        goodwillAndIntangibleAssets:
          type: integer
        grossMargin:
          format: double
          type: number
        grossProfit:
          type: integer
        incomeTaxExpense:
          type: integer
        interestExpense:
          type: integer
        inventory:
          type: integer
        investedCapital:
          type: integer
        investedCapitalAverage:
          type: integer
        investments:
          type: integer
        investmentsCurrent:
          type: integer
        investmentsNonCurrent:
          type: integer
        issuanceDebtSecurities:
          type: integer
        issuanceEquityShares:
          type: integer
        liabilitiesNonCurrent:
          type: integer
        marketCapitalization:
          type: integer
        netCashFlow:
          type: integer
        netCashFlowBusinessAcquisitionsDisposals:
          type: integer
        netCashFlowFromFinancing:
          type: integer
        netCashFlowFromInvesting:
          type: integer
        netCashFlowFromOperations:
          type: integer
        netCashFlowInvestmentAcquisitionsDisposals:
          type: integer
        netIncome:
          type: integer
        netIncomeCommonStock:
          type: integer
        netIncomeCommonStockUSD:
          type: integer
        netIncomeToNonControllingInterests:
          type: integer
        netLossIncomeFromDiscontinuedOperations:
          type: integer
        operatingExpenses:
          type: integer
        operatingIncome:
          type: integer
        paymentDividendsOtherCashDistributions:
          type: integer
        payoutRatio:
          type: integer
        period:
          description: Reporting period.
          enum:
            - Q
            - T
            - QA
            - TA
            - Y
            - YA
          example: Q
          type: string
        preferredDividendsIncomeStatementImpact:
          type: integer
        priceEarnings:
          format: double
          type: number
        priceSales:
          format: double
          type: number
        priceToBookValue:
          format: double
          type: number
        priceToEarningsRatio:
          format: double
          type: number
        priceToSalesRatio:
          format: double
          type: number
        profitMargin:
          format: double
          type: number
        propertyPlantEquipmentNet:
          type: integer
        reportPeriod:
          example: 2019-03-31
          format: date-time
          type: string
        researchAndDevelopmentExpense:
          type: integer
        returnOnAverageAssets:
          type: integer
        returnOnAverageEquity:
          type: integer
        returnOnInvestedCapital:
          type: integer
        returnOnSales:
          format: double
          type: number
        revenues:
          type: integer
        revenuesUSD:
          type: integer
        salesPerShare:
          format: double
          type: number
        sellingGeneralAndAdministrativeExpense:
          type: integer
        shareBasedCompensation:
          type: integer
        shareFactor:
          type: integer
        sharePriceAdjustedClose:
          format: double
          type: number
        shareholdersEquity:
          type: integer
        shareholdersEquityUSD:
          type: integer
        shares:
          type: integer
        tangibleAssetValue:
          type: integer
        tangibleAssetsBookValuePerShare:
          format: double
          type: number
        taxAssets:
          type: integer
        taxLiabilities:
          type: integer
        ticker:
          description: The exchange symbol that this item is traded under.
          type: string
        totalLiabilities:
          type: integer
        tradeAndNonTradePayables:
          type: integer
        tradeAndNonTradeReceivables:
          type: integer
        updated:
          example: 1999-03-28
          format: date-time
          type: string
        weightedAverageShares:
          type: integer
        weightedAverageSharesDiluted:
          type: integer
        workingCapital:
          type: integer
      required:
        - ticker
        - exDate
        - paymentDate
        - ratio
        - tofactor
        - forfactor
      type: object
    Fmv:
      description: Fair market value is only available on Business plans. It is our
        proprietary algorithm to generate a real-time, accurate, fair market
        value of a tradable security. For more information, <a rel="nofollow"
        target="_blank" href="https://polygon.io/contact">contact us</a>.
      format: double
      type: number
    ForexConversion:
      properties:
        converted:
          description: The result of the conversion.
          format: double
          type: number
        from:
          description: The "from" currency symbol.
          type: string
        initialAmount:
          description: The amount to convert.
          format: double
          type: number
        last:
          properties:
            ask:
              description: The ask price.
              format: double
              type: number
            bid:
              description: The bid price.
              format: double
              type: number
            exchange:
              description: The exchange ID. See <a
                href="https://polygon.io/docs/forex/get_v3_reference_exchanges"
                alt="Exchanges">Exchanges</a> for Polygon.io's mapping of
                exchange IDs.
              type: integer
            timestamp:
              description: The Unix Msec timestamp for the start of the aggregate window.
              type: integer
          required:
            - ask
            - bid
            - exchange
            - timestamp
          type: object
        to:
          description: The "to" currency symbol.
          type: string
      required:
        - from
        - to
        - initialAmount
        - converted
      type: object
    ForexExchangeId:
      description: The exchange ID. See <a
        href="https://polygon.io/docs/forex/get_v3_reference_exchanges"
        alt="Exchanges">Exchanges</a> for Polygon.io's mapping of exchange IDs.
      type: integer
    ForexGroupedResults:
      properties:
        results:
          items:
            properties:
              T:
                description: The exchange symbol that this item is traded under.
                type: string
              c:
                description: The close price for the symbol in the given time period.
                format: double
                type: number
              h:
                description: The highest price for the symbol in the given time period.
                format: double
                type: number
              l:
                description: The lowest price for the symbol in the given time period.
                format: double
                type: number
              n:
                description: The number of transactions in the aggregate window.
                type: integer
              o:
                description: The open price for the symbol in the given time period.
                format: double
                type: number
              t:
                description: The Unix Msec timestamp for the start of the aggregate window.
                type: integer
              v:
                description: The trading volume of the symbol in the given time period.
                format: double
                type: number
              vw:
                description: The volume weighted average price.
                format: double
                type: number
            required:
              - o
              - h
              - l
              - c
              - v
              - t
              - T
            type: object
          type: array
      type: object
    ForexHistoricTrades:
      properties:
        day:
          description: The date that was evaluated from the request.
          format: date
          type: string
        map:
          description: A map for shortened result keys.
          type: object
        msLatency:
          description: The milliseconds of latency for the query results.
          type: integer
        pair:
          description: The currency pair that was evaluated from the request.
          type: string
        ticks:
          items:
            properties:
              a:
                description: The ask price.
                format: double
                type: number
              b:
                description: The bid price.
                format: double
                type: number
              t:
                description: The Unix Msec timestamp for the start of the aggregate window.
                type: integer
              x:
                description: The exchange ID. See <a
                  href="https://polygon.io/docs/forex/get_v3_reference_exchanges"
                  alt="Exchanges">Exchanges</a> for Polygon.io's mapping of
                  exchange IDs.
                type: integer
            required:
              - a
              - b
              - x
              - t
            type: object
          type: array
      required:
        - day
        - map
        - msLatency
        - pair
        - ticks
      type: object
    ForexPairLastQuote:
      properties:
        last:
          properties:
            ask:
              description: The ask price.
              format: double
              type: number
            bid:
              description: The bid price.
              format: double
              type: number
            exchange:
              description: The exchange ID. See <a
                href="https://polygon.io/docs/forex/get_v3_reference_exchanges"
                alt="Exchanges">Exchanges</a> for Polygon.io's mapping of
                exchange IDs.
              type: integer
            timestamp:
              description: The Unix Msec timestamp for the start of the aggregate window.
              type: integer
          required:
            - ask
            - bid
            - exchange
            - timestamp
          type: object
        symbol:
          description: The symbol pair that was evaluated from the request.
          type: string
      required:
        - symbol
      type: object
    ForexPreviousClose:
      properties:
        results:
          items:
            properties:
              T:
                description: The exchange symbol that this item is traded under.
                type: string
              c:
                description: The close price for the symbol in the given time period.
                format: double
                type: number
              h:
                description: The highest price for the symbol in the given time period.
                format: double
                type: number
              l:
                description: The lowest price for the symbol in the given time period.
                format: double
                type: number
              n:
                description: The number of transactions in the aggregate window.
                type: integer
              o:
                description: The open price for the symbol in the given time period.
                format: double
                type: number
              t:
                description: The Unix Msec timestamp for the start of the aggregate window.
                type: integer
              v:
                description: The trading volume of the symbol in the given time period.
                format: double
                type: number
              vw:
                description: The volume weighted average price.
                format: double
                type: number
            required:
              - T
              - v
              - o
              - c
              - h
              - l
              - t
            type: object
          type: array
      type: object
    ForexSnapshotLastQuote:
      properties:
        a:
          description: The ask price.
          format: double
          type: number
        b:
          description: The bid price.
          format: double
          type: number
        t:
          description: The millisecond accuracy timestamp of the quote.
          type: integer
        x:
          description: The exchange ID on which this quote happened.
          type: integer
      required:
        - a
        - b
        - t
        - x
      type: object
    ForexSnapshotPrevDay:
      properties:
        c:
          description: The close price for the symbol in the given time period.
          format: double
          type: number
        h:
          description: The highest price for the symbol in the given time period.
          format: double
          type: number
        l:
          description: The lowest price for the symbol in the given time period.
          format: double
          type: number
        o:
          description: The open price for the symbol in the given time period.
          format: double
          type: number
        v:
          description: The trading volume of the symbol in the given time period.
          format: double
          type: number
        vw:
          description: The volume weighted average price.
          format: double
          type: number
      required:
        - o
        - h
        - l
        - c
        - v
        - vw
      type: object
    ForexSnapshotTicker:
      properties:
        ticker:
          properties:
            day:
              description: The most recent daily bar for this ticker.
              properties:
                c:
                  description: The close price for the symbol in the given time period.
                  format: double
                  type: number
                h:
                  description: The highest price for the symbol in the given time period.
                  format: double
                  type: number
                l:
                  description: The lowest price for the symbol in the given time period.
                  format: double
                  type: number
                o:
                  description: The open price for the symbol in the given time period.
                  format: double
                  type: number
                v:
                  description: The trading volume of the symbol in the given time period.
                  format: double
                  type: number
              required:
                - o
                - h
                - l
                - c
                - v
              type: object
            fmv:
              description: Fair market value is only available on Business plans. It is our
                proprietary algorithm to generate a real-time, accurate, fair
                market value of a tradable security. For more information, <a
                rel="nofollow" target="_blank"
                href="https://polygon.io/contact">contact us</a>.
              format: double
              type: number
            lastQuote:
              description: The most recent quote for this ticker.
              properties:
                a:
                  description: The ask price.
                  format: double
                  type: number
                b:
                  description: The bid price.
                  format: double
                  type: number
                t:
                  description: The millisecond accuracy timestamp of the quote.
                  type: integer
                x:
                  description: The exchange ID on which this quote happened.
                  type: integer
              required:
                - a
                - b
                - t
                - x
              type: object
            min:
              description: The most recent minute bar for this ticker.
              properties:
                c:
                  description: The close price for the symbol in the given time period.
                  format: double
                  type: number
                h:
                  description: The highest price for the symbol in the given time period.
                  format: double
                  type: number
                l:
                  description: The lowest price for the symbol in the given time period.
                  format: double
                  type: number
                n:
                  description: The number of transactions in the aggregate window.
                  type: integer
                o:
                  description: The open price for the symbol in the given time period.
                  format: double
                  type: number
                t:
                  description: The Unix Msec timestamp for the start of the aggregate window.
                  type: integer
                v:
                  description: The trading volume of the symbol in the given time period.
                  format: double
                  type: number
              type: object
            prevDay:
              description: The previous day's bar for this ticker.
              properties:
                c:
                  description: The close price for the symbol in the given time period.
                  format: double
                  type: number
                h:
                  description: The highest price for the symbol in the given time period.
                  format: double
                  type: number
                l:
                  description: The lowest price for the symbol in the given time period.
                  format: double
                  type: number
                o:
                  description: The open price for the symbol in the given time period.
                  format: double
                  type: number
                v:
                  description: The trading volume of the symbol in the given time period.
                  format: double
                  type: number
                vw:
                  description: The volume weighted average price.
                  format: double
                  type: number
              required:
                - o
                - h
                - l
                - c
                - v
                - vw
              type: object
            ticker:
              description: The exchange symbol that this item is traded under.
              type: string
            todaysChange:
              description: The value of the change from the previous day.
              format: double
              type: number
            todaysChangePerc:
              description: The percentage change since the previous day.
              format: double
              type: number
            updated:
              description: The last updated timestamp.
              type: integer
          required:
            - day
            - lastQuote
            - min
            - prevDay
            - ticker
            - todaysChange
            - todaysChangePerc
            - updated
          type: object
      type: object
    ForexSnapshotTickers:
      properties:
        tickers:
          items:
            properties:
              day:
                description: The most recent daily bar for this ticker.
                properties:
                  c:
                    description: The close price for the symbol in the given time period.
                    format: double
                    type: number
                  h:
                    description: The highest price for the symbol in the given time period.
                    format: double
                    type: number
                  l:
                    description: The lowest price for the symbol in the given time period.
                    format: double
                    type: number
                  o:
                    description: The open price for the symbol in the given time period.
                    format: double
                    type: number
                  v:
                    description: The trading volume of the symbol in the given time period.
                    format: double
                    type: number
                required:
                  - o
                  - h
                  - l
                  - c
                  - v
                type: object
              fmv:
                description: Fair market value is only available on Business plans. It is our
                  proprietary algorithm to generate a real-time, accurate, fair
                  market value of a tradable security. For more information, <a
                  rel="nofollow" target="_blank"
                  href="https://polygon.io/contact">contact us</a>.
                format: double
                type: number
              lastQuote:
                description: The most recent quote for this ticker.
                properties:
                  a:
                    description: The ask price.
                    format: double
                    type: number
                  b:
                    description: The bid price.
                    format: double
                    type: number
                  t:
                    description: The millisecond accuracy timestamp of the quote.
                    type: integer
                  x:
                    description: The exchange ID on which this quote happened.
                    type: integer
                required:
                  - a
                  - b
                  - t
                  - x
                type: object
              min:
                description: The most recent minute bar for this ticker.
                properties:
                  c:
                    description: The close price for the symbol in the given time period.
                    format: double
                    type: number
                  h:
                    description: The highest price for the symbol in the given time period.
                    format: double
                    type: number
                  l:
                    description: The lowest price for the symbol in the given time period.
                    format: double
                    type: number
                  n:
                    description: The number of transactions in the aggregate window.
                    type: integer
                  o:
                    description: The open price for the symbol in the given time period.
                    format: double
                    type: number
                  t:
                    description: The Unix Msec timestamp for the start of the aggregate window.
                    type: integer
                  v:
                    description: The trading volume of the symbol in the given time period.
                    format: double
                    type: number
                type: object
              prevDay:
                description: The previous day's bar for this ticker.
                properties:
                  c:
                    description: The close price for the symbol in the given time period.
                    format: double
                    type: number
                  h:
                    description: The highest price for the symbol in the given time period.
                    format: double
                    type: number
                  l:
                    description: The lowest price for the symbol in the given time period.
                    format: double
                    type: number
                  o:
                    description: The open price for the symbol in the given time period.
                    format: double
                    type: number
                  v:
                    description: The trading volume of the symbol in the given time period.
                    format: double
                    type: number
                  vw:
                    description: The volume weighted average price.
                    format: double
                    type: number
                required:
                  - o
                  - h
                  - l
                  - c
                  - v
                  - vw
                type: object
              ticker:
                description: The exchange symbol that this item is traded under.
                type: string
              todaysChange:
                description: The value of the change from the previous day.
                format: double
                type: number
              todaysChangePerc:
                description: The percentage change since the previous day.
                format: double
                type: number
              updated:
                description: The last updated timestamp.
                type: integer
            required:
              - day
              - lastQuote
              - min
              - prevDay
              - ticker
              - todaysChange
              - todaysChangePerc
              - updated
            type: object
          type: array
      type: object
    ForexTickerResults:
      properties:
        results:
          items:
            properties:
              c:
                description: The close price for the symbol in the given time period.
                format: double
                type: number
              h:
                description: The highest price for the symbol in the given time period.
                format: double
                type: number
              l:
                description: The lowest price for the symbol in the given time period.
                format: double
                type: number
              n:
                description: The number of transactions in the aggregate window.
                type: integer
              o:
                description: The open price for the symbol in the given time period.
                format: double
                type: number
              t:
                description: The Unix Msec timestamp for the start of the aggregate window.
                type: integer
              v:
                description: The trading volume of the symbol in the given time period.
                format: double
                type: number
              vw:
                description: The volume weighted average price.
                format: double
                type: number
            required:
              - o
              - h
              - l
              - c
              - v
              - t
            type: object
          type: array
      type: object
    High:
      description: The highest price for the symbol in the given time period.
      format: double
      type: number
    HighIndices:
      description: The highest value for the symbol in the given time period.
      format: double
      type: number
    IndexAggsBase:
      properties:
        queryCount:
          description: The number of aggregates (minute or day) used to generate the
            response.
          type: integer
        request_id:
          description: A request id assigned by the server.
          type: string
        resultsCount:
          description: The total number of results for this request.
          type: integer
        status:
          description: The status of this request's response.
          type: string
      required:
        - status
        - queryCount
        - resultsCount
        - request_id
      type: object
    Indicators:
      description: |
        The indicators. For more information, see our glossary of [Conditions and
        Indicators](https://polygon.io/glossary/us/stocks/conditions-indicators).
      items:
        description: |
          The indicator code.
        type: integer
      type: array
    IndicesGroupedResults:
      properties:
        results:
          items:
            properties:
              c:
                description: The close value for the symbol in the given time period.
                format: double
                type: number
              h:
                description: The highest value for the symbol in the given time period.
                format: double
                type: number
              l:
                description: The lowest value for the symbol in the given time period.
                format: double
                type: number
              o:
                description: The open value for the symbol in the given time period.
                format: double
                type: number
              t:
                description: The Unix Msec timestamp for the start of the aggregate window.
                type: integer
            required:
              - o
              - h
              - l
              - c
              - t
            type: object
          type: array
      type: object
    IndicesOpenClose:
      properties:
        afterHours:
          description: The close value of the ticker symbol in after hours trading.
          format: double
          type: number
        close:
          description: The close value for the symbol in the given time period.
          format: double
          type: number
        from:
          description: The requested date.
          format: date
          type: string
        high:
          description: The highest value for the symbol in the given time period.
          format: double
          type: number
        low:
          description: The lowest value for the symbol in the given time period.
          format: double
          type: number
        open:
          description: The open value for the symbol in the given time period.
          format: double
          type: number
        preMarket:
          description: The open value of the ticker symbol in pre-market trading.
          type: integer
        status:
          description: The status of this request's response.
          type: string
        symbol:
          description: The exchange symbol that this item is traded under.
          type: string
      required:
        - status
        - from
        - symbol
        - open
        - high
        - low
        - close
      type: object
    IndicesTickerResults:
      properties:
        results:
          items:
            properties:
              c:
                description: The close value for the symbol in the given time period.
                format: double
                type: number
              h:
                description: The highest value for the symbol in the given time period.
                format: double
                type: number
              l:
                description: The lowest value for the symbol in the given time period.
                format: double
                type: number
              n:
                description: The number of transactions in the aggregate window.
                type: integer
              o:
                description: The open value for the symbol in the given time period.
                format: double
                type: number
              t:
                description: The Unix Msec timestamp for the start of the aggregate window.
                type: integer
            required:
              - o
              - h
              - l
              - c
              - t
            type: object
          type: array
      type: object
    Locales:
      properties:
        results:
          items:
            properties:
              locale:
                description: An abbreviated country name.
                type: string
              name:
                description: The name of the country.
                type: string
            type: object
          type: array
      type: object
    Low:
      description: The lowest price for the symbol in the given time period.
      format: double
      type: number
    LowIndices:
      description: The lowest value for the symbol in the given time period.
      format: double
      type: number
    Map:
      description: A mapping of the keys returned in the results to their descriptive
        name and data types.
      properties:
        key:
          description: A dynamic key from the results set
          properties:
            name:
              description: The descriptive name of this results key
              type: string
            type:
              description: The data type of this results key
              enum:
                - string
                - int
                - int64
                - float64
              type: string
          type: object
      type: object
    MarketHoliday:
      items:
        properties:
          close:
            description: The market close time on the holiday (if it's not closed).
            format: date-time
            type: string
          date:
            description: The date of the holiday.
            format: date
            type: string
          exchange:
            description: Which market the record is for.
            type: string
          name:
            description: The name of the holiday.
            type: string
          open:
            description: The market open time on the holiday (if it's not closed).
            format: date-time
            type: string
          status:
            description: The status of the market on the holiday.
            type: string
        type: object
      type: array
    MarketStatus:
      properties:
        afterHours:
          description: Whether or not the market is in post-market hours.
          type: boolean
        currencies:
          properties:
            crypto:
              description: The status of the crypto market.
              type: string
            fx:
              description: The status of the forex market.
              type: string
          type: object
        earlyHours:
          description: Whether or not the market is in pre-market hours.
          type: boolean
        exchanges:
          properties:
            nasdaq:
              description: The status of the Nasdaq market.
              type: string
            nyse:
              description: The status of the NYSE market.
              type: string
            otc:
              description: The status of the OTC market.
              type: string
          type: object
        market:
          description: The status of the market as a whole.
          type: string
        serverTime:
          description: The current time of the server.
          format: date-time
          type: string
      type: object
    Markets:
      properties:
        results:
          description: A list of supported markets.
          items:
            properties:
              desc:
                description: A description of the market.
                type: string
              market:
                description: The name of the market.
                type: string
            type: object
          type: array
      type: object
    MsLatency:
      description: The milliseconds of latency for the query results.
      type: integer
    News:
      items:
        properties:
          image:
            description: A URL of the image for the news article, if found.
            type: string
          keywords:
            description: A list of common keywords related to the news article.
            items:
              description: Common keywords of the news article.
              type: string
            type: array
          source:
            description: The publication source of the article.
            type: string
          summary:
            description: A summary of the news article.
            type: string
          symbols:
            description: A list of ticker symbols relating to the article.
            items:
              description: The exchange symbol that this item is traded under.
              type: string
            type: array
          timestamp:
            description: The timestamp of the news article.
            format: date-time
            type: string
          title:
            description: The title of the news article.
            type: string
          url:
            description: A direct link to the news article from its source publication.
            type: string
        type: object
      type: array
    NumberOfItems:
      description: The number of transactions in the aggregate window.
      type: integer
    OTC:
      description: Whether or not this aggregate is for an OTC ticker. This field will
        be left off if false.
      type: boolean
    Open:
      description: The open price for the symbol in the given time period.
      format: double
      type: number
    OpenIndices:
      description: The open value for the symbol in the given time period.
      format: double
      type: number
    PaginationHooksBase:
      properties:
        next_url:
          description: If present, this value can be used to fetch the next page of data.
          type: string
      type: object
    Price:
      description: >
        The price of the trade. This is the actual dollar value per whole share
        of

        this trade. A trade of 100 shares with a price of $2.00 would be worth a

        total dollar value of $200.00.
      format: double
      type: number
    QueryCount:
      description: The number of aggregates (minute or day) used to generate the response.
      type: integer
    RatingSection:
      properties:
        current:
          description: Analyst Rating at current month
          example: 0
          type: number
        month1:
          description: Analyst Ratings at 1 month in the future
          example: 1
          type: number
        month2:
          description: Analyst Ratings at 2 month in the future
          example: 3
          type: number
        month3:
          description: Analyst Ratings at 3 month in the future
          example: 4
          type: number
        month4:
          description: Analyst Ratings at 4 month in the future
          example: 3
          type: number
        month5:
          description: Analyst Ratings at 5 month in the future
          example: 2
          type: number
      required:
        - month1
        - month2
        - month3
        - current
      type: object
    RequestID:
      description: A request id assigned by the server.
      type: string
    RequestIdBase:
      properties:
        request_id:
          description: A request id assigned by the server.
          type: string
      required:
        - request_id
      type: object
    SequenceNumber:
      description: >
        The sequence number represents the sequence in which message events
        happened.

        These are increasing and unique per ticker symbol, but will not always
        be

        sequential (e.g., 1, 2, 6, 9, 10, 11).
      format: int64
      type: integer
    Size:
      description: |
        The size of a trade (also known as volume).
      format: double
      type: number
    SnapshotMinOHLCV:
      properties:
        c:
          description: The close price for the symbol in the given time period.
          format: double
          type: number
        h:
          description: The highest price for the symbol in the given time period.
          format: double
          type: number
        l:
          description: The lowest price for the symbol in the given time period.
          format: double
          type: number
        n:
          description: The number of transactions in the aggregate window.
          type: integer
        o:
          description: The open price for the symbol in the given time period.
          format: double
          type: number
        t:
          description: The Unix Msec timestamp for the start of the aggregate window.
          type: integer
        v:
          description: The trading volume of the symbol in the given time period.
          format: double
          type: number
      type: object
    SnapshotOHLCV:
      properties:
        c:
          description: The close price for the symbol in the given time period.
          format: double
          type: number
        h:
          description: The highest price for the symbol in the given time period.
          format: double
          type: number
        l:
          description: The lowest price for the symbol in the given time period.
          format: double
          type: number
        o:
          description: The open price for the symbol in the given time period.
          format: double
          type: number
        v:
          description: The trading volume of the symbol in the given time period.
          format: double
          type: number
      required:
        - o
        - h
        - l
        - c
        - v
      type: object
    SnapshotOHLCVVW:
      properties:
        c:
          description: The close price for the symbol in the given time period.
          format: double
          type: number
        h:
          description: The highest price for the symbol in the given time period.
          format: double
          type: number
        l:
          description: The lowest price for the symbol in the given time period.
          format: double
          type: number
        o:
          description: The open price for the symbol in the given time period.
          format: double
          type: number
        v:
          description: The trading volume of the symbol in the given time period.
          format: double
          type: number
        vw:
          description: The volume weighted average price.
          format: double
          type: number
      required:
        - o
        - h
        - l
        - c
        - v
        - vw
      type: object
    SnapshotOHLCVVWOtc:
      properties:
        c:
          description: The close price for the symbol in the given time period.
          format: double
          type: number
        h:
          description: The highest price for the symbol in the given time period.
          format: double
          type: number
        l:
          description: The lowest price for the symbol in the given time period.
          format: double
          type: number
        o:
          description: The open price for the symbol in the given time period.
          format: double
          type: number
        otc:
          description: Whether or not this aggregate is for an OTC ticker. This field will
            be left off if false.
          type: boolean
        v:
          description: The trading volume of the symbol in the given time period.
          format: double
          type: number
        vw:
          description: The volume weighted average price.
          format: double
          type: number
      required:
        - o
        - h
        - l
        - c
        - v
        - vw
      type: object
    StandardBase:
      allOf:
        - properties:
            request_id:
              description: A request id assigned by the server.
              type: string
          required:
            - request_id
          type: object
        - properties:
            count:
              description: The total number of results for this request.
              type: integer
            status:
              description: The status of this request's response.
              type: string
          required:
            - status
          type: object
    Status:
      description: The status of this request's response.
      type: string
    StatusBase:
      properties:
        status:
          description: The status of this request's response.
          type: string
      required:
        - status
      type: object
    StatusCountBase:
      properties:
        count:
          description: The total number of results for this request.
          type: integer
        status:
          description: The status of this request's response.
          type: string
      required:
        - status
      type: object
    StockSymbol:
      description: The exchange symbol that this item is traded under.
      type: string
    StocksGroupedResults:
      properties:
        results:
          items:
            properties:
              T:
                description: The exchange symbol that this item is traded under.
                type: string
              c:
                description: The close price for the symbol in the given time period.
                format: double
                type: number
              h:
                description: The highest price for the symbol in the given time period.
                format: double
                type: number
              l:
                description: The lowest price for the symbol in the given time period.
                format: double
                type: number
              n:
                description: The number of transactions in the aggregate window.
                type: integer
              o:
                description: The open price for the symbol in the given time period.
                format: double
                type: number
              otc:
                description: Whether or not this aggregate is for an OTC ticker. This field will
                  be left off if false.
                type: boolean
              t:
                description: The Unix Msec timestamp for the end of the aggregate window.
                type: integer
              v:
                description: The trading volume of the symbol in the given time period.
                format: double
                type: number
              vw:
                description: The volume weighted average price.
                format: double
                type: number
            required:
              - o
              - h
              - l
              - c
              - t
              - v
              - T
            type: object
          type: array
      type: object
    StocksOpenClose:
      properties:
        afterHours:
          description: The close price of the ticker symbol in after hours trading.
          format: double
          type: number
        close:
          description: The close price for the symbol in the given time period.
          format: double
          type: number
        from:
          description: The requested date.
          format: date
          type: string
        high:
          description: The highest price for the symbol in the given time period.
          format: double
          type: number
        low:
          description: The lowest price for the symbol in the given time period.
          format: double
          type: number
        open:
          description: The open price for the symbol in the given time period.
          format: double
          type: number
        otc:
          description: Whether or not this aggregate is for an OTC ticker. This field will
            be left off if false.
          type: boolean
        preMarket:
          description: The open price of the ticker symbol in pre-market trading.
          type: integer
        status:
          description: The status of this request's response.
          type: string
        symbol:
          description: The exchange symbol that this item is traded under.
          type: string
        volume:
          description: The trading volume of the symbol in the given time period.
          format: double
          type: number
      required:
        - status
        - from
        - symbol
        - open
        - high
        - low
        - close
        - volume
      type: object
    StocksSnapshotLastQuote:
      properties:
        P:
          description: The ask price.
          format: double
          type: number
        S:
          description: The ask size in lots.
          type: integer
        p:
          description: The bid price.
          format: double
          type: number
        s:
          description: The bid size in lots.
          type: integer
        t:
          description: The nanosecond accuracy SIP Unix Timestamp. This is the timestamp
            of when the SIP received this message from the exchange which
            produced it.
          type: integer
      required:
        - p
        - s
        - P
        - S
        - t
      type: object
    StocksSnapshotMinute:
      properties:
        av:
          description: The accumulated volume.
          type: integer
        c:
          description: The close price for the symbol in the given time period.
          format: double
          type: number
        h:
          description: The highest price for the symbol in the given time period.
          format: double
          type: number
        l:
          description: The lowest price for the symbol in the given time period.
          format: double
          type: number
        n:
          description: The number of transactions in the aggregate window.
          type: integer
        o:
          description: The open price for the symbol in the given time period.
          format: double
          type: number
        t:
          description: The Unix Msec timestamp for the start of the aggregate window.
          type: integer
        v:
          description: The trading volume of the symbol in the given time period.
          format: double
          type: number
        vw:
          description: The volume weighted average price.
          format: double
          type: number
      required:
        - av
        - o
        - h
        - l
        - c
        - v
        - vw
        - t
        - n
      type: object
    StocksSnapshotMinuteOTC:
      properties:
        av:
          description: The accumulated volume.
          type: integer
        c:
          description: The close price for the symbol in the given time period.
          format: double
          type: number
        h:
          description: The highest price for the symbol in the given time period.
          format: double
          type: number
        l:
          description: The lowest price for the symbol in the given time period.
          format: double
          type: number
        n:
          description: The number of transactions in the aggregate window.
          type: integer
        o:
          description: The open price for the symbol in the given time period.
          format: double
          type: number
        otc:
          description: Whether or not this aggregate is for an OTC ticker. This field will
            be left off if false.
          type: boolean
        t:
          description: The Unix Msec timestamp for the start of the aggregate window.
          type: integer
        v:
          description: The trading volume of the symbol in the given time period.
          format: double
          type: number
        vw:
          description: The volume weighted average price.
          format: double
          type: number
      required:
        - av
        - o
        - h
        - l
        - c
        - v
        - vw
        - t
        - n
      type: object
    StocksSnapshotTicker:
      properties:
        ticker:
          properties:
            day:
              description: The most recent daily bar for this ticker.
              properties:
                c:
                  description: The close price for the symbol in the given time period.
                  format: double
                  type: number
                h:
                  description: The highest price for the symbol in the given time period.
                  format: double
                  type: number
                l:
                  description: The lowest price for the symbol in the given time period.
                  format: double
                  type: number
                o:
                  description: The open price for the symbol in the given time period.
                  format: double
                  type: number
                otc:
                  description: Whether or not this aggregate is for an OTC ticker. This field will
                    be left off if false.
                  type: boolean
                v:
                  description: The trading volume of the symbol in the given time period.
                  format: double
                  type: number
                vw:
                  description: The volume weighted average price.
                  format: double
                  type: number
              required:
                - o
                - h
                - l
                - c
                - v
                - vw
              type: object
            fmv:
              description: Fair market value is only available on Business plans. It is our
                proprietary algorithm to generate a real-time, accurate, fair
                market value of a tradable security. For more information, <a
                rel="nofollow" target="_blank"
                href="https://polygon.io/contact">contact us</a>.
              format: double
              type: number
            lastQuote:
              description: The most recent quote for this ticker.  This is only returned if
                your current plan includes quotes.
              properties:
                P:
                  description: The ask price.
                  format: double
                  type: number
                S:
                  description: The ask size in lots.
                  type: integer
                p:
                  description: The bid price.
                  format: double
                  type: number
                s:
                  description: The bid size in lots.
                  type: integer
                t:
                  description: The nanosecond accuracy SIP Unix Timestamp. This is the timestamp
                    of when the SIP received this message from the exchange
                    which produced it.
                  type: integer
              required:
                - p
                - s
                - P
                - S
                - t
              type: object
            lastTrade:
              description: The most recent trade for this ticker.  This is only returned if
                your current plan includes trades.
              properties:
                c:
                  description: The trade conditions.
                  items:
                    type: integer
                  type: array
                i:
                  description: >
                    The Trade ID which uniquely identifies a trade. These are
                    unique per

                    combination of ticker, exchange, and TRF. For example: A
                    trade for AAPL

                    executed on NYSE and a trade for AAPL executed on NASDAQ
                    could potentially

                    have the same Trade ID.
                  type: string
                p:
                  description: >
                    The price of the trade. This is the actual dollar value per
                    whole share of

                    this trade. A trade of 100 shares with a price of $2.00
                    would be worth a

                    total dollar value of $200.00.
                  format: double
                  type: number
                s:
                  description: The size (volume) of the trade.
                  type: integer
                t:
                  description: The nanosecond accuracy SIP Unix Timestamp. This is the timestamp
                    of when the SIP received this message from the exchange
                    which produced it.
                  type: integer
                x:
                  description: The exchange ID. See <a
                    href="https://polygon.io/docs/stocks/get_v3_reference_exchanges"
                    alt="Exchanges">Exchanges</a> for Polygon.io's mapping of
                    exchange IDs.
                  type: integer
              required:
                - c
                - i
                - p
                - s
                - t
                - x
              type: object
            min:
              description: The most recent minute bar for this ticker.
              properties:
                av:
                  description: The accumulated volume.
                  type: integer
                c:
                  description: The close price for the symbol in the given time period.
                  format: double
                  type: number
                h:
                  description: The highest price for the symbol in the given time period.
                  format: double
                  type: number
                l:
                  description: The lowest price for the symbol in the given time period.
                  format: double
                  type: number
                n:
                  description: The number of transactions in the aggregate window.
                  type: integer
                o:
                  description: The open price for the symbol in the given time period.
                  format: double
                  type: number
                otc:
                  description: Whether or not this aggregate is for an OTC ticker. This field will
                    be left off if false.
                  type: boolean
                t:
                  description: The Unix Msec timestamp for the start of the aggregate window.
                  type: integer
                v:
                  description: The trading volume of the symbol in the given time period.
                  format: double
                  type: number
                vw:
                  description: The volume weighted average price.
                  format: double
                  type: number
              required:
                - av
                - o
                - h
                - l
                - c
                - v
                - vw
                - t
                - n
              type: object
            prevDay:
              description: The previous day's bar for this ticker.
              properties:
                c:
                  description: The close price for the symbol in the given time period.
                  format: double
                  type: number
                h:
                  description: The highest price for the symbol in the given time period.
                  format: double
                  type: number
                l:
                  description: The lowest price for the symbol in the given time period.
                  format: double
                  type: number
                o:
                  description: The open price for the symbol in the given time period.
                  format: double
                  type: number
                otc:
                  description: Whether or not this aggregate is for an OTC ticker. This field will
                    be left off if false.
                  type: boolean
                v:
                  description: The trading volume of the symbol in the given time period.
                  format: double
                  type: number
                vw:
                  description: The volume weighted average price.
                  format: double
                  type: number
              required:
                - o
                - h
                - l
                - c
                - v
                - vw
              type: object
            ticker:
              description: The exchange symbol that this item is traded under.
              type: string
            todaysChange:
              description: The value of the change from the previous day.
              format: double
              type: number
            todaysChangePerc:
              description: The percentage change since the previous day.
              format: double
              type: number
            updated:
              description: The last updated timestamp.
              type: integer
          type: object
      type: object
    StocksSnapshotTickers:
      properties:
        tickers:
          items:
            properties:
              day:
                description: The most recent daily bar for this ticker.
                properties:
                  c:
                    description: The close price for the symbol in the given time period.
                    format: double
                    type: number
                  h:
                    description: The highest price for the symbol in the given time period.
                    format: double
                    type: number
                  l:
                    description: The lowest price for the symbol in the given time period.
                    format: double
                    type: number
                  o:
                    description: The open price for the symbol in the given time period.
                    format: double
                    type: number
                  otc:
                    description: Whether or not this aggregate is for an OTC ticker. This field will
                      be left off if false.
                    type: boolean
                  v:
                    description: The trading volume of the symbol in the given time period.
                    format: double
                    type: number
                  vw:
                    description: The volume weighted average price.
                    format: double
                    type: number
                required:
                  - o
                  - h
                  - l
                  - c
                  - v
                  - vw
                type: object
              fmv:
                description: Fair market value is only available on Business plans. It is our
                  proprietary algorithm to generate a real-time, accurate, fair
                  market value of a tradable security. For more information, <a
                  rel="nofollow" target="_blank"
                  href="https://polygon.io/contact">contact us</a>.
                format: double
                type: number
              lastQuote:
                description: The most recent quote for this ticker.  This is only returned if
                  your current plan includes quotes.
                properties:
                  P:
                    description: The ask price.
                    format: double
                    type: number
                  S:
                    description: The ask size in lots.
                    type: integer
                  p:
                    description: The bid price.
                    format: double
                    type: number
                  s:
                    description: The bid size in lots.
                    type: integer
                  t:
                    description: The nanosecond accuracy SIP Unix Timestamp. This is the timestamp
                      of when the SIP received this message from the exchange
                      which produced it.
                    type: integer
                required:
                  - p
                  - s
                  - P
                  - S
                  - t
                type: object
              lastTrade:
                description: The most recent trade for this ticker.  This is only returned if
                  your current plan includes trades.
                properties:
                  c:
                    description: The trade conditions.
                    items:
                      type: integer
                    type: array
                  i:
                    description: >
                      The Trade ID which uniquely identifies a trade. These are
                      unique per

                      combination of ticker, exchange, and TRF. For example: A
                      trade for AAPL

                      executed on NYSE and a trade for AAPL executed on NASDAQ
                      could potentially

                      have the same Trade ID.
                    type: string
                  p:
                    description: >
                      The price of the trade. This is the actual dollar value
                      per whole share of

                      this trade. A trade of 100 shares with a price of $2.00
                      would be worth a

                      total dollar value of $200.00.
                    format: double
                    type: number
                  s:
                    description: The size (volume) of the trade.
                    type: integer
                  t:
                    description: The nanosecond accuracy SIP Unix Timestamp. This is the timestamp
                      of when the SIP received this message from the exchange
                      which produced it.
                    type: integer
                  x:
                    description: The exchange ID. See <a
                      href="https://polygon.io/docs/stocks/get_v3_reference_exchanges"
                      alt="Exchanges">Exchanges</a> for Polygon.io's mapping of
                      exchange IDs.
                    type: integer
                required:
                  - c
                  - i
                  - p
                  - s
                  - t
                  - x
                type: object
              min:
                description: The most recent minute bar for this ticker.
                properties:
                  av:
                    description: The accumulated volume.
                    type: integer
                  c:
                    description: The close price for the symbol in the given time period.
                    format: double
                    type: number
                  h:
                    description: The highest price for the symbol in the given time period.
                    format: double
                    type: number
                  l:
                    description: The lowest price for the symbol in the given time period.
                    format: double
                    type: number
                  n:
                    description: The number of transactions in the aggregate window.
                    type: integer
                  o:
                    description: The open price for the symbol in the given time period.
                    format: double
                    type: number
                  otc:
                    description: Whether or not this aggregate is for an OTC ticker. This field will
                      be left off if false.
                    type: boolean
                  t:
                    description: The Unix Msec timestamp for the start of the aggregate window.
                    type: integer
                  v:
                    description: The trading volume of the symbol in the given time period.
                    format: double
                    type: number
                  vw:
                    description: The volume weighted average price.
                    format: double
                    type: number
                required:
                  - av
                  - o
                  - h
                  - l
                  - c
                  - v
                  - vw
                  - t
                  - n
                type: object
              prevDay:
                description: The previous day's bar for this ticker.
                properties:
                  c:
                    description: The close price for the symbol in the given time period.
                    format: double
                    type: number
                  h:
                    description: The highest price for the symbol in the given time period.
                    format: double
                    type: number
                  l:
                    description: The lowest price for the symbol in the given time period.
                    format: double
                    type: number
                  o:
                    description: The open price for the symbol in the given time period.
                    format: double
                    type: number
                  otc:
                    description: Whether or not this aggregate is for an OTC ticker. This field will
                      be left off if false.
                    type: boolean
                  v:
                    description: The trading volume of the symbol in the given time period.
                    format: double
                    type: number
                  vw:
                    description: The volume weighted average price.
                    format: double
                    type: number
                required:
                  - o
                  - h
                  - l
                  - c
                  - v
                  - vw
                type: object
              ticker:
                description: The exchange symbol that this item is traded under.
                type: string
              todaysChange:
                description: The value of the change from the previous day.
                format: double
                type: number
              todaysChangePerc:
                description: The percentage change since the previous day.
                format: double
                type: number
              updated:
                description: The last updated timestamp.
                type: integer
            type: object
          type: array
      type: object
    StocksTickerResultsOTC:
      properties:
        results:
          items:
            properties:
              c:
                description: The close price for the symbol in the given time period.
                format: double
                type: number
              h:
                description: The highest price for the symbol in the given time period.
                format: double
                type: number
              l:
                description: The lowest price for the symbol in the given time period.
                format: double
                type: number
              n:
                description: The number of transactions in the aggregate window.
                type: integer
              o:
                description: The open price for the symbol in the given time period.
                format: double
                type: number
              otc:
                description: Whether or not this aggregate is for an OTC ticker. This field will
                  be left off if false.
                type: boolean
              t:
                description: The Unix Msec timestamp for the start of the aggregate window.
                type: integer
              v:
                description: The trading volume of the symbol in the given time period.
                format: double
                type: number
              vw:
                description: The volume weighted average price.
                format: double
                type: number
            required:
              - o
              - h
              - l
              - c
              - v
              - t
            type: object
          type: array
      type: object
    StocksV2Base:
      properties:
        T:
          description: The exchange symbol that this item is traded under.
          type: string
        f:
          description: The nanosecond accuracy TRF(Trade Reporting Facility) Unix
            Timestamp. This is the timestamp of when the trade reporting
            facility received this message.
          type: integer
        q:
          description: >
            The sequence number represents the sequence in which message events
            happened.

            These are increasing and unique per ticker symbol, but will not
            always be

            sequential (e.g., 1, 2, 6, 9, 10, 11).
          format: int64
          type: integer
        t:
          description: The nanosecond accuracy SIP Unix Timestamp. This is the timestamp
            of when the SIP received this message from the exchange which
            produced it.
          type: integer
        y:
          description: The nanosecond accuracy Participant/Exchange Unix Timestamp. This
            is the timestamp of when the quote was actually generated at the
            exchange.
          type: integer
      required:
        - T
        - t
        - y
        - f
        - q
      type: object
    StocksV2NBBO:
      allOf:
        - properties:
            T:
              description: The exchange symbol that this item is traded under.
              type: string
            f:
              description: The nanosecond accuracy TRF(Trade Reporting Facility) Unix
                Timestamp. This is the timestamp of when the trade reporting
                facility received this message.
              type: integer
            q:
              description: >
                The sequence number represents the sequence in which message
                events happened.

                These are increasing and unique per ticker symbol, but will not
                always be

                sequential (e.g., 1, 2, 6, 9, 10, 11).
              format: int64
              type: integer
            t:
              description: The nanosecond accuracy SIP Unix Timestamp. This is the timestamp
                of when the SIP received this message from the exchange which
                produced it.
              type: integer
            y:
              description: The nanosecond accuracy Participant/Exchange Unix Timestamp. This
                is the timestamp of when the quote was actually generated at the
                exchange.
              type: integer
          required:
            - T
            - t
            - y
            - f
            - q
          type: object
        - properties:
            P:
              description: The ask price.
              format: double
              type: number
            S:
              description: The ask size. This represents the number of round lot orders at the
                given ask price. The normal round lot size is 100 shares. An ask
                size of 2 means there are 200 shares available to purchase at
                the given ask price.
              type: integer
            X:
              allOf:
                - description: The exchange ID. See <a
                    href="https://polygon.io/docs/stocks/get_v3_reference_exchanges"
                    alt="Exchanges">Exchanges</a> for Polygon.io's mapping of
                    exchange IDs.
                  type: integer
                - description: Ask Exchange Id
            c:
              description: |
                A list of condition codes.
              items:
                description: >
                  The condition code. These are the conditions of this message.
                  See

                  [Condition
                  Mappings](https://polygon.io/docs/get_v3_reference_conditions)

                  for a mapping to exchange conditions.
                type: integer
              type: array
            i:
              description: |
                The indicators. For more information, see our glossary of [Conditions and
                Indicators](https://polygon.io/glossary/us/stocks/conditions-indicators).
              items:
                description: |
                  The indicator code.
                type: integer
              type: array
            p:
              description: The bid price.
              format: double
              type: number
            s:
              description: The bid size. This represents the number of round lot orders at the
                given bid price. The normal round lot size is 100 shares. A bid
                size of 2 means there are 200 shares for purchase at the given
                bid price.
              type: integer
            x:
              allOf:
                - description: The exchange ID. See <a
                    href="https://polygon.io/docs/stocks/get_v3_reference_exchanges"
                    alt="Exchanges">Exchanges</a> for Polygon.io's mapping of
                    exchange IDs.
                  type: integer
                - description: Bid Exchange Id
            z:
              description: >
                There are 3 tapes which define which exchange the ticker is
                listed on. These are integers in our objects which represent the
                letter of the alphabet. Eg: 1 = A, 2 = B, 3 = C.

                * Tape A is NYSE listed securities

                * Tape B is NYSE ARCA / NYSE American

                * Tape C is NASDAQ
              type: integer
          required:
            - c
            - i
            - p
            - s
            - x
            - P
            - S
            - X
            - z
          type: object
    StocksV2NBBOs:
      properties:
        results:
          items:
            allOf:
              - properties:
                  T:
                    description: The exchange symbol that this item is traded under.
                    type: string
                  f:
                    description: The nanosecond accuracy TRF(Trade Reporting Facility) Unix
                      Timestamp. This is the timestamp of when the trade
                      reporting facility received this message.
                    type: integer
                  q:
                    description: >
                      The sequence number represents the sequence in which
                      message events happened.

                      These are increasing and unique per ticker symbol, but
                      will not always be

                      sequential (e.g., 1, 2, 6, 9, 10, 11).
                    format: int64
                    type: integer
                  t:
                    description: The nanosecond accuracy SIP Unix Timestamp. This is the timestamp
                      of when the SIP received this message from the exchange
                      which produced it.
                    type: integer
                  y:
                    description: The nanosecond accuracy Participant/Exchange Unix Timestamp. This
                      is the timestamp of when the quote was actually generated
                      at the exchange.
                    type: integer
                required:
                  - T
                  - t
                  - y
                  - f
                  - q
                type: object
              - properties:
                  P:
                    description: The ask price.
                    format: double
                    type: number
                  S:
                    description: The ask size. This represents the number of round lot orders at the
                      given ask price. The normal round lot size is 100 shares.
                      An ask size of 2 means there are 200 shares available to
                      purchase at the given ask price.
                    type: integer
                  X:
                    allOf:
                      - description: The exchange ID. See <a
                          href="https://polygon.io/docs/stocks/get_v3_reference_exchanges"
                          alt="Exchanges">Exchanges</a> for Polygon.io's mapping
                          of exchange IDs.
                        type: integer
                      - description: Ask Exchange Id
                  c:
                    description: |
                      A list of condition codes.
                    items:
                      description: |
                        The condition code. These are the conditions of this message. See
                        [Condition Mappings](https://polygon.io/docs/get_v3_reference_conditions)
                        for a mapping to exchange conditions.
                      type: integer
                    type: array
                  i:
                    description: |
                      The indicators. For more information, see our glossary of [Conditions and
                      Indicators](https://polygon.io/glossary/us/stocks/conditions-indicators).
                    items:
                      description: |
                        The indicator code.
                      type: integer
                    type: array
                  p:
                    description: The bid price.
                    format: double
                    type: number
                  s:
                    description: The bid size. This represents the number of round lot orders at the
                      given bid price. The normal round lot size is 100 shares.
                      A bid size of 2 means there are 200 shares for purchase at
                      the given bid price.
                    type: integer
                  x:
                    allOf:
                      - description: The exchange ID. See <a
                          href="https://polygon.io/docs/stocks/get_v3_reference_exchanges"
                          alt="Exchanges">Exchanges</a> for Polygon.io's mapping
                          of exchange IDs.
                        type: integer
                      - description: Bid Exchange Id
                  z:
                    description: >
                      There are 3 tapes which define which exchange the ticker
                      is listed on. These are integers in our objects which
                      represent the letter of the alphabet. Eg: 1 = A, 2 = B, 3
                      = C.

                      * Tape A is NYSE listed securities

                      * Tape B is NYSE ARCA / NYSE American

                      * Tape C is NASDAQ
                    type: integer
                required:
                  - c
                  - i
                  - p
                  - s
                  - x
                  - P
                  - S
                  - X
                  - z
                type: object
          type: array
      type: object
    StocksV2Trade:
      allOf:
        - properties:
            T:
              description: The exchange symbol that this item is traded under.
              type: string
            f:
              description: The nanosecond accuracy TRF(Trade Reporting Facility) Unix
                Timestamp. This is the timestamp of when the trade reporting
                facility received this message.
              type: integer
            q:
              description: >
                The sequence number represents the sequence in which message
                events happened.

                These are increasing and unique per ticker symbol, but will not
                always be

                sequential (e.g., 1, 2, 6, 9, 10, 11).
              format: int64
              type: integer
            t:
              description: The nanosecond accuracy SIP Unix Timestamp. This is the timestamp
                of when the SIP received this message from the exchange which
                produced it.
              type: integer
            y:
              description: The nanosecond accuracy Participant/Exchange Unix Timestamp. This
                is the timestamp of when the quote was actually generated at the
                exchange.
              type: integer
          required:
            - T
            - t
            - y
            - f
            - q
          type: object
        - properties:
            c:
              description: |
                A list of condition codes.
              items:
                description: >
                  The condition code. These are the conditions of this message.
                  See

                  [Condition
                  Mappings](https://polygon.io/docs/get_v3_reference_conditions)

                  for a mapping to exchange conditions.
                type: integer
              type: array
            e:
              description: |
                The trade correction indicator.
              type: integer
            i:
              description: >
                The Trade ID which uniquely identifies a trade. These are unique
                per

                combination of ticker, exchange, and TRF. For example: A trade
                for AAPL

                executed on NYSE and a trade for AAPL executed on NASDAQ could
                potentially

                have the same Trade ID.
              type: string
            p:
              description: >
                The price of the trade. This is the actual dollar value per
                whole share of

                this trade. A trade of 100 shares with a price of $2.00 would be
                worth a

                total dollar value of $200.00.
              format: double
              type: number
            r:
              description: >
                The ID for the Trade Reporting Facility where the trade took
                place.
              type: integer
            s:
              description: |
                The size of a trade (also known as volume).
              format: double
              type: number
            x:
              description: The exchange ID. See <a
                href="https://polygon.io/docs/stocks/get_v3_reference_exchanges"
                alt="Exchanges">Exchanges</a> for Polygon.io's mapping of
                exchange IDs.
              type: integer
            z:
              description: >
                There are 3 tapes which define which exchange the ticker is
                listed on. These are integers in our objects which represent the
                letter of the alphabet. Eg: 1 = A, 2 = B, 3 = C.

                * Tape A is NYSE listed securities

                * Tape B is NYSE ARCA / NYSE American

                * Tape C is NASDAQ
              type: integer
          required:
            - c
            - i
            - p
            - s
            - e
            - x
            - r
            - z
          type: object
    StocksV2Trades:
      properties:
        results:
          items:
            allOf:
              - properties:
                  T:
                    description: The exchange symbol that this item is traded under.
                    type: string
                  f:
                    description: The nanosecond accuracy TRF(Trade Reporting Facility) Unix
                      Timestamp. This is the timestamp of when the trade
                      reporting facility received this message.
                    type: integer
                  q:
                    description: >
                      The sequence number represents the sequence in which
                      message events happened.

                      These are increasing and unique per ticker symbol, but
                      will not always be

                      sequential (e.g., 1, 2, 6, 9, 10, 11).
                    format: int64
                    type: integer
                  t:
                    description: The nanosecond accuracy SIP Unix Timestamp. This is the timestamp
                      of when the SIP received this message from the exchange
                      which produced it.
                    type: integer
                  y:
                    description: The nanosecond accuracy Participant/Exchange Unix Timestamp. This
                      is the timestamp of when the quote was actually generated
                      at the exchange.
                    type: integer
                required:
                  - T
                  - t
                  - y
                  - f
                  - q
                type: object
              - properties:
                  c:
                    description: |
                      A list of condition codes.
                    items:
                      description: |
                        The condition code. These are the conditions of this message. See
                        [Condition Mappings](https://polygon.io/docs/get_v3_reference_conditions)
                        for a mapping to exchange conditions.
                      type: integer
                    type: array
                  e:
                    description: |
                      The trade correction indicator.
                    type: integer
                  i:
                    description: >
                      The Trade ID which uniquely identifies a trade. These are
                      unique per

                      combination of ticker, exchange, and TRF. For example: A
                      trade for AAPL

                      executed on NYSE and a trade for AAPL executed on NASDAQ
                      could potentially

                      have the same Trade ID.
                    type: string
                  p:
                    description: >
                      The price of the trade. This is the actual dollar value
                      per whole share of

                      this trade. A trade of 100 shares with a price of $2.00
                      would be worth a

                      total dollar value of $200.00.
                    format: double
                    type: number
                  r:
                    description: >
                      The ID for the Trade Reporting Facility where the trade
                      took place.
                    type: integer
                  s:
                    description: |
                      The size of a trade (also known as volume).
                    format: double
                    type: number
                  x:
                    description: The exchange ID. See <a
                      href="https://polygon.io/docs/stocks/get_v3_reference_exchanges"
                      alt="Exchanges">Exchanges</a> for Polygon.io's mapping of
                      exchange IDs.
                    type: integer
                  z:
                    description: >
                      There are 3 tapes which define which exchange the ticker
                      is listed on. These are integers in our objects which
                      represent the letter of the alphabet. Eg: 1 = A, 2 = B, 3
                      = C.

                      * Tape A is NYSE listed securities

                      * Tape B is NYSE ARCA / NYSE American

                      * Tape C is NASDAQ
                    type: integer
                required:
                  - c
                  - i
                  - p
                  - s
                  - e
                  - x
                  - r
                  - z
                type: object
          type: array
      type: object
    SymbolPair:
      description: The symbol pair that was evaluated from the request.
      type: string
    Tape:
      description: >
        There are 3 tapes which define which exchange the ticker is listed on.
        These are integers in our objects which represent the letter of the
        alphabet. Eg: 1 = A, 2 = B, 3 = C.

        * Tape A is NYSE listed securities

        * Tape B is NYSE ARCA / NYSE American

        * Tape C is NASDAQ
      type: integer
    TickerBase:
      properties:
        ticker:
          description: The exchange symbol that this item is traded under.
          type: string
      required:
        - ticker
      type: object
    TickerResults:
      properties:
        results:
          items:
            properties:
              c:
                description: The close price for the symbol in the given time period.
                format: double
                type: number
              h:
                description: The highest price for the symbol in the given time period.
                format: double
                type: number
              l:
                description: The lowest price for the symbol in the given time period.
                format: double
                type: number
              n:
                description: The number of transactions in the aggregate window.
                type: integer
              o:
                description: The open price for the symbol in the given time period.
                format: double
                type: number
              t:
                description: The Unix Msec timestamp for the start of the aggregate window.
                type: integer
              v:
                description: The trading volume of the symbol in the given time period.
                format: double
                type: number
              vw:
                description: The volume weighted average price.
                format: double
                type: number
            required:
              - o
              - h
              - l
              - c
              - v
              - t
            type: object
          type: array
      type: object
    TickerSymbol:
      description: The exchange symbol that this item is traded under.
      type: string
    Timestamp:
      description: The Unix Msec timestamp for the start of the aggregate window.
      type: integer
    TimestampExchange:
      description: The nanosecond accuracy Participant/Exchange Unix Timestamp. This
        is the timestamp of when the quote was actually generated at the
        exchange.
      type: integer
    TimestampSIP:
      description: The nanosecond accuracy SIP Unix Timestamp. This is the timestamp
        of when the SIP received this message from the exchange which produced
        it.
      type: integer
    TimestampTRF:
      description: The nanosecond accuracy TRF(Trade Reporting Facility) Unix
        Timestamp. This is the timestamp of when the trade reporting facility
        received this message.
      type: integer
    TodaysChange:
      description: The value of the change from the previous day.
      format: double
      type: number
    TodaysChangePerc:
      description: The percentage change since the previous day.
      format: double
      type: number
    TradeDetailsMapItem:
      properties:
        name:
          description: Name of the trade detail item
          type: string
        type:
          description: Actual type of the trade detail item
          type: string
      type: object
    TradeExchange:
      description: The exchange that this trade happened on.
      type: integer
    TradeId:
      description: >
        The Trade ID which uniquely identifies a trade. These are unique per

        combination of ticker, exchange, and TRF. For example: A trade for AAPL

        executed on NYSE and a trade for AAPL executed on NASDAQ could
        potentially

        have the same Trade ID.
      type: string
    Updated:
      description: The last updated timestamp.
      type: integer
    V1LastBase:
      properties:
        request_id:
          description: A request id assigned by the server.
          type: string
        status:
          description: The status of this request's response.
          type: string
        symbol:
          description: The exchange symbol that this item is traded under.
          type: string
      required:
        - symbol
        - status
        - request_id
      type: object
    V2AggsBase:
      properties:
        adjusted:
          description: Whether or not this response was adjusted for splits.
          type: boolean
        queryCount:
          description: The number of aggregates (minute or day) used to generate the
            response.
          type: integer
        request_id:
          description: A request id assigned by the server.
          type: string
        resultsCount:
          description: The total number of results for this request.
          type: integer
        status:
          description: The status of this request's response.
          type: string
      required:
        - status
        - adjusted
        - queryCount
        - resultsCount
        - request_id
      type: object
    V2LastBase:
      properties:
        request_id:
          description: A request id assigned by the server.
          type: string
        status:
          description: The status of this request's response.
          type: string
      required:
        - status
        - request_id
      type: object
    V2TicksBase:
      properties:
        db_latency:
          description: Latency in milliseconds for the query results from the database.
          type: integer
        results_count:
          description: The total number of results for this request.
          type: integer
        success:
          description: Whether or not this query was executed successfully.
          type: boolean
        ticker:
          description: The exchange symbol that this item is traded under.
          type: string
      type: object
    Volume:
      description: The trading volume of the symbol in the given time period.
      format: double
      type: number
    VolumeWeight:
      description: The volume weighted average price.
      format: double
      type: number
  securitySchemes: {}
security: {}
tags:
  - name: finance
    description: Operations related to finance
x-polygon-order:
  crypto:
    market:
      - launchpad: shared
        paths:
          - /v2/aggs/ticker/{cryptoTicker}/range/{multiplier}/{timespan}/{from}/{to}
      - launchpad: exclusive
        paths:
          - /v1/summaries
      - paths:
          - /v2/aggs/grouped/locale/global/market/crypto/{date}
      - paths:
          - /v1/open-close/crypto/{from}/{to}/{date}
      - paths:
          - /v2/aggs/ticker/{cryptoTicker}/prev
      - paths:
          - /v3/trades/{cryptoTicker}
      - paths:
          - /v1/historic/crypto/{from}/{to}/{date}
      - paths:
          - /v1/last/crypto/{from}/{to}
      - group: Snapshots
        paths:
          - /v2/snapshot/locale/global/markets/crypto/tickers
          - /v2/snapshot/locale/global/markets/crypto/{direction}
          - /v2/snapshot/locale/global/markets/crypto/tickers/{ticker}
          - /v2/snapshot/locale/global/markets/crypto/tickers/{ticker}/book
          - /v3/snapshot
      - group: Technical Indicators
        paths:
          - /v1/indicators/sma/{cryptoTicker}
          - /v1/indicators/ema/{cryptoTicker}
          - /v1/indicators/macd/{cryptoTicker}
          - /v1/indicators/rsi/{cryptoTicker}
    reference:
      - paths:
          - /v3/reference/tickers
      - paths:
          - /v1/marketstatus/upcoming
      - paths:
          - /v1/marketstatus/now
      - paths:
          - /v3/reference/conditions
      - paths:
          - /v3/reference/exchanges
  fx:
    market:
      - launchpad: shared
        paths:
          - /v2/aggs/ticker/{forexTicker}/range/{multiplier}/{timespan}/{from}/{to}
      - launchpad: exclusive
        paths:
          - /v1/summaries
      - paths:
          - /v2/aggs/grouped/locale/global/market/fx/{date}
      - paths:
          - /v2/aggs/ticker/{forexTicker}/prev
      - paths:
          - /v3/quotes/{fxTicker}
      - paths:
          - /v1/historic/forex/{from}/{to}/{date}
      - paths:
          - /v1/last_quote/currencies/{from}/{to}
      - paths:
          - /v1/conversion/{from}/{to}
      - group: Snapshots
        paths:
          - /v2/snapshot/locale/global/markets/forex/tickers
          - /v2/snapshot/locale/global/markets/forex/{direction}
          - /v2/snapshot/locale/global/markets/forex/tickers/{ticker}
          - /v3/snapshot
      - group: Technical Indicators
        paths:
          - /v1/indicators/sma/{fxTicker}
          - /v1/indicators/ema/{fxTicker}
          - /v1/indicators/macd/{fxTicker}
          - /v1/indicators/rsi/{fxTicker}
    reference:
      - paths:
          - /v3/reference/tickers
      - paths:
          - /v1/marketstatus/upcoming
      - paths:
          - /v1/marketstatus/now
      - paths:
          - /v3/reference/conditions
      - paths:
          - /v3/reference/exchanges
  indices:
    market:
      - launchpad: shared
        paths:
          - /v2/aggs/ticker/{indicesTicker}/range/{multiplier}/{timespan}/{from}/{to}
      - paths:
          - /v2/aggs/ticker/{indicesTicker}/prev
      - paths:
          - /v1/open-close/{indicesTicker}/{date}
      - group: Technical Indicators
        paths:
          - /v1/indicators/sma/{indicesTicker}
          - /v1/indicators/ema/{indicesTicker}
          - /v1/indicators/macd/{indicesTicker}
          - /v1/indicators/rsi/{indicesTicker}
      - group: Snapshots
        paths:
          - /v3/snapshot/indices
          - /v3/snapshot
    reference:
      - paths:
          - /v3/reference/tickers
      - paths:
          - /v3/reference/tickers/types
      - paths:
          - /v1/marketstatus/upcoming
      - paths:
          - /v1/marketstatus/now
  options:
    market:
      - launchpad: shared
        paths:
          - /v2/aggs/ticker/{optionsTicker}/range/{multiplier}/{timespan}/{from}/{to}
      - launchpad: exclusive
        paths:
          - /v1/summaries
      - paths:
          - /v1/open-close/{optionsTicker}/{date}
      - paths:
          - /v2/aggs/ticker/{optionsTicker}/prev
      - paths:
          - /v3/trades/{optionsTicker}
      - paths:
          - /v2/last/trade/{optionsTicker}
      - paths:
          - /v3/quotes/{optionsTicker}
      - group: Snapshots
        paths:
          - /v3/snapshot/options/{underlyingAsset}/{optionContract}
          - /v3/snapshot/options/{underlyingAsset}
          - /v3/snapshot
      - group: Technical Indicators
        paths:
          - /v1/indicators/sma/{optionsTicker}
          - /v1/indicators/ema/{optionsTicker}
          - /v1/indicators/macd/{optionsTicker}
          - /v1/indicators/rsi/{optionsTicker}
    reference:
      - paths:
          - /v3/reference/options/contracts/{options_ticker}
      - paths:
          - /v3/reference/options/contracts
      - paths:
          - /v3/reference/tickers
      - paths:
          - /v1/meta/symbols/{stocksTicker}/company
      - paths:
          - /v3/reference/tickers/{ticker}
      - paths:
          - /v2/reference/news
      - paths:
          - /v3/reference/tickers/types
      - paths:
          - /v1/marketstatus/upcoming
      - paths:
          - /v1/marketstatus/now
      - paths:
          - /v3/reference/conditions
      - paths:
          - /v3/reference/exchanges
  stocks:
    market:
      - launchpad: shared
        paths:
          - /v2/aggs/ticker/{stocksTicker}/range/{multiplier}/{timespan}/{from}/{to}
      - launchpad: exclusive
        paths:
          - /v1/summaries
      - paths:
          - /v2/aggs/grouped/locale/us/market/stocks/{date}
      - paths:
          - /v1/open-close/{stocksTicker}/{date}
      - paths:
          - /v2/aggs/ticker/{stocksTicker}/prev
      - paths:
          - /v3/trades/{stockTicker}
      - paths:
          - /v2/ticks/stocks/trades/{ticker}/{date}
      - paths:
          - /v2/last/trade/{stocksTicker}
      - paths:
          - /v3/quotes/{stockTicker}
      - paths:
          - /v2/ticks/stocks/nbbo/{ticker}/{date}
      - paths:
          - /v2/last/nbbo/{stocksTicker}
      - group: Snapshots
        paths:
          - /v2/snapshot/locale/us/markets/stocks/tickers
          - /v2/snapshot/locale/us/markets/stocks/{direction}
          - /v2/snapshot/locale/us/markets/stocks/tickers/{stocksTicker}
          - /v3/snapshot
      - group: Technical Indicators
        paths:
          - /v1/indicators/sma/{stockTicker}
          - /v1/indicators/ema/{stockTicker}
          - /v1/indicators/macd/{stockTicker}
          - /v1/indicators/rsi/{stockTicker}
    reference:
      - paths:
          - /v3/reference/tickers
      - paths:
          - /v1/meta/symbols/{stocksTicker}/company
      - paths:
          - /v3/reference/tickers/{ticker}
      - paths:
          - /vX/reference/tickers/{id}/events
      - paths:
          - /v2/reference/news
      - paths:
          - /v3/reference/tickers/types
      - paths:
          - /vX/reference/tickers/taxonomies
      - paths:
          - /v1/marketstatus/upcoming
      - paths:
          - /v1/marketstatus/now
      - group: SEC Filings
        paths:
          - /v1/reference/sec/filings
          - /v1/reference/sec/filings/{filing_id}
          - /v1/reference/sec/filings/{filing_id}/files
          - /v1/reference/sec/filings/{filing_id}/files/{file_id}
      - paths:
          - /v3/reference/splits
      - paths:
          - /v3/reference/dividends
      - paths:
          - /vX/reference/financials
      - paths:
          - /v3/reference/conditions
      - paths:
          - /v3/reference/exchanges