# Hyperliquid Carry Trade Screener — Funding APR & Risk (`s5ifty4/hyperliquid-carry-trade-screener`) Actor

Ranks Hyperliquid perp funding opportunities by estimated net APR, open interest, 24h volume, mark/oracle premium, funding persistence, and risk.

- **URL**: https://apify.com/s5ifty4/hyperliquid-carry-trade-screener.md
- **Developed by:** [S5ifty4](https://apify.com/s5ifty4) (community)
- **Categories:** Automation, Business, Developer tools
- **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 Carry Trade Screener

Apify Actor that scans Hyperliquid perp markets and ranks funding/carry opportunities by net APR, liquidity, mark/oracle premium, and risk.

### Why this Actor exists

Most funding tools return raw rates. This Actor is built to be decision-ready:

- Converts hourly funding to annualized APR.
- Estimates net APR after a configurable round-trip fee/slippage assumption.
- Scores markets by open interest, 24h volume, mark/oracle premium, asset risk, and funding strength.
- Optionally fetches 24h funding history to label persistence and funding reversals.
- Labels each market as `consider`, `watch`, or `avoid`.
- Outputs warnings such as thin liquidity, premium distortion, inconsistent funding, and extreme/transient APR.
- Charges only for returned opportunity rows when pay-per-event monetization is enabled; the summary row is uncharged.

This is a screening tool, not financial advice.

### Default strategy

Defaults are tuned for practical positive-funding carry research:

- Side: positive funding, i.e. short perp / long spot carry
- Minimum absolute funding APR: 5%
- Minimum OI: $5M
- Minimum 24h volume: $2M
- Maximum absolute premium: 1.5%
- Risk mode: balanced
- 24h funding history: enabled for top 40 candidates

### Input

| Field | Default | Description |
|---|---:|---|
| `side` | `positive` | `positive`, `negative`, or `both`. |
| `riskMode` | `balanced` | `conservative`, `balanced`, or `all`. |
| `minFundingAprPct` | `5` | Minimum annualized absolute funding APR before estimated fees. |
| `minOpenInterestUsd` | `5000000` | Minimum notional open interest. |
| `minDailyVolumeUsd` | `2000000` | Minimum 24h notional volume. |
| `maxPremiumAbsPct` | `1.5` | Maximum absolute mark/oracle premium. |
| `assumedRoundTripFeeBps` | `9` | Entry+exit fee/slippage assumption, annualized over a 7-day hold. |
| `coins` | `[]` | Optional allowlist. Empty means all non-delisted markets. |
| `excludeCoins` | `[]` | Optional blocklist. |
| `includeHistory` | `true` | Fetch 24h funding history for top candidates. |
| `historyCandidates` | `40` | Number of pre-filtered rows to enrich with funding history. |
| `maxResults` | `30` | Maximum output rows. |

### Output

The first dataset row is a summary object. Remaining rows are ranked opportunities with fields including:

- `decision`: `consider`, `watch`, or `avoid`
- `opportunityScore`: 0-100
- `coin`
- `carrySideLabel`
- `fundingAprPct`
- `estimatedNetAprPct`
- `openInterestUsd`
- `dailyVolumeUsd`
- `premiumPct`
- `liquidityTier`
- `premiumTier`
- `riskBucket`
- `fundingPersistencePct`
- `avg24hFundingAprPct`
- `positiveSignals`
- `warnings`
- `reason`

### Data source

Uses Hyperliquid's public `info` API:

```text
https://api.hyperliquid.xyz/info
````

Endpoints used:

- `metaAndAssetCtxs`
- `fundingHistory`

### Local development

```bash
npm install
npm run test:local
```

Output is written to `storage/datasets/default/` when running locally.

### Disclaimer

This Actor is not financial advice. Funding/carry trades can lose money due to price movement, liquidation, funding reversals, liquidity, fees, execution risk, oracle/mark divergence, and exchange/smart-contract risk. Always verify market details directly before trading.

# Actor input Schema

## `side` (type: `string`):

Positive funding favors short perp / long spot carry. Negative funding favors long perp / short spot carry.

## `riskMode` (type: `string`):

Conservative applies stricter OI, volume, and premium filters. Balanced is the default. All returns more speculative markets but labels them clearly.

## `minFundingAprPct` (type: `number`):

Minimum annualized absolute funding APR before estimated fees.

## `minOpenInterestUsd` (type: `integer`):

Minimum notional open interest in USD.

## `minDailyVolumeUsd` (type: `integer`):

Minimum 24h notional volume in USD.

## `maxPremiumAbsPct` (type: `number`):

Exclude markets where mark/oracle premium is too distorted.

## `assumedRoundTripFeeBps` (type: `number`):

Estimated entry+exit trading fee/slippage in basis points, annualized over a 7-day hold for net APR approximation.

## `coins` (type: `array`):

Optional list of Hyperliquid coin symbols to include. Empty means all non-delisted markets.

## `excludeCoins` (type: `array`):

Optional list of coin symbols to exclude.

## `includeHistory` (type: `boolean`):

Fetch 24h funding history for top candidates to calculate persistence and average APR. Adds API calls but improves scoring.

## `historyCandidates` (type: `integer`):

Number of pre-filtered markets to enrich with 24h funding history.

## `maxResults` (type: `integer`):

Maximum rows to output after filtering and scoring.

## Actor input object example

```json
{
  "side": "positive",
  "riskMode": "balanced",
  "minFundingAprPct": 5,
  "minOpenInterestUsd": 5000000,
  "minDailyVolumeUsd": 2000000,
  "maxPremiumAbsPct": 1.5,
  "assumedRoundTripFeeBps": 9,
  "coins": [],
  "excludeCoins": [],
  "includeHistory": true,
  "historyCandidates": 40,
  "maxResults": 30
}
```

# 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("s5ifty4/hyperliquid-carry-trade-screener").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("s5ifty4/hyperliquid-carry-trade-screener").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 s5ifty4/hyperliquid-carry-trade-screener --silent --output-dataset

```

## MCP server setup

```json
{
    "mcpServers": {
        "apify": {
            "command": "npx",
            "args": [
                "mcp-remote",
                "https://mcp.apify.com/?tools=s5ifty4/hyperliquid-carry-trade-screener",
                "--header",
                "Authorization: Bearer <YOUR_API_TOKEN>"
            ]
        }
    }
}

```

## OpenAPI specification

```json
{
    "openapi": "3.0.1",
    "info": {
        "title": "Hyperliquid Carry Trade Screener — Funding APR & Risk",
        "description": "Ranks Hyperliquid perp funding opportunities by estimated net APR, open interest, 24h volume, mark/oracle premium, funding persistence, and risk.",
        "version": "0.1",
        "x-build-id": "pw76TRAzmOwMmdLAg"
    },
    "servers": [
        {
            "url": "https://api.apify.com/v2"
        }
    ],
    "paths": {
        "/acts/s5ifty4~hyperliquid-carry-trade-screener/run-sync-get-dataset-items": {
            "post": {
                "operationId": "run-sync-get-dataset-items-s5ifty4-hyperliquid-carry-trade-screener",
                "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/s5ifty4~hyperliquid-carry-trade-screener/runs": {
            "post": {
                "operationId": "runs-sync-s5ifty4-hyperliquid-carry-trade-screener",
                "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/s5ifty4~hyperliquid-carry-trade-screener/run-sync": {
            "post": {
                "operationId": "run-sync-s5ifty4-hyperliquid-carry-trade-screener",
                "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": {
                    "side": {
                        "title": "Carry side",
                        "enum": [
                            "positive",
                            "negative",
                            "both"
                        ],
                        "type": "string",
                        "description": "Positive funding favors short perp / long spot carry. Negative funding favors long perp / short spot carry.",
                        "default": "positive"
                    },
                    "riskMode": {
                        "title": "Risk mode",
                        "enum": [
                            "conservative",
                            "balanced",
                            "all"
                        ],
                        "type": "string",
                        "description": "Conservative applies stricter OI, volume, and premium filters. Balanced is the default. All returns more speculative markets but labels them clearly.",
                        "default": "balanced"
                    },
                    "minFundingAprPct": {
                        "title": "Minimum absolute funding APR %",
                        "type": "number",
                        "description": "Minimum annualized absolute funding APR before estimated fees.",
                        "default": 5
                    },
                    "minOpenInterestUsd": {
                        "title": "Minimum open interest USD",
                        "type": "integer",
                        "description": "Minimum notional open interest in USD.",
                        "default": 5000000
                    },
                    "minDailyVolumeUsd": {
                        "title": "Minimum daily volume USD",
                        "type": "integer",
                        "description": "Minimum 24h notional volume in USD.",
                        "default": 2000000
                    },
                    "maxPremiumAbsPct": {
                        "title": "Maximum absolute premium %",
                        "type": "number",
                        "description": "Exclude markets where mark/oracle premium is too distorted.",
                        "default": 1.5
                    },
                    "assumedRoundTripFeeBps": {
                        "title": "Assumed round-trip fee bps",
                        "type": "number",
                        "description": "Estimated entry+exit trading fee/slippage in basis points, annualized over a 7-day hold for net APR approximation.",
                        "default": 9
                    },
                    "coins": {
                        "title": "Coins allowlist",
                        "type": "array",
                        "description": "Optional list of Hyperliquid coin symbols to include. Empty means all non-delisted markets.",
                        "default": [],
                        "items": {
                            "type": "string"
                        }
                    },
                    "excludeCoins": {
                        "title": "Coins blocklist",
                        "type": "array",
                        "description": "Optional list of coin symbols to exclude.",
                        "default": [],
                        "items": {
                            "type": "string"
                        }
                    },
                    "includeHistory": {
                        "title": "Include 24h funding history stats",
                        "type": "boolean",
                        "description": "Fetch 24h funding history for top candidates to calculate persistence and average APR. Adds API calls but improves scoring.",
                        "default": true
                    },
                    "historyCandidates": {
                        "title": "History candidates",
                        "type": "integer",
                        "description": "Number of pre-filtered markets to enrich with 24h funding history.",
                        "default": 40
                    },
                    "maxResults": {
                        "title": "Maximum results",
                        "type": "integer",
                        "description": "Maximum rows to output after filtering and scoring.",
                        "default": 30
                    }
                }
            },
            "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
                                    }
                                }
                            }
                        }
                    }
                }
            }
        }
    }
}
```
