{
  "openapi": "3.0.1",
  "info": {
    "title": "Hyperliquid Liquidation Radar: Scored Liquidation Feed",
    "description": "A scored, deduplicated feed of forced-liquidation events on Hyperliquid perps: coin, side liquidated, total notional, mark price, liquidated wallet, and a cascade flag, with open-interest and funding context. Aggregated per liquidation (not per fill) and billed only for new events. No API key.",
    "version": "0.1",
    "x-build-id": "1YwhhWPb0oq5ocikd"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/mrlarryjohnson~hyperliquid-liquidation-radar/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-mrlarryjohnson-hyperliquid-liquidation-radar",
        "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/mrlarryjohnson~hyperliquid-liquidation-radar/runs": {
      "post": {
        "operationId": "runs-sync-mrlarryjohnson-hyperliquid-liquidation-radar",
        "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/mrlarryjohnson~hyperliquid-liquidation-radar/run-sync": {
      "post": {
        "operationId": "run-sync-mrlarryjohnson-hyperliquid-liquidation-radar",
        "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",
        "properties": {
          "topCoins": {
            "title": "Top coins by volume to watch",
            "minimum": 1,
            "maximum": 100,
            "type": "integer",
            "description": "How many of the highest-volume Hyperliquid perps to seed the scan from (recent trades + live tape). More coins = wider coverage, slower run.",
            "default": 30
          },
          "coins": {
            "title": "Always-include coins",
            "type": "array",
            "description": "Optional coin symbols (e.g. BTC, ETH, SOL) to always watch regardless of volume rank.",
            "default": [],
            "items": {
              "type": "string"
            }
          },
          "listenSeconds": {
            "title": "Live tape listen window (seconds)",
            "minimum": 0,
            "maximum": 300,
            "type": "integer",
            "description": "After the instant REST seed, live-stream the trade tape over websocket for this many seconds to widen the active-wallet set (0 = REST seed only, max 300). Schedule runs back-to-back for near-continuous coverage.",
            "default": 60
          },
          "minNotionalUsd": {
            "title": "Minimum liquidation size (USD)",
            "minimum": 0,
            "type": "integer",
            "description": "Only surface liquidation events at or above this total notional. Default 1000.",
            "default": 1000
          },
          "lookbackMinutes": {
            "title": "Recency window (minutes)",
            "minimum": 1,
            "maximum": 1440,
            "type": "integer",
            "description": "Only surface liquidations from the last N minutes. Keeps this a near-real-time feed (not a backfill of old liquidations) and bounds the first run. Default 60. For continuous coverage, schedule the run every few minutes with a window a bit longer than the gap.",
            "default": 60
          },
          "maxEnrich": {
            "title": "Max liquidations enriched per run",
            "minimum": 1,
            "maximum": 1000,
            "type": "integer",
            "description": "Cap on how many discovered liquidations get a full authoritative size lookup (largest first). Bounds run time. Default 200.",
            "default": 200
          },
          "maxSeedWallets": {
            "title": "Max wallets polled per run",
            "minimum": 1,
            "maximum": 600,
            "type": "integer",
            "description": "Cap on how many wallets get a userFills poll while discovering liquidations. Higher = better coverage, longer run. Persisted liquidator wallets are always polled first.",
            "default": 120
          },
          "maxResults": {
            "title": "Max liquidation events returned",
            "minimum": 1,
            "maximum": 2000,
            "type": "integer",
            "description": "Cap on returned events per run, largest notional first.",
            "default": 500
          },
          "dedupAcrossRuns": {
            "title": "Dedup across runs",
            "type": "boolean",
            "description": "Remember liquidation events (and discovered liquidator wallets) in a named store so the same liquidation is never returned or billed twice across scheduled runs, and coverage compounds over time. Leave this ON. Turning it OFF means a liquidation still inside the recency window will be returned and billed again on every scheduled run.",
            "default": true
          },
          "stateKey": {
            "title": "Dedup state name",
            "type": "string",
            "description": "Name of the named key-value store holding seen liquidation events + known liquidator wallets. Give each parallel schedule its own name so they don't suppress each other.",
            "default": "hl-liquidation-radar-state"
          }
        }
      },
      "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
                  }
                }
              },
              "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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}