# Hyperliquid Perpetual Market Snapshot (`sarthi/hyperliquid-market-snapshot`) Actor

Read-only normalized Hyperliquid perpetual market snapshots with optional bounded L2 books.

- **URL**: https://apify.com/sarthi/hyperliquid-market-snapshot.md
- **Developed by:** [Sarthiii B](https://apify.com/sarthi) (community)
- **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/actors/running/actors-in-store.md#pay-per-usage

## What's an Apify Actor?

Actors are web data automations that power AI and operations. They run on the Apify platform to scrape websites, process data, connect APIs, and automate workflows.
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.

- **AI agents and MCP clients** — the [Apify MCP server](https://docs.apify.com/integrations/mcp.md) at `https://mcp.apify.com` (remote, streamable HTTP, OAuth on first use).
- **Agentic workflows and local Actor development** — [Agent Skills](https://apify.com/.well-known/agent-skills/index.json) with the [Apify CLI](https://docs.apify.com/cli/docs.md): `npm install -g apify-cli`, then `apify login`.
- **JavaScript/TypeScript projects** — the official [JS/TS client](https://docs.apify.com/api/client/js/docs.md): `npm install apify-client`.
- **Python projects** — the official [Python client](https://docs.apify.com/api/client/python/docs.md): `pip install apify-client`.
- **Any other language** — 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 market snapshot

Read public Hyperliquid perpetual market data through the official `/info` endpoint.

The Actor sends `POST https://api.hyperliquid.xyz/info` with `{ "type": "metaAndAssetCtxs" }`.
It joins each `universe[index]` metadata item to `assetCtxs[index]`.
It preserves documented decimal string fields as strings, so downstream code does not lose precision.

Set `includeL2Book` to `true` to make one bounded `l2Book` request per selected symbol.
The Actor keeps at most 20 symbols, 20 order-book levels per side, and 2,000,000 response bytes.
It times out each request after 10 seconds by default.
A HTTP 429 response waits for `Retry-After` and retries once.
The Actor sends `Content-Type` only. It does not send an API key or wallet signature.

### Input

```json
{
  "symbols": ["BTC", "ETH"],
  "includeL2Book": true,
  "l2BookDepth": 10,
  "timeoutMs": 10000
}
```

An empty or omitted `symbols` array returns all markets in the metadata response.

### Local use

```bash
npm install
npm test
npm start
```

`npm start` runs the Apify Actor and reads its input from the Apify runtime.

A live read uses only free public market-data requests:

```bash
SYMBOLS=BTC,ETH INCLUDE_L2_BOOK=true npm run live-read
```

The live command prints JSON to stdout. It does not place orders, require credentials, or use paid infrastructure.

### Output

Each record contains `symbol`, the source `metadata`, decimal-string `market` fields, optional `l2_book`, and an ISO-8601 `observed_at` timestamp.

Fixture tests cover response shape, index joins, decimal-string preservation, timestamp capture, timeout, response-size limits, symbol and depth bounds, and 429 handling.

### Official sources

- [Info endpoint](https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint.md)
- [Perpetuals and `metaAndAssetCtxs`](https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint/perpetuals.md)
- [Rate limits and user limits](https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/rate-limits-and-user-limits.md)
- [API overview](https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api.md)

# Actor input Schema

## `symbols` (type: `array`):

Optional Hyperliquid perpetual symbols. Omit or use an empty array for all markets.

## `includeL2Book` (type: `boolean`):

Include one bounded public L2 order book request for each selected symbol.

## `l2BookDepth` (type: `integer`):

Maximum number of bid and ask levels returned for each selected symbol.

## `timeoutMs` (type: `integer`):

Maximum wait for each public Hyperliquid request in milliseconds.

## Actor input object example

```json
{
  "includeL2Book": false,
  "l2BookDepth": 10,
  "timeoutMs": 10000
}
```

# Actor output Schema

## `results` (type: `string`):

No description

# 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("sarthi/hyperliquid-market-snapshot").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("sarthi/hyperliquid-market-snapshot").call(run_input=run_input)

# Fetch and print Actor results from the run's dataset (if there are any)
print(f"💾 Check your data here: https://console.apify.com/storage/datasets/{run.default_dataset_id}")
for item in client.dataset(run.default_dataset_id).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 sarthi/hyperliquid-market-snapshot --silent --output-dataset

```

## MCP server setup

```json
{
    "mcpServers": {
        "apify": {
            "type": "http",
            "url": "https://mcp.apify.com/?tools=fetch-actor-details,sarthi/hyperliquid-market-snapshot"
        }
    }
}
```

The hosted server signs you in with OAuth on first connect, so no API token belongs in this config. Clients without OAuth support can send an `Authorization: Bearer <APIFY_API_TOKEN>` header instead, using a token from API & Integrations in Apify Console (https://console.apify.com/settings/integrations).

## OpenAPI specification

Download the OpenAPI definition: https://api.apify.com/v2/actors/EVVgbHyeHOWZG8a00/builds/BwTYQZzJdNyZB2cvy/openapi.json