okx-account

Included with Lifetime

$97 forever

Read-only OKX tracking: unified-account equity, perp positions, orders, fills, bills. Use when monitoring OKX without trading (e.g. account equity, current PnL, recent fills, withdrawal history, margin level).

Data & Analyticsokxaccountreadonlytrackingfuturesspotswapscripts

What this skill does


# OKX Account (Read-Only)

Read-only OKX account tracker built on the official `python-okx` library.
Use it for account tracking, daily/weekly reports, risk alerts, and cashflow attribution.

## How to Get an OKX API Key (Read-Only)

1. Sign in at [okx.com](https://www.okx.com), top-right avatar → **API**
   - Direct link: https://www.okx.com/account/my-api
2. **Create V5 API Key** → complete 2FA verification
3. Fill the form:
   - **API name**: anything
   - **Passphrase**: ⚠️ a brand-new password used to sign API requests, **NOT your login password**. Lose it and you can only delete the key and create a new one.
   - **Permissions**: tick **Read** only, leave Trade / Withdraw off
   - **IP whitelist**: leave empty
4. Submit → **immediately copy and save** all three values: `API Key` / `Secret Key` / `Passphrase` (Secret is shown only once)
5. Set them into this skill's environment variables

Reference: [OKX official tutorial](https://www.okx.com/help/how-can-i-create-an-api-key)

## Prerequisites

### 1) API key
In OKX API Management create a key with **Read only**. OKX requires three credentials: `api_key` / `secret` / `passphrase` (the password you set when creating the key — not the login password).

### 2) Environment variables
```
OKX_RO_API_KEY=...
OKX_RO_SECRET=...
OKX_RO_PASSPHRASE=...
```

### 3) Geo restriction (required)
OKX geo-blocks server IPs. Scripts default to the SC internal HK proxy:
```python
HK_PROXY = "http://hk:[email protected]:8080"
```
Do not set a global `HTTP_PROXY`.

## Scripts

```bash
python3 skills/okx-account/scripts/okx_account.py <action> [options]
python3 skills/okx-account/scripts/account_scenarios.py <scenario> [options]
```

## Actions

- `summary`: one-shot summary
- `account_balance` / `account_config` / `positions` / `position_risk` / `fee_rates` / `bills`
- `open_orders` / `order_history` / `fills_history`
- `funding_balance` / `deposits` / `withdrawals` / `currencies` / `funding_rate`

## Scenarios

- `portfolio_snapshot`: full account snapshot
- `perp_risk`: perpetual risk monitoring (margin ratio + unrealized loss thresholds)
- `cashflow`: deposits + withdrawals + 7d bills aggregation
- `trading_activity`: recent fills activity by instType

## Common usage

```bash
python3 skills/okx-account/scripts/okx_account.py summary
python3 skills/okx-account/scripts/account_scenarios.py portfolio_snapshot
python3 skills/okx-account/scripts/account_scenarios.py perp_risk --loss-threshold 5000
python3 skills/okx-account/scripts/account_scenarios.py cashflow --limit 100
python3 skills/okx-account/scripts/account_scenarios.py trading_activity --inst-types SPOT,SWAP
```

## Notes

- The `passphrase` is easy to forget — it is the password you set when creating the key, not your login password.
- If you bound an IP whitelist when creating the key, either disable it or add the proxy egress IP.
- Use time-windowed pagination for high-volume fills.

Files: 4

Size: 17.6 KB

Complexity: 45/100

Category: Data & Analytics

Source: https://github.com/starchild-ai-agent/official-skills/tree/main/okx-account

Related in Data & Analytics

clawarr-suite

Included

Comprehensive management for self-hosted media stacks (Sonarr, Radarr, Lidarr, Readarr, Prowlarr, Bazarr, Overseerr, Plex, Tautulli, SABnzbd, Recyclarr, Unpackerr, Notifiarr, Maintainerr, Kometa, FlareSolverr). Deep library exploration, analytics, dashboard generation, content management, request handling, subtitle management, indexer control, download monitoring, quality profile sync, library cleanup automation, notification routing, collection/overlay management, and media tracker integration (Trakt, Letterboxd, Simkl).

Data & Analyticsscripts

querying-soql

Included

SOQL query generation, optimization, and analysis with 100-point scoring. Use this skill when the user needs SOQL/SOSL authoring or optimization: natural-language-to-query generation, relationship queries, aggregates, query-plan analysis, and performance or safety improvements for Salesforce queries. TRIGGER when: user writes, optimizes, or debugs SOQL/SOSL queries, touches .soql files, or asks about relationship queries, aggregates, or query performance. DO NOT TRIGGER when: bulk data operations (use handling-sf-data), Apex DML logic (use generating-apex), or report/dashboard queries.

Data & Analyticsscripts

app-store-optimization

Included

App Store Optimization (ASO) toolkit for researching keywords, analyzing competitor rankings, generating metadata suggestions, and improving app visibility on Apple App Store and Google Play Store. Use when the user asks about ASO, app store rankings, app metadata, app titles and descriptions, app store listings, app visibility, or mobile app marketing on iOS or Android. Supports keyword research and scoring, competitor keyword analysis, metadata optimization, A/B test planning, launch checklists, and tracking ranking changes.

Data & Analyticsscripts

habit-flow

Included

AI-powered atomic habit tracker with natural language logging, streak tracking, smart reminders, and coaching. Use for creating habits, logging completions naturally ("I meditated today"), viewing progress, and getting personalized coaching.

Data & Analyticsscripts

app-store-optimization

Included

Data & Analyticsscripts

visualizing-data

Included

Builds dashboards, reports, and data-driven interfaces requiring charts, graphs, or visual analytics. Provides systematic framework for selecting appropriate visualizations based on data characteristics and analytical purpose. Includes 24+ visualization types organized by purpose (trends, comparisons, distributions, relationships, flows, hierarchies, geospatial), accessibility patterns (WCAG 2.1 AA compliance), colorblind-safe palettes, and performance optimization strategies. Use when creating visualizations, choosing chart types, displaying data graphically, or designing data interfaces.

Data & Analyticsscripts