# Hyperliquid HIP-4 Outcome Markets Scraper (`hyperdata-labs/hyperliquid-hip4-outcome-markets`) Actor

All live Hyperliquid HIP-4 prediction markets with order books, implied probabilities, depth, and optional Polymarket cross-venue comparison.

- **URL**: https://apify.com/hyperdata-labs/hyperliquid-hip4-outcome-markets.md
- **Developed by:** [hyperdata labs](https://apify.com/hyperdata-labs) (community)
- **Categories:** Developer tools, AI
- **Stats:** 2 total users, 1 monthly users, 100.0% runs succeeded, 0 bookmarks
- **User rating**: No ratings yet

## Pricing

Pay per usage

This Actor is paid per platform usage. The Actor is free to use, and you only pay for the Apify platform usage, which gets cheaper the higher subscription plan you have.

Learn more: https://docs.apify.com/platform/actors/running/actors-in-store#pay-per-usage

## What's an Apify Actor?

Actors are a software tools running on the Apify platform, for all kinds of web data extraction and automation use cases.
In Batch mode, an Actor accepts a well-defined JSON input, performs an action which can take anything from a few seconds to a few hours,
and optionally produces a well-defined JSON output, datasets with results, or files in key-value store.
In Standby mode, an Actor provides a web server which can be used as a website, API, or an MCP server.
Actors are written with capital "A".

## How to integrate an Actor?

If asked about integration, you help developers integrate Actors into their projects.
You adapt to their stack and deliver integrations that are safe, well-documented, and production-ready.
The best way to integrate Actors is as follows.

In JavaScript/TypeScript projects, use official [JavaScript/TypeScript client](https://docs.apify.com/api/client/js.md):

```bash
npm install apify-client
```

In Python projects, use official [Python client library](https://docs.apify.com/api/client/python.md):

```bash
pip install apify-client
```

In shell scripts, use [Apify CLI](https://docs.apify.com/cli/docs.md):

````bash
# MacOS / Linux
curl -fsSL https://apify.com/install-cli.sh | bash
# Windows
irm https://apify.com/install-cli.ps1 | iex
```bash

In AI frameworks, you might use the [Apify MCP server](https://docs.apify.com/platform/integrations/mcp.md).

If your project is in a different language, use the [REST API](https://docs.apify.com/api/v2.md).

For usage examples, see the [API](#api) section below.

For more details, see Apify documentation as [Markdown index](https://docs.apify.com/llms.txt) and [Markdown full-text](https://docs.apify.com/llms-full.txt).


# README

## Hyperliquid HIP-4 Outcome Markets Scraper

**Scrape every live prediction market on Hyperliquid HIP-4 in one run** — market names, full resolution criteria, live order-book prices, implied probabilities, spreads, and depth — as clean structured JSON. No wallet, no node, no SDK, no RPC key required.

> 🆓 **Currently free to run.** You only pay Apify's platform compute (a few cents per run).

---

### What is HIP-4?

HIP-4 is Hyperliquid's native **prediction-market** venue (live on mainnet since May 2026): fully-collateralized binary markets — Fed rate decisions, sports champions, World Cup winners, macro events — with a **merged Yes/No order book** and **zero open fees**. This actor turns the whole venue into a structured dataset you can analyze, monitor, or feed to an app or AI agent.

### What you get — one row per market

| Field | Description |
|---|---|
| `outcomeId` | HIP-4 outcome market id |
| `name` | Market name (e.g. *"June Fed rate change"*) |
| `description` | Full resolution criteria & settlement rules |
| `sides` | The two outcome sides (e.g. `["Change", "No Change"]`) |
| `impliedProbability` | Mid price = market-implied probability of side 0 |
| `bestBid` / `bestAsk` | Live top-of-book (side 1 = exact complement, `1 − price`) |
| `bestBidSize` / `bestAskSize` | Top-of-book sizes |
| `spread` | Ask − bid — liquidity quality at a glance |
| `topBidDepthUsd` | Top-of-book depth in quote terms |
| `quoteToken` | Collateral token (USDC / USDH) |
| `scrapedAt` | ISO timestamp of the read |

### Why use it

- **Cross-venue comparison** — line HIP-4 probabilities up against Polymarket / Kalshi for the same event and spot divergences.
- **Dashboards & alerts** — track a fast-growing prediction venue's pricing as it matures.
- **Price-history datasets** — schedule it (e.g. every 15 min) to build a longitudinal archive from the venue's earliest months.
- **AI agents** — feed live event probabilities (Fed, sports, macro, geopolitics) into LLM pipelines as ready-to-use JSON.
- **Trading research** — implied probabilities, spreads and depth in one pull, no infra to maintain.

### Input

```json
{
  "includeBooks": true,
  "nameFilter": "fed",
  "maxMarkets": 200
}
````

| Input | Default | Description |
|---|---|---|
| `includeBooks` | `true` | Fetch live order books (bid/ask/mid/depth). Set `false` for a fast metadata-only listing. |
| `nameFilter` | — | Case-insensitive substring filter on market names (e.g. `"fed"`, `"world cup"`). Empty = all markets. |
| `maxMarkets` | `200` | Cap on the number of markets returned after filtering. |

### Output sample

```json
{
  "scrapedAt": "2026-06-13T06:50:00.000Z",
  "outcomeId": 104,
  "name": "June Fed rate change",
  "sides": ["Change", "No Change"],
  "bestBid": 0.00941,
  "bestAsk": 0.01619,
  "impliedProbability": 0.0128,
  "spread": 0.0068,
  "topBidDepthUsd": 14.0,
  "quoteToken": "USDC"
}
```

### How it works

The actor reads Hyperliquid's **public** info API (`outcomeMeta` for the market catalog, `l2Book` per market for live pricing — HIP-4 coins use the `#<10·outcome+side>` convention). It is fully read-only, rate-limited politely, and touches no account, position, or key.

### Tips

- Run on a **schedule** (Apify Scheduler) to build a price-history dataset — prediction markets move on news, and early-venue data is scarce.
- Use `nameFilter` to track a single event family (all *Fed* markets, all *World Cup* markets) cheaply.
- The **merged-book model** means a buy of *Yes* at `p` equals a sell of *No* at `1 − p` — `impliedProbability` already reflects this.

***

*Built by [hyperdata-labs](https://apify.com/hyperdata-labs) — structured data tools for the Hyperliquid ecosystem.*

# Actor input Schema

## `includeBooks` (type: `boolean`):

Fetch best bid/ask, mid, and depth for every market (slower: one request per market).

## `nameFilter` (type: `string`):

Only include markets whose name contains this substring (case-insensitive). Empty = all markets.

## `maxMarkets` (type: `integer`):

Cap the number of markets returned (after filtering).

## Actor input object example

```json
{
  "includeBooks": true,
  "maxMarkets": 200
}
```

# API

You can run this Actor programmatically using our API. Below are code examples in JavaScript, Python, and CLI, as well as the OpenAPI specification and MCP server setup.

## JavaScript example

```javascript
import { ApifyClient } from 'apify-client';

// Initialize the ApifyClient with your Apify API token
// Replace the '<YOUR_API_TOKEN>' with your token
const client = new ApifyClient({
    token: '<YOUR_API_TOKEN>',
});

// Prepare Actor input
const input = {};

// Run the Actor and wait for it to finish
const run = await client.actor("hyperdata-labs/hyperliquid-hip4-outcome-markets").call(input);

// Fetch and print Actor results from the run's dataset (if any)
console.log('Results from dataset');
console.log(`💾 Check your data here: https://console.apify.com/storage/datasets/${run.defaultDatasetId}`);
const { items } = await client.dataset(run.defaultDatasetId).listItems();
items.forEach((item) => {
    console.dir(item);
});

// 📚 Want to learn more 📖? Go to → https://docs.apify.com/api/client/js/docs

```

## Python example

```python
from apify_client import ApifyClient

# Initialize the ApifyClient with your Apify API token
# Replace '<YOUR_API_TOKEN>' with your token.
client = ApifyClient("<YOUR_API_TOKEN>")

# Prepare the Actor input
run_input = {}

# Run the Actor and wait for it to finish
run = client.actor("hyperdata-labs/hyperliquid-hip4-outcome-markets").call(run_input=run_input)

# Fetch and print Actor results from the run's dataset (if there are any)
print("💾 Check your data here: https://console.apify.com/storage/datasets/" + run["defaultDatasetId"])
for item in client.dataset(run["defaultDatasetId"]).iterate_items():
    print(item)

# 📚 Want to learn more 📖? Go to → https://docs.apify.com/api/client/python/docs/quick-start

```

## CLI example

```bash
echo '{}' |
apify call hyperdata-labs/hyperliquid-hip4-outcome-markets --silent --output-dataset

```

## MCP server setup

```json
{
    "mcpServers": {
        "apify": {
            "command": "npx",
            "args": [
                "mcp-remote",
                "https://mcp.apify.com/?tools=hyperdata-labs/hyperliquid-hip4-outcome-markets",
                "--header",
                "Authorization: Bearer <YOUR_API_TOKEN>"
            ]
        }
    }
}

```

## OpenAPI specification

```json
{
    "openapi": "3.0.1",
    "info": {
        "title": "Hyperliquid HIP-4 Outcome Markets Scraper",
        "description": "All live Hyperliquid HIP-4 prediction markets with order books, implied probabilities, depth, and optional Polymarket cross-venue comparison.",
        "version": "0.1",
        "x-build-id": "gmePLIGRNcK7eGKde"
    },
    "servers": [
        {
            "url": "https://api.apify.com/v2"
        }
    ],
    "paths": {
        "/acts/hyperdata-labs~hyperliquid-hip4-outcome-markets/run-sync-get-dataset-items": {
            "post": {
                "operationId": "run-sync-get-dataset-items-hyperdata-labs-hyperliquid-hip4-outcome-markets",
                "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/hyperdata-labs~hyperliquid-hip4-outcome-markets/runs": {
            "post": {
                "operationId": "runs-sync-hyperdata-labs-hyperliquid-hip4-outcome-markets",
                "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/hyperdata-labs~hyperliquid-hip4-outcome-markets/run-sync": {
            "post": {
                "operationId": "run-sync-hyperdata-labs-hyperliquid-hip4-outcome-markets",
                "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": {
                    "includeBooks": {
                        "title": "Include order books",
                        "type": "boolean",
                        "description": "Fetch best bid/ask, mid, and depth for every market (slower: one request per market).",
                        "default": true
                    },
                    "nameFilter": {
                        "title": "Name filter",
                        "type": "string",
                        "description": "Only include markets whose name contains this substring (case-insensitive). Empty = all markets."
                    },
                    "maxMarkets": {
                        "title": "Max markets",
                        "minimum": 1,
                        "maximum": 1000,
                        "type": "integer",
                        "description": "Cap the number of markets returned (after filtering).",
                        "default": 200
                    }
                }
            },
            "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
                                    }
                                }
                            }
                        }
                    }
                }
            }
        }
    }
}
```