{
  "openapi": "3.0.1",
  "info": {
    "title": "CoinGlass Live Data API",
    "description": "Live CoinGlass data on demand (klines, heatmaps, footprints, liquidations, Hyperliquid). Fetched in real time. You are only charged when valid data is returned.",
    "version": "1.4",
    "x-build-id": "yKdZ4F16LacrdAwtp"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/crypto_maniac~coinglass-data-api/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-crypto_maniac-coinglass-data-api",
        "x-openai-isConsequential": false,
        "summary": "Executes an Actor, waits for its completion, and returns Actor's dataset items in response.",
        "tags": [
          "Run Actor"
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/inputSchema"
              }
            }
          }
        },
        "parameters": [
          {
            "name": "token",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            },
            "description": "Enter your Apify token here"
          }
        ],
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    },
    "/acts/crypto_maniac~coinglass-data-api/runs": {
      "post": {
        "operationId": "runs-sync-crypto_maniac-coinglass-data-api",
        "x-openai-isConsequential": false,
        "summary": "Executes an Actor and returns information about the initiated run in response.",
        "tags": [
          "Run Actor"
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/inputSchema"
              }
            }
          }
        },
        "parameters": [
          {
            "name": "token",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            },
            "description": "Enter your Apify token here"
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/runsResponseSchema"
                }
              }
            }
          }
        }
      }
    },
    "/acts/crypto_maniac~coinglass-data-api/run-sync": {
      "post": {
        "operationId": "run-sync-crypto_maniac-coinglass-data-api",
        "x-openai-isConsequential": false,
        "summary": "Executes an Actor, waits for completion, and returns the OUTPUT from Key-value store in response.",
        "tags": [
          "Run Actor"
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/inputSchema"
              }
            }
          }
        },
        "parameters": [
          {
            "name": "token",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            },
            "description": "Enter your Apify token here"
          }
        ],
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    }
  },
  "components": {
    "schemas": {
      "inputSchema": {
        "type": "object",
        "required": [
          "product",
          "coin"
        ],
        "properties": {
          "product": {
            "title": "Product",
            "enum": [
              "kline",
              "aggregated_liq_kline",
              "avg_fr_kline",
              "hundredth_depth",
              "coinbase_premium_index",
              "buy_sell_qty_kline",
              "oi_kline",
              "buy_sell_vol_kline",
              "fear_greed_kline",
              "liquidity_heatmap",
              "footprint",
              "legend_liq_heatmap",
              "large_order",
              "hyperliq_liqmap"
            ],
            "type": "string",
            "description": "Which CoinGlass data product to fetch live",
            "default": "kline"
          },
          "coin": {
            "title": "Coin",
            "enum": [
              "BTC",
              "ETH",
              "BNB",
              "SOL",
              "XRP",
              "DOGE",
              "ADA",
              "LINK",
              "LTC",
              "TRX",
              "DOT",
              "AVAX",
              "ATOM",
              "NEAR",
              "APT",
              "ARB",
              "OP",
              "SUI",
              "PEPE",
              "WIF",
              "BCH",
              "ETC",
              "XLM",
              "VET",
              "ALGO",
              "FIL",
              "AAVE",
              "UNI",
              "MKR",
              "SNX",
              "ZEC",
              "DASH",
              "ZIL",
              "ZRX",
              "BAT",
              "ENJ",
              "CHZ",
              "HOT",
              "IOTA",
              "NEO",
              "ONT",
              "ONG",
              "IOST",
              "IOTX",
              "FET",
              "HBAR",
              "KAVA",
              "ONE",
              "STX",
              "RVN",
              "QTUM",
              "XTZ",
              "THETA",
              "TFUEL",
              "CELR",
              "ANKR",
              "ARPA",
              "BAND",
              "MTL",
              "RLC",
              "CVC",
              "DUSK",
              "WIN",
              "TUSD"
            ],
            "type": "string",
            "description": "Select the coin. Symbol is built automatically from coin + product.",
            "default": "BTC"
          },
          "interval": {
            "title": "Interval",
            "enum": [
              "m15",
              "h1",
              "h4",
              "h24",
              ""
            ],
            "type": "string",
            "description": "Required for kline-style, heatmap, and footprint",
            "default": "h1"
          },
          "from": {
            "title": "Start time",
            "type": "string",
            "description": "Examples: 2024-01-15  |  2024-01-15 14:30  |  7d  |  24h  |  yesterday"
          },
          "to": {
            "title": "End time",
            "type": "string",
            "description": "Examples: 2024-01-20  |  now"
          },
          "limit": {
            "title": "Limit",
            "minimum": 1,
            "maximum": 2000,
            "type": "integer",
            "description": "Maximum number of records (1-2000)",
            "default": 500
          },
          "model": {
            "title": "Model (legend / hyperliq)",
            "type": "integer",
            "description": "Model for legend_liq_heatmap or hyperliq_liqmap",
            "default": 1
          },
          "apiKey": {
            "title": "API Key (optional)",
            "type": "string",
            "description": "Leave empty if the Actor owner configured SERVER_API_KEY. Only fill if you received your own key."
          },
          "symbolOverride": {
            "title": "Symbol override (advanced)",
            "type": "string",
            "description": "Leave empty to auto-build from Coin + Product.",
            "default": ""
          },
          "serverUrl": {
            "title": "Server URL (advanced)",
            "type": "string",
            "description": "Override the data server URL. Leave empty to use the Actor owner default (SERVER_URL env).",
            "default": ""
          }
        }
      },
      "runsResponseSchema": {
        "type": "object",
        "properties": {
          "data": {
            "type": "object",
            "properties": {
              "id": {
                "type": "string"
              },
              "actId": {
                "type": "string"
              },
              "userId": {
                "type": "string"
              },
              "startedAt": {
                "type": "string",
                "format": "date-time",
                "example": "2025-01-08T00:00:00.000Z"
              },
              "finishedAt": {
                "type": "string",
                "format": "date-time",
                "example": "2025-01-08T00:00:00.000Z"
              },
              "status": {
                "type": "string",
                "example": "READY"
              },
              "meta": {
                "type": "object",
                "properties": {
                  "origin": {
                    "type": "string",
                    "example": "API"
                  },
                  "userAgent": {
                    "type": "string"
                  }
                }
              },
              "stats": {
                "type": "object",
                "properties": {
                  "inputBodyLen": {
                    "type": "integer",
                    "example": 2000
                  },
                  "rebootCount": {
                    "type": "integer",
                    "example": 0
                  },
                  "restartCount": {
                    "type": "integer",
                    "example": 0
                  },
                  "resurrectCount": {
                    "type": "integer",
                    "example": 0
                  },
                  "computeUnits": {
                    "type": "integer",
                    "example": 0
                  }
                }
              },
              "options": {
                "type": "object",
                "properties": {
                  "build": {
                    "type": "string",
                    "example": "latest"
                  },
                  "timeoutSecs": {
                    "type": "integer",
                    "example": 300
                  },
                  "memoryMbytes": {
                    "type": "integer",
                    "example": 1024
                  },
                  "diskMbytes": {
                    "type": "integer",
                    "example": 2048
                  }
                }
              },
              "buildId": {
                "type": "string"
              },
              "defaultKeyValueStoreId": {
                "type": "string"
              },
              "defaultDatasetId": {
                "type": "string"
              },
              "defaultRequestQueueId": {
                "type": "string"
              },
              "buildNumber": {
                "type": "string",
                "example": "1.0.0"
              },
              "containerUrl": {
                "type": "string"
              },
              "usage": {
                "type": "object",
                "properties": {
                  "ACTOR_COMPUTE_UNITS": {
                    "type": "integer",
                    "example": 0
                  },
                  "DATASET_READS": {
                    "type": "integer",
                    "example": 0
                  },
                  "DATASET_WRITES": {
                    "type": "integer",
                    "example": 0
                  },
                  "KEY_VALUE_STORE_READS": {
                    "type": "integer",
                    "example": 0
                  },
                  "KEY_VALUE_STORE_WRITES": {
                    "type": "integer",
                    "example": 1
                  },
                  "KEY_VALUE_STORE_LISTS": {
                    "type": "integer",
                    "example": 0
                  },
                  "REQUEST_QUEUE_READS": {
                    "type": "integer",
                    "example": 0
                  },
                  "REQUEST_QUEUE_WRITES": {
                    "type": "integer",
                    "example": 0
                  },
                  "DATA_TRANSFER_INTERNAL_GBYTES": {
                    "type": "integer",
                    "example": 0
                  },
                  "DATA_TRANSFER_EXTERNAL_GBYTES": {
                    "type": "integer",
                    "example": 0
                  },
                  "PROXY_RESIDENTIAL_TRANSFER_GBYTES": {
                    "type": "integer",
                    "example": 0
                  },
                  "PROXY_SERPS": {
                    "type": "integer",
                    "example": 0
                  },
                  "PROXY_UNBLOCKER_UNITS": {
                    "type": "integer",
                    "example": 0
                  }
                }
              },
              "usageTotalUsd": {
                "type": "number",
                "example": 0.00005
              },
              "usageUsd": {
                "type": "object",
                "properties": {
                  "ACTOR_COMPUTE_UNITS": {
                    "type": "integer",
                    "example": 0
                  },
                  "DATASET_READS": {
                    "type": "integer",
                    "example": 0
                  },
                  "DATASET_WRITES": {
                    "type": "integer",
                    "example": 0
                  },
                  "KEY_VALUE_STORE_READS": {
                    "type": "integer",
                    "example": 0
                  },
                  "KEY_VALUE_STORE_WRITES": {
                    "type": "number",
                    "example": 0.00005
                  },
                  "KEY_VALUE_STORE_LISTS": {
                    "type": "integer",
                    "example": 0
                  },
                  "REQUEST_QUEUE_READS": {
                    "type": "integer",
                    "example": 0
                  },
                  "REQUEST_QUEUE_WRITES": {
                    "type": "integer",
                    "example": 0
                  },
                  "DATA_TRANSFER_INTERNAL_GBYTES": {
                    "type": "integer",
                    "example": 0
                  },
                  "DATA_TRANSFER_EXTERNAL_GBYTES": {
                    "type": "integer",
                    "example": 0
                  },
                  "PROXY_RESIDENTIAL_TRANSFER_GBYTES": {
                    "type": "integer",
                    "example": 0
                  },
                  "PROXY_SERPS": {
                    "type": "integer",
                    "example": 0
                  },
                  "PROXY_UNBLOCKER_UNITS": {
                    "type": "integer",
                    "example": 0
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}