Rarible Charts API

openapi: 3.0.3
info:
  title: OpenAPI definition Charts API
  version: v0.1
  description: '# Exciting News


    Hey there, amazing developers! 👋


    We''ve got some fantastic news to share that will make your experience with our product even better. We''re thrilled to announce the implementation of API-Keys, which brings a new level of control and convenience to your development process. So, let''s dive right into the details! ✨


    ## API-Keys for Enhanced Functionality 🔑


    Starting now, we have introduced API-Keys to streamline your interactions with our methods. You might have noticed a slight change while making requests – now, all you need to do is include the parameter `X-API-KEY` in the Header of your request. Simple as that!


    ## Get Your API-Key in a Snap! ⚡️


    Securing your API-Key is a breeze. We''ve made the process super user-friendly to ensure you can get started quickly. Just head over to our website and fill out a simple form. Once you''ve done that, your shiny new API-Key will be delivered straight to your email inbox. Easy peasy! 📧


    [Get Your API-Key Here](https://api.rarible.org/registration)

    [Configure SDK with API-key](https://github.com/rarible/sdk#api-querying)


    ## Unlock the Power of the Rarible Protocol 🔓


    As passionate developers, we know you''re always hungry for knowledge and eager to explore new frontiers. That''s why we invite you to discover the incredible world of the Rarible Protocol. By visiting our dedicated protocol page, you''ll gain access to a treasure trove of useful information, tips, and insights that will elevate your development skills to new heights. 🚀


    [Explore the Rarible Protocol](https://rarible.org)


    So, buckle up and get ready for an enhanced development journey with our API-Keys. We''re excited to see what you''ll create using our revamped system! 💪🚀


    Stay curious, keep innovating, and happy coding! ✨


    [P.S. Join our Discord Server to stay up to date and ask questions](https://discord.gg/rarifoundation)

    '
servers:
- url: https://{environment}.rarible.org
  description: Production (Mainnet)
  variables:
    environment:
      enum:
      - api
      - testnet-api
      default: api
security:
- ApiKeyAuth: []
tags:
- name: Charts
  x-controller: ChartController
paths:
  /v2.0/data/collections/{id}/charts/floorPrice:
    get:
      tags:
      - Charts
      summary: Get historical data of floor price for collection for charting purposes
      description: Returns list of historical floor prices aggregated at even intervals in the specified time period - last day, last month etc.  Each points represents the aggregated value of the interval after it.  The last point represents the current floor price.
      operationId: getFloorPriceChart
      parameters:
      - name: id
        in: path
        required: true
        description: Collection ID
        schema:
          $ref: '#/components/schemas/CollectionId'
      - name: period
        in: query
        required: true
        description: Time period for aggregation
        schema:
          $ref: '#/components/schemas/OlapPeriod'
      - name: size
        in: query
        required: true
        description: Number of data points to return
        schema:
          type: integer
      - name: endTime
        in: query
        required: false
        description: Optionally, the date-time of the last point of the graph. Defaults to current time.
        schema:
          type: string
          format: date-time
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OlapChartResponse'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OlapError'
        '404':
          description: Not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OlapError'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OlapError'
  /v2.0/data/collections/{id}/charts/volume:
    get:
      tags:
      - Charts
      summary: Get historical data of collection volume (total sales worth) for charting purposes
      description: Given a time period and the desired number of points, returns points which represent total worth of collection sales in the interval after that point.  The last point always has no value.
      operationId: getVolumeChart
      parameters:
      - name: id
        in: path
        required: true
        description: Collection ID
        schema:
          $ref: '#/components/schemas/CollectionId'
      - name: period
        in: query
        required: true
        description: Time period for aggregation
        schema:
          $ref: '#/components/schemas/OlapPeriod'
      - name: size
        in: query
        required: true
        description: Number of data points to return
        schema:
          type: integer
      - name: endTime
        in: query
        required: false
        description: Optionally, the date-time of the last point of the graph. Defaults to current time.
        schema:
          type: string
          format: date-time
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OlapChartResponse'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OlapError'
        '404':
          description: Not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OlapError'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OlapError'
components:
  schemas:
    OlapPeriod:
      type: string
      enum:
      - MIN5
      - MIN30
      - H1
      - H6
      - D1
      - D7
      - D30
      - D180
      - D365
      - ALL
      description: "Period:\n  * `MIN5` - Last 5 minutes\n  * `MIN30` - Last 30 minutes\n  * `H1` - Last 1 hour\n  * `H6` - Last 6 hours\n  * `D1` - Last 1 day\n  * `D7` - Last 7 days\n  * `D30` - Last 30 days\n  * `D180` - Last 180 days (roughly 6 months)\n  * `D365` - Last 365 days (roughly 1 year)\n  * `ALL` - For all time\n"
    OlapError:
      required:
      - code
      - message
      type: object
      properties:
        code:
          type: string
          description: Code
          enum:
          - INVALID_INPUT
          - NOT_FOUND
          - UNKNOWN
        message:
          type: string
          description: Message
    OlapHistoryValuesByTimestamps:
      required:
      - timestamps
      - values
      type: object
      properties:
        timestamps:
          type: array
          description: Timestamps of historical statistics
          items:
            type: integer
            format: int64
            description: Unix epoch of historical statistics
        values:
          type: array
          description: Values of historical statistics
          items:
            type: number
            description: Value of historical statistics
            format: bigdecimal
    OlapChartResponse:
      type: object
      properties:
        dataPoints:
          $ref: '#/components/schemas/OlapHistoryValuesByTimestamps'
      required:
      - dataPoints
    CollectionId:
      type: string
      description: Collection id
      example: ETHEREUM:0xb66a603f4cfe17e3d27b87a8bfcad319856518b8
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: X-API-KEY
      x-default: 11111111-1111-1111-1111-111111111111