# BitMEX Instruments Scraper (`parseforge/bitmex-instruments-scraper`) Actor Scrape live active instruments from BitMEX public API including perpetual swaps, futures, and spot pairs with prices, volume, open interest, funding rate, mark price, and 24h stats. No API key required. - **URL**: https://apify.com/parseforge/bitmex-instruments-scraper.md - **Developed by:** [ParseForge](https://apify.com/parseforge) (community) - **Categories:** Business, Developer tools, Automation - **Stats:** 2 total users, 1 monthly users, 100.0% runs succeeded, NaN bookmarks - **User rating**: No ratings yet ## Pricing from $25.50 / 1,000 results This Actor is paid per event. You are not charged for the Apify platform usage, but only a fixed price for specific events. Since this Actor supports Apify Store discounts, the price gets lower the higher subscription plan you have. Learn more: https://docs.apify.com/platform/actors/running/actors-in-store#pay-per-event ## 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 ![ParseForge Banner](https://github.com/ParseForge/apify-assets/raw/main/banner.jpg) ## ๐ŸŸง BitMEX Instruments Scraper > ๐Ÿš€ **Export every active BitMEX instrument in seconds.** Pull **perpetual swaps, dated futures, options, and spot pairs** with last price, mark price, open interest, funding rate, 24h volume, and bid/ask depth. No API key, no signup. > ๐Ÿ•’ **Last updated:** 2026-05-13 ยท **๐Ÿ“Š 30+ fields** per record ยท **๐ŸŸง Perps + futures + options + spot** ยท **๐Ÿ’ต USD / USDT quote currencies** ยท **๐Ÿ† The original crypto perp venue** The **BitMEX Instruments Scraper** queries the BitMEX `/api/v1/instrument/active` endpoint and returns one rich record per active instrument. Each record can carry up to **30+ fields**, including the canonical symbol, root symbol, instrument state, instrument type (`typ`), underlying asset, quote and settlement currencies, expiry and listing timestamps, last price, mark price, indicative settle, open interest, open value, funding rate (with a computed daily figure), 24h volume and turnover, VWAP, high, low, prior close, percent change, top-of-book bid/ask, midprice, and a liquidity flag. BitMEX pioneered the perpetual swap contract in 2016 and remains a central venue for crypto derivatives. This Actor classifies every record into one of `perpetual`, `futures`, `spot`, or `other`, so you can slice the dataset by structure without parsing internal type codes. | ๐ŸŽฏ Target Audience | ๐Ÿ’ก Primary Use Cases | |---|---| | Derivatives quants, market-making teams, crypto research desks, structured-product builders, treasury and risk teams, journalists | Perp funding monitoring, open-interest tracking, basis trades, calendar spreads, volatility surfaces, exchange research | --- ### ๐Ÿ“‹ What the BitMEX Scraper does Four built-in workflows in a single run: - ๐ŸŒ **Full instrument export.** Every active BitMEX instrument in one pull. - ๐ŸŸง **Type filter.** Restrict to `perpetual` swaps, dated `futures`, or `spot` pairs. - ๐Ÿ’ต **Quote-currency filter.** Restrict to `USD` or `USDT` quoted markets. - ๐Ÿ“Š **Server-side sort.** Order by 24h volume, open interest, last price, or symbol. Each record exposes the raw exchange fields plus a `classification` label and a `fundingRateDaily` value (per-period rate scaled to 24h), so you can drop the dataset into BI tools without further normalization. > ๐Ÿ’ก **Why it matters:** BitMEX is the original venue for crypto perpetual swaps and remains a key venue for institutional-grade derivatives data. Open interest, funding rate, and 24h volume on BitMEX feed every serious perp dashboard, basis-spread engine, and volatility-surface tool. --- ### ๐ŸŽฌ Full Demo _๐Ÿšง Coming soon: a 3-minute walkthrough from signup to a downloaded BitMEX dataset._ --- ### โš™๏ธ Input
InputTypeDefaultBehavior
maxItemsinteger10Records to return. Free plan caps at 10, paid plan at 1,000,000.
instrumentTypestring""One of perpetual, futures, spot, or empty for all types.
quoteCurrencystring""One of USD, USDT, or empty for any quote.
sortBystring"volume24h"One of volume24h, openInterest, lastPrice, symbol.
**Example: top 20 perpetual swaps by 24h volume.** ```json { "maxItems": 20, "instrumentType": "perpetual", "quoteCurrency": "USDT", "sortBy": "volume24h" } ```` **Example: dated futures sorted by open interest.** ```json { "maxItems": 50, "instrumentType": "futures", "sortBy": "openInterest" } ``` > โš ๏ธ **Good to Know:** the BitMEX `typ` codes encode the structural family: `FFWCSX` is a perpetual swap, `IFXXXP` is spot, and `FF`-prefixed codes generally indicate dated futures. This Actor exposes both the raw `typ` and a friendly `classification` so you can pivot either way. *** ### ๐Ÿ“Š Output Each instrument record can contain **up to 30+ fields**. Null fields are dropped, so spot rows are leaner than perp rows. Download the dataset as CSV, Excel, JSON, or XML. #### ๐Ÿงพ Schema | Field | Type | Example | |---|---|---| | ๐Ÿท๏ธ `symbol` | string | `"PEPEUSDT"` | | ๐Ÿ”— `url` | string | `"https://www.bitmex.com/app/trade/PEPEUSDT"` | | ๐ŸŸง `classification` | string | `"perpetual"` | | ๐ŸŒฑ `rootSymbol` | string | `"PEPE"` | | ๐ŸŸข `state` | string | `"Open"` | | ๐Ÿ”ฃ `typ` | string | `"FFWCSX"` | | ๐Ÿช™ `underlying` | string | `"PEPE"` | | ๐Ÿ’ต `quoteCurrency` | string | `"USDT"` | | ๐Ÿ’ผ `settlCurrency` | string | `"USDt"` | | ๐Ÿ—“๏ธ `listing` | ISO 8601 | `"2023-05-03T04:00:00.000Z"` | | ๐Ÿ—“๏ธ `front` | ISO 8601 | `"2023-05-03T04:00:00.000Z"` | | ๐Ÿ—“๏ธ `expiry` | ISO 8601 | null | `null` | | ๐ŸŽฏ `optionStrikePrice` | number | null | `null` | | ๐Ÿ’ฐ `lastPrice` | number | `0.000004026` | | ๐ŸŽš๏ธ `markPrice` | number | `0.000004039` | | ๐Ÿ’ต `indicativeSettlePrice` | number | `0.000004039` | | ๐Ÿ“ฆ `openInterest` | number | `137780500000` | | ๐Ÿ’ผ `openValue` | number | `556495439500` | | ๐Ÿ’ธ `fundingRate` | number | `0.0001` | | ๐Ÿ“ˆ `fundingRateDaily` | number | `0.0003` | | ๐Ÿ’ธ `indicativeFundingRate` | number | `0.0001` | | ๐Ÿ“Š `volume24h` | number | `14079510000` | | ๐Ÿ“Š `turnover24h` | number | `57568503460` | | ๐Ÿ•” `prevPrice24h` | number | `0.000004168` | | ๐Ÿ“ `vwap` | number | `0.0000040889` | | ๐Ÿ”ผ `highPrice` | number | `0.000004261` | | ๐Ÿ”ฝ `lowPrice` | number | `0.000003984` | | ๐Ÿ“ˆ `lastChangePcnt` | number | `-3.36` | | ๐Ÿ“ฅ `bidPrice` | number | `0.000004032` | | ๐Ÿ“ค `askPrice` | number | `0.000004038` | | โš–๏ธ `midPrice` | number | `0.000004035` | | ๐Ÿ’ง `hasLiquidity` | boolean | `true` | | ๐Ÿ•’ `scrapedAt` | ISO 8601 | `"2026-05-13T22:25:00.441Z"` | #### ๐Ÿ“ฆ Sample records
๐Ÿธ Perpetual swap: PEPEUSDT ```json { "symbol": "PEPEUSDT", "url": "https://www.bitmex.com/app/trade/PEPEUSDT", "classification": "perpetual", "rootSymbol": "PEPE", "state": "Open", "typ": "FFWCSX", "underlying": "PEPE", "quoteCurrency": "USDT", "settlCurrency": "USDt", "listing": "2023-05-03T04:00:00.000Z", "front": "2023-05-03T04:00:00.000Z", "positionCurrency": "PEPE", "lastPrice": 0.000004026, "markPrice": 0.000004039, "indicativeSettlePrice": 0.000004039, "openInterest": 137780500000, "openValue": 556495439500, "fundingRate": 0.0001, "fundingRateDaily": 0.0003, "indicativeFundingRate": 0.0001, "volume24h": 14079510000, "turnover24h": 57568503460, "prevPrice24h": 0.000004168, "vwap": 0.0000040889, "highPrice": 0.000004261, "lowPrice": 0.000003984, "lastChangePcnt": -3.36, "bidPrice": 0.000004032, "askPrice": 0.000004038, "midPrice": 0.000004035, "hasLiquidity": true, "scrapedAt": "2026-05-13T22:25:00.441Z" } ```
๐ŸŸฃ Spot pair: SOL_USDT ```json { "symbol": "SOL_USDT", "url": "https://www.bitmex.com/app/trade/SOL_USDT", "classification": "spot", "rootSymbol": "SOL", "state": "Open", "typ": "IFXXXP", "underlying": "SOL", "quoteCurrency": "USDT", "listing": "2022-09-27T07:00:00.000Z", "lastPrice": 90.94, "markPrice": 90.94, "openInterest": 0, "openValue": 0, "volume24h": 77429000000, "turnover24h": 7285019000, "prevPrice24h": 94.67, "vwap": 94.087, "highPrice": 95.88, "lowPrice": 90.48, "lastChangePcnt": -3.94, "bidPrice": 90.9, "askPrice": 91.03, "midPrice": 90.965, "hasLiquidity": true, "scrapedAt": "2026-05-13T22:25:00.441Z" } ```
๐ŸŸง Native token spot: BMEX_USDT ```json { "symbol": "BMEX_USDT", "url": "https://www.bitmex.com/app/trade/BMEX_USDT", "classification": "spot", "rootSymbol": "BMEX", "state": "Open", "typ": "IFXXXP", "underlying": "BMEX", "quoteCurrency": "USDT", "listing": "2022-11-11T00:00:00.000Z", "lastPrice": 0.0828, "markPrice": 0.0828, "openInterest": 0, "openValue": 0, "volume24h": 62357000000, "turnover24h": 5143427800, "prevPrice24h": 0.0817, "vwap": 0.082484, "highPrice": 0.0835, "lowPrice": 0.081, "lastChangePcnt": 1.22, "bidPrice": 0.0827, "askPrice": 0.0828, "midPrice": 0.08275, "hasLiquidity": true, "scrapedAt": "2026-05-13T22:25:00.441Z" } ```
*** ### โœจ Why choose this Actor | | Capability | |---|---| | ๐ŸŸง | **The original perpetual venue.** BitMEX pioneered the perp swap in 2016 and is a benchmark for institutional crypto derivatives. | | ๐Ÿ“ฆ | **Full derivatives stack.** Perpetual swaps, dated futures, options, and spot, all classified for you. | | ๐Ÿ’ธ | **Funding rate built in.** Both the raw period rate and a daily-scaled figure. | | ๐Ÿ” | **30+ rich fields.** Open interest, open value, VWAP, mark, indicative settle, top-of-book bid/ask, and more. | | ๐Ÿ“Š | **Server-side sort and filter.** Type and quote-currency filters, four sort modes, no post-processing required. | | โšก | **Fast.** All active instruments in a single API call, typically under 5 seconds. | | ๐Ÿšซ | **No authentication.** Pulls from the public `/instrument/active` endpoint. No API key, no IP allowlist. | > ๐Ÿ“Š BitMEX open interest and funding are reference signals for the entire crypto-derivatives ecosystem. *** ### ๐Ÿ“ˆ How it compares to alternatives | Approach | Cost | Coverage | Refresh | Filters | Setup | |---|---|---|---|---|---| | **โญ BitMEX Instruments Scraper** *(this Actor)* | $5 free credit, then pay-per-use | **All active BitMEX instruments** | **Live per run** | type, quote, sort, max items | โšก 2 min | | Aggregator APIs (Coinglass, CoinGecko) | Free tier + paid plans | Many venues, less granular | Minutes | API-specific | โณ Hours | | Direct BitMEX SDKs | Free | Same upstream, but you maintain code | On-demand | Build your own | ๐Ÿ› ๏ธ Days | | Manual page scraping | Free | Fragile, captcha-prone | Variable | None | ๐Ÿข Brittle | Pick this Actor when you want a clean, classified feed of BitMEX derivatives with zero maintenance. *** ### ๐Ÿš€ How to use 1. ๐Ÿ“ **Sign up.** [Create a free account with $5 credit](https://console.apify.com/sign-up?fpr=vmoqkp) (takes 2 minutes). 2. ๐ŸŒ **Open the Actor.** Go to the BitMEX Instruments Scraper page on the Apify Store. 3. ๐ŸŽฏ **Set input.** Pick an instrument type (or leave empty for all), choose a quote currency and sort, and set `maxItems`. 4. ๐Ÿš€ **Run it.** Click **Start** and let the Actor pull live instruments from BitMEX. 5. ๐Ÿ“ฅ **Download.** Grab your results from the **Dataset** tab as CSV, Excel, JSON, or XML. > โฑ๏ธ Total time from signup to a downloaded instrument dataset: **3-5 minutes.** No coding required. *** ### ๐Ÿ’ผ Business use cases
#### ๐Ÿค– Trading & Market Making - Perp funding monitoring for delta-neutral strategies - Open-interest tracking for sentiment signals - Basis trades between spot and futures legs - Cross-venue spread monitoring against Deribit, Binance Futures, OKX #### ๐Ÿ“Š Research & Analytics - Open-interest history for derivatives reports - Volume share comparisons across venues - Volatility surface inputs from option strikes - Calendar spread analysis from listing and expiry dates
#### ๐Ÿ’ผ Treasury & Risk - Mark-to-market on derivatives positions - Funding cost projections via daily-scaled rate - Exposure reports filtered by underlying asset - Halt detection via the `state` and `hasLiquidity` fields #### ๐Ÿ—๏ธ Product & Data Platforms - Reference universes for crypto-derivatives apps - Symbol catalogs for trading dashboards - Backfill feeds for analytics platforms - Onboarding seeds for new structured products
*** ### ๐Ÿ”Œ Automating BitMEX Instruments Scraper Control the scraper programmatically for scheduled runs and pipeline integrations: - ๐ŸŸข **Node.js.** Install the `apify-client` NPM package. - ๐Ÿ **Python.** Use the `apify-client` PyPI package. - ๐Ÿ“š See the [Apify API documentation](https://docs.apify.com/api/v2) for full details. The [Apify Schedules feature](https://docs.apify.com/platform/schedules) lets you trigger this Actor on any cron interval. Funding cycles update every 8 hours, so hourly pulls capture every regime change for downstream analytics. *** ### ๐ŸŒŸ Beyond business use cases The same structured derivatives data fuels more than commercial workflows.
#### ๐ŸŽ“ Research and academia - Perpetual-swap microstructure studies - Coursework on funding rates and basis arbitrage - Reproducible academic papers with versioned pulls - Open-data exercises on crypto derivatives #### ๐ŸŽจ Personal and creative - Personal derivatives dashboards - Side projects and indie funding-rate trackers - Content pieces on perpetual-swap mechanics - Hobbyist trading bots that need a clean live feed
#### ๐Ÿค Non-profit and civic - Transparency dashboards for crypto-savvy NGOs - Journalism on derivatives flows and leverage - Open-data feeds for civic-tech communities - Policy research on derivatives regulation #### ๐Ÿงช Experimentation - Train forecasting models on funding regimes - Prototype basis-trade agents with paper-trading data - Test alerting pipelines on open-interest spikes - Validate hypotheses on perp vs spot lead-lag
*** ### ๐Ÿค– Ask an AI assistant about this scraper Open a ready-to-send prompt about this ParseForge actor in the AI of your choice: - ๐Ÿ’ฌ [**ChatGPT**](https://chat.openai.com/?q=How%20do%20I%20use%20the%20BitMEX%20Instruments%20Scraper%20by%20ParseForge%20on%20Apify%3F%20Show%20me%20input%20examples%2C%20output%20fields%2C%20common%20use%20cases%2C%20and%20how%20to%20integrate%20it%20into%20a%20workflow.) - ๐Ÿง  [**Claude**](https://claude.ai/new?q=How%20do%20I%20use%20the%20BitMEX%20Instruments%20Scraper%20by%20ParseForge%20on%20Apify%3F%20Show%20me%20input%20examples%2C%20output%20fields%2C%20common%20use%20cases%2C%20and%20how%20to%20integrate%20it%20into%20a%20workflow.) - ๐Ÿ” [**Perplexity**](https://perplexity.ai/search?q=How%20do%20I%20use%20the%20BitMEX%20Instruments%20Scraper%20by%20ParseForge%20on%20Apify%3F%20Show%20me%20input%20examples%2C%20output%20fields%2C%20common%20use%20cases%2C%20and%20how%20to%20integrate%20it%20into%20a%20workflow.) - ๐Ÿ…’ [**Copilot**](https://copilot.microsoft.com/?q=How%20do%20I%20use%20the%20BitMEX%20Instruments%20Scraper%20by%20ParseForge%20on%20Apify%3F%20Show%20me%20input%20examples%2C%20output%20fields%2C%20common%20use%20cases%2C%20and%20how%20to%20integrate%20it%20into%20a%20workflow.) *** ### โ“ Frequently Asked Questions #### ๐Ÿงฉ How does it work? The Actor hits a single public BitMEX endpoint (`/api/v1/instrument/active`) and classifies every record. It maps the raw `typ` code to one of `perpetual`, `futures`, `spot`, or `other`, applies your filters and sort server-side, caps to `maxItems`, and writes a clean record per instrument. #### ๐Ÿ’ธ What is `fundingRateDaily`? BitMEX perpetuals pay funding three times a day (every 8 hours). The raw `fundingRate` field is the rate per funding period. `fundingRateDaily` is that rate multiplied by 3 to give you a quick read on the per-day cost or yield. Use the raw `fundingRate` for precise period-level math. #### ๐Ÿ” How often is the data refreshed? Every run pulls the latest snapshot of active instruments directly from BitMEX. Numbers like last price, open interest, and funding rate update on the exchange continuously, so a freshly triggered run is as live as the BitMEX API. #### ๐ŸŸง Does it cover options? Yes. BitMEX option instruments are returned as part of the active set and are classified as `futures` family by structural prefix; the `optionStrikePrice` field is populated for option rows. Use `instrumentType: ""` and filter downstream on `optionStrikePrice != null` if you only want option contracts. #### ๐Ÿ” Do I need an API key? No. The endpoints used here are entirely public. No login, no API key, no IP allowlist. #### โฐ Can I schedule regular runs? Yes. Use Apify Schedules to trigger this Actor on any cron cadence. Hourly pulls capture funding-cycle changes, daily pulls keep BI warehouses in sync. #### โš–๏ธ Is this data legal to use? BitMEX publishes instrument data through public endpoints. Review the venue terms of service for your specific commercial use, but raw market-data feeds are generally accepted for analytical and trading workflows. #### ๐Ÿ’ผ Can I use this data commercially? Yes. Public exchange instrument data is broadly usable for commercial analytics. Confirm your downstream license obligations for any redistribution to third parties. #### ๐Ÿ’ณ Do I need a paid Apify plan to use this Actor? No. The free Apify plan is enough for testing and small runs (10 records per run). A paid plan lifts that limit and unlocks scheduling, higher concurrency, and larger datasets. #### ๐Ÿ” What happens if a run fails or gets interrupted? Apify automatically retries transient errors. The Actor also retries 429 and 503 responses internally with exponential backoff. Partial datasets from failed runs are preserved, so you never lose progress. #### ๐Ÿ›ฌ What if I need order-book depth or trade history? This Actor returns instrument-level state. For full depth, trade history, or candle data, use the BitMEX REST or WebSocket endpoints directly, or reach out via the contact form for a companion scraper. #### ๐Ÿ†˜ What if I need help? Our support team is here to help. Contact us through the Apify platform or use the Tally form linked below. *** ### ๐Ÿ”Œ Integrate with any app BitMEX Instruments Scraper connects to any cloud service via [Apify integrations](https://apify.com/integrations): - [**Make**](https://docs.apify.com/platform/integrations/make) - Automate multi-step workflows - [**Zapier**](https://docs.apify.com/platform/integrations/zapier) - Connect with 5,000+ apps - [**Slack**](https://docs.apify.com/platform/integrations/slack) - Get run notifications in your channels - [**Airbyte**](https://docs.apify.com/platform/integrations/airbyte) - Pipe instrument data into your warehouse - [**GitHub**](https://docs.apify.com/platform/integrations/github) - Trigger runs from commits and releases - [**Google Drive**](https://docs.apify.com/platform/integrations/drive) - Export datasets straight to Sheets You can also use webhooks to trigger downstream actions when a run finishes. Push fresh funding rates into your product backend, or alert your team in Slack when open interest spikes. *** ### ๐Ÿ”— Recommended Actors - [**๐Ÿค– Hugging Face Model Scraper**](https://apify.com/parseforge/hugging-face-model-scraper) - Open-source AI model directory and metadata - [**๐Ÿ“ˆ Indexmundi Scraper**](https://apify.com/parseforge/indexmundi-scraper) - Global demographic and economic indicators - [**๐Ÿข AWS Marketplace Scraper**](https://apify.com/parseforge/aws-marketplace-scraper) - Cloud software listings and pricing - [**๐Ÿ”Œ Stripe App Marketplace Scraper**](https://apify.com/parseforge/stripe-marketplace-scraper) - Fintech app directory metadata - [**โœˆ๏ธ OurAirports Scraper**](https://apify.com/parseforge/ourairports-scraper) - Global airport reference dataset > ๐Ÿ’ก **Pro Tip:** browse the complete [ParseForge collection](https://apify.com/parseforge) for more reference-data scrapers. *** **๐Ÿ†˜ Need Help?** [**Open our contact form**](https://tally.so/r/BzdKgA) to request a new scraper, propose a custom data project, or report an issue. *** > **โš ๏ธ Disclaimer:** this Actor is an independent tool and is not affiliated with, endorsed by, or sponsored by BitMEX or HDR Global Trading Limited. All trademarks mentioned are the property of their respective owners. Only publicly available instrument data is collected. # Actor input Schema ## `instrumentType` (type: `string`): Filter instruments by type. Leave empty for all. ## `quoteCurrency` (type: `string`): Filter pairs by quote currency. Leave empty for all. ## `maxItems` (type: `integer`): Free users: Limited to 10 items (preview). Paid users: Optional, max 1,000,000 ## `sortBy` (type: `string`): Sort results by this field ## Actor input object example ```json { "instrumentType": "", "quoteCurrency": "", "maxItems": 10, "sortBy": "volume24h" } ``` # Actor output Schema ## `overview` (type: `string`): Overview of scraped data ## `fullData` (type: `string`): Complete dataset # 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 '' with your token const client = new ApifyClient({ token: '', }); // Prepare Actor input const input = { "instrumentType": "", "quoteCurrency": "", "maxItems": 10, "sortBy": "volume24h" }; // Run the Actor and wait for it to finish const run = await client.actor("parseforge/bitmex-instruments-scraper").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 '' with your token. client = ApifyClient("") # Prepare the Actor input run_input = { "instrumentType": "", "quoteCurrency": "", "maxItems": 10, "sortBy": "volume24h", } # Run the Actor and wait for it to finish run = client.actor("parseforge/bitmex-instruments-scraper").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 '{ "instrumentType": "", "quoteCurrency": "", "maxItems": 10, "sortBy": "volume24h" }' | apify call parseforge/bitmex-instruments-scraper --silent --output-dataset ``` ## MCP server setup ```json { "mcpServers": { "apify": { "command": "npx", "args": [ "mcp-remote", "https://mcp.apify.com/?tools=parseforge/bitmex-instruments-scraper", "--header", "Authorization: Bearer " ] } } } ``` ## OpenAPI specification ```json { "openapi": "3.0.1", "info": { "title": "BitMEX Instruments Scraper", "description": "Scrape live active instruments from BitMEX public API including perpetual swaps, futures, and spot pairs with prices, volume, open interest, funding rate, mark price, and 24h stats. No API key required.", "version": "0.0", "x-build-id": "EO2cDgVzFz5Ec9jnI" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/parseforge~bitmex-instruments-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-parseforge-bitmex-instruments-scraper", "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/parseforge~bitmex-instruments-scraper/runs": { "post": { "operationId": "runs-sync-parseforge-bitmex-instruments-scraper", "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/parseforge~bitmex-instruments-scraper/run-sync": { "post": { "operationId": "run-sync-parseforge-bitmex-instruments-scraper", "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": { "instrumentType": { "title": "Instrument Type Filter", "enum": [ "", "perpetual", "futures", "spot" ], "type": "string", "description": "Filter instruments by type. Leave empty for all.", "default": "" }, "quoteCurrency": { "title": "Quote Currency Filter", "enum": [ "", "USD", "USDT" ], "type": "string", "description": "Filter pairs by quote currency. Leave empty for all.", "default": "" }, "maxItems": { "title": "Max Items", "minimum": 1, "maximum": 1000000, "type": "integer", "description": "Free users: Limited to 10 items (preview). Paid users: Optional, max 1,000,000" }, "sortBy": { "title": "Sort By", "enum": [ "volume24h", "openInterest", "lastPrice", "symbol" ], "type": "string", "description": "Sort results by this field", "default": "volume24h" } } }, "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 } } } } } } } } } } ```