CryptoKeyhole Indices API

openapi: 3.2.0
info:
  title: Cryptokeyhole Indices API
  version: 1.0.0
  contact:
    name: CryptoKeyhole
    url: https://cryptokeyhole.com/data-access/
  license:
    name: CC BY 4.0 (free data; paid-plan data under the terms of service)
    url: https://cryptokeyhole.com/methodology/#licence-title
  termsOfService: https://cryptokeyhole.com/terms/
  x-logo:
    url: https://cryptokeyhole.com/favicon.svg
  description: 'Operations tagged Indices across 2 of this provider''s published API definitions: cryptokeyhole-openapi.json, cryptokeyhole-openapi.json. Each path carries the servers of the definition it was published in.'
servers:
- url: https://cryptokeyhole.com/api/v1
tags:
- name: Indices
  description: The Fear & Greed Index
paths:
  /fear-and-greed:
    get:
      tags:
      - Indices
      operationId: getFearAndGreed
      summary: Fear & Greed Index
      description: 'The crypto market''s Fear & Greed Index, or one coin''s: the latest reading (0 to 100 and exact), its band, the time it is as of and whether its UTC day is still open, today''s components with their weights, the readings a day, a week, a month and a year before, and the daily history, newest first. Free, keyless and open to other origins (CORS). Guide: https://cryptokeyhole.com/fear-and-greed-index/api/'
      security:
      - {}
      parameters:
      - name: coin
        in: query
        description: market (the default) or a coin code that has its own index (see /fear-and-greed/coins).
        schema:
          type: string
          example: btc
      - name: limit
        in: query
        description: Days of history, newest first (default 30; 0 for all).
        schema:
          type: integer
          minimum: 0
          default: 30
      - name: format
        in: query
        description: csv gives the history rows only.
        schema:
          type: string
          enum:
          - json
          - csv
          default: json
      responses:
        '200':
          description: The index
          headers:
            Link:
              description: 'The free data''s licence: <https://creativecommons.org/licenses/by/4.0/>; rel="license".'
              schema:
                type: string
          content:
            application/json:
              schema:
                type: object
            text/csv:
              schema:
                type: string
        '400':
          $ref: '#/components/responses/BadRequest'
        '404':
          $ref: '#/components/responses/NotFound'
    servers:
    - url: https://cryptokeyhole.com/api/v1
  /fear-and-greed/coins:
    get:
      tags:
      - Indices
      operationId: listFearAndGreedCoins
      summary: Fear & Greed Index of every coin
      description: Today's reading of the market's index and of every coin with its own. Free and keyless (CORS).
      security:
      - {}
      parameters:
      - name: format
        in: query
        schema:
          type: string
          enum:
          - json
          - csv
          default: json
      responses:
        '200':
          description: Today's readings
          content:
            application/json:
              schema:
                type: object
            text/csv:
              schema:
                type: string
    servers:
    - url: https://cryptokeyhole.com/api/v1
  /leverage:
    get:
      tags:
      - Indices
      operationId: getLeverageGauge
      summary: Leverage gauge
      description: 'How stretched leverage is in a coin, 0 to 100, hourly: open interest against market cap, funding, the futures basis, the long/short account ratio, Hyperliquid''s large accounts and the nearest liquidation cluster, each ranked against the coin''s own past year. With asset, every viewer gets the current value and band (keyless; CC BY 4.0); Plus and higher plans also get the components (reading, rank, score), the history (history=1h or 24h, with start and end) and, without asset, every coin ranked. page= answers the leverage pages'' plan-dependent parts. Method: https://cryptokeyhole.com/crypto-leverage/'
      security:
      - {}
      - bearerAuth: []
      parameters:
      - name: asset
        in: query
        description: 'A coin code (BTC, ETH, SOL, ...). Without it: every coin ranked (Plus).'
        schema:
          type: string
          example: BTC
      - name: history
        in: query
        description: '1h (at most 90 days a request) or 24h: the gauge''s history (Plus).'
        schema:
          type: string
          enum:
          - 1h
          - 24h
      - name: start
        in: query
        description: UTC seconds (history).
        schema:
          type: integer
      - name: end
        in: query
        description: UTC seconds, exclusive (history).
        schema:
          type: integer
      responses:
        '200':
          description: The gauge
          content:
            application/json:
              schema:
                type: object
        '400':
          $ref: '#/components/responses/BadRequest'
        '402':
          $ref: '#/components/responses/PlanRequired'
        '404':
          $ref: '#/components/responses/NotFound'
    servers:
    - url: https://cryptokeyhole.com/api/v1
components:
  responses:
    BadRequest:
      description: The request's parameters are invalid
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    NotFound:
      description: Unknown chart, asset, id or API route
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    PlanRequired:
      description: Included with a higher plan; locked names it
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  schemas:
    Locked:
      type: object
      description: What a higher plan would include.
      properties:
        feature:
          type: string
          example: interval
        requiredPlan:
          type: string
          enum:
          - plus
          - pro
          - team
        requiredPlanName:
          type: string
          example: Plus
        currentPlan:
          type: string
          example: free
        currentPlanName:
          type: string
          example: Free
        upgradePath:
          type: string
          example: /pricing/
        allowedIntervals:
          type: array
          items:
            type: string
    Error:
      type: object
      required:
      - error
      properties:
        error:
          type: string
        locked:
          $ref: '#/components/schemas/Locked'
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: 'An API key from your account page (Plus and higher plans): Authorization: Bearer <key>. Keys are read-only.'
externalDocs:
  description: API keys, plans, Google Sheets, Excel and Python
  url: https://cryptokeyhole.com/data-access/
x-refined-from:
- cryptokeyhole-openapi.json
- cryptokeyhole-openapi.json
x-provenance:
  method: harvested
  publisher: CryptoKeyhole
  source: https://cryptokeyhole.com/api/v1/openapi.json
  note: split by refine-openapis from the provider's own published document, verified by fetch (openapi/_original/*.fetch.json);
    stamped by stamp-openapi-provenance.py (roadmap#793)