tickfeed-pro Account API

openapi: 3.2.0
info:
  title: Tickfeed Pro Account API
  version: 0.1.0
  description: 'Operations tagged account across 2 of this provider''s published API definitions: api.tickfeed.pro-openapi.json, tickfeed-pro-openapi.json. Each path carries the servers of the definition it was published in.'
tags:
- name: Account
paths:
  /pricing:
    get:
      tags:
      - Account
      summary: Public Pricing
      description: Usage prices. Balances are prepaid; every offered currency uses the same numbers.
      operationId: public_pricing_pricing_get
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
  /v1/usage:
    get:
      tags:
      - Account
      summary: Usage
      description: Your balance, the unit price and the last 30 days of spend. Free.
      operationId: usage_v1_usage_get
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UsageResponse'
        '401':
          description: Missing, invalid or revoked API key
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '402':
          description: Balance too low for this request (insufficient_balance)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: Account inactive
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Unsupported symbol
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '422':
          description: Invalid parameters
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '429':
          description: Rate limit exceeded
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '503':
          description: Market data feed unavailable
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      security:
      - APIKeyHeader: []
components:
  schemas:
    UsageResponse:
      properties:
        billing:
          type: string
          enum:
          - prepaid
          - internal
          title: Billing
          description: internal = operator key, never charged
        currency:
          anyOf:
          - type: string
          - type: 'null'
          title: Currency
          description: Account currency (usd, gbp, eur); null for internal keys
        balance:
          anyOf:
          - type: string
          - type: 'null'
          title: Balance
          description: Current balance, formatted, e.g. $12.50
        balance_micros:
          anyOf:
          - type: integer
          - type: 'null'
          title: Balance Micros
          description: Current balance in millionths of the currency
        unit_price:
          anyOf:
          - type: string
          - type: 'null'
          title: Unit Price
          description: Price of one billing unit, e.g. $0.002
        unit_price_micros:
          type: integer
          title: Unit Price Micros
        candles_per_unit:
          type: integer
          title: Candles Per Unit
          description: Candle requests cost one unit per this many bars returned
        ticks_per_unit:
          type: integer
          title: Ticks Per Unit
          description: Tick requests cost one unit per this many ticks returned
          default: 1000
        requests_per_minute:
          type: integer
          title: Requests Per Minute
        spent_30d:
          anyOf:
          - type: string
          - type: 'null'
          title: Spent 30D
        spent_30d_micros:
          type: integer
          title: Spent 30D Micros
        billable_requests_30d:
          type: integer
          title: Billable Requests 30D
        history:
          items:
            $ref: '#/components/schemas/UsageDay'
          type: array
          title: History
          description: Spend per UTC day with billable requests, last 30 days
      type: object
      required:
      - billing
      - currency
      - balance
      - balance_micros
      - unit_price
      - unit_price_micros
      - candles_per_unit
      - requests_per_minute
      - spent_30d
      - spent_30d_micros
      - billable_requests_30d
      - history
      title: UsageResponse
    ErrorResponse:
      properties:
        error:
          $ref: '#/components/schemas/ErrorDetail'
      type: object
      required:
      - error
      title: ErrorResponse
    UsageDay:
      properties:
        day:
          type: string
          title: Day
        requests:
          type: integer
          title: Requests
          description: Billable requests that day
        spent:
          type: string
          title: Spent
          description: Amount spent that day, formatted in the account currency
        spent_micros:
          type: integer
          title: Spent Micros
          description: Amount spent that day, in millionths of the account currency
      type: object
      required:
      - day
      - requests
      - spent
      - spent_micros
      title: UsageDay
    ErrorDetail:
      properties:
        code:
          type: string
          title: Code
          examples:
          - unsupported_symbol
        message:
          type: string
          title: Message
      type: object
      required:
      - code
      - message
      title: ErrorDetail
  securitySchemes:
    APIKeyHeader:
      type: apiKey
      description: Your API key
      in: header
      name: X-API-Key
x-refined-from:
- api.tickfeed.pro-openapi.json
- tickfeed-pro-openapi.json