# Helio Developer Portal

- [Archive Account](/admin/accounts-funding/accounts/accounts-service_-account-archive): Archive a trading account by ID. Archived accounts are no longer treated as active trading accounts.
- [Create Account](/admin/accounts-funding/accounts/accounts-service_-account-create): Create a new trading account for a client profile. The account defines the client trading environment, including group and currency settings.
- [Get Account](/admin/accounts-funding/accounts/accounts-service_-account-get): Return the trading account properties for the specified account ID.
- [List Groups](/admin/accounts-funding/accounts/accounts-service_-account-group-list): Return the account groups available when creating or updating trading accounts.
- [List Accounts](/admin/accounts-funding/accounts/accounts-service_-account-list): Return a list of trading accounts based on the provided search, filter, and pagination criteria.
- [Update Account](/admin/accounts-funding/accounts/accounts-service_-account-update): Update an existing trading account. Use this to change account-level properties such as status, group, or other account configuration.
- [List Currencies](/admin/accounts-funding/accounts/accounts-service_-options-currencies): Return the account currencies supported for creating or configuring trading accounts.
- [Get Setting](/admin/accounts-funding/client--profiles/accounts-service_-get-client-settings): Return a single client profile setting by profile ID and setting key.
- [List Accounts](/admin/accounts-funding/client--profiles/accounts-service_-profile-accounts): Return all trading accounts owned by the specified client profile.
- [Change Password](/admin/accounts-funding/client--profiles/accounts-service_-profile-change-password): Change the password used by a client profile to authenticate and access client-facing trading services.
- [Create Profile](/admin/accounts-funding/client--profiles/accounts-service_-profile-create): Create a new client profile. Create one profile per client. A client profile can hold multiple trading accounts.
- [Delete Profile](/admin/accounts-funding/client--profiles/accounts-service_-profile-delete): Delete a client profile by ID. Use this when the client profile should no longer be available through the Accounts & Funding API.
- [Get Profile](/admin/accounts-funding/client--profiles/accounts-service_-profile-get): Return the client profile properties, including profile identity details such as name and email, and the trading accounts linked to the profile.
- [List Profiles](/admin/accounts-funding/client--profiles/accounts-service_-profile-list): Return a list of client profiles based on the provided search, filter, and pagination criteria.
- [Update Profile](/admin/accounts-funding/client--profiles/accounts-service_-profile-update): Replace the client profile data. Send the full updated profile object, including all fields that should remain on the profile.
- [Update Setting](/admin/accounts-funding/client--profiles/accounts-service_-update-client-settings): Create or update a single client profile setting by profile ID and setting key.
- [List Deals](/admin/accounts-funding/funding/accounts-service_-deals-list): Return balance and trading deals for the specified account based on the provided criteria.
- [Deposit Funds](/admin/accounts-funding/funding/accounts-service_-deposit-transaction): Create a deposit transaction that credits funds to the specified trading account.
- [Withdraw Funds](/admin/accounts-funding/funding/accounts-service_-withdraw-transaction): Create a withdrawal transaction that debits funds from the specified trading account.
- [Accounts & Funding](/admin/accounts-funding): REST API for brokers to onboard end-user clients, open trading accounts, and move funds. Used by CRMs, in-house back-office tools, and client cabinet/portal integrations.
- [Create Session](/admin/accounts-funding/sessions/accounts-service_-client-login): Authenticate a client profile and issue an end-user access token for client-facing trading services.
- [Admin Login](/admin/accounts-funding/sessions/accounts-service_-user-login): Authenticate a back-office user (CRM/broker operator) and issue a bearer admin access token used to call this API. Tokens are valid for 30 days. Requests must originate from a whitelisted IP address.
- [Open Positions](/admin/accounts-funding/trading/accounts-service_-get-positions): Return the open positions for the specified trading account.
- [Order History](/admin/accounts-funding/trading/accounts-service_-order-history): Return historical orders for the specified trading account within the requested date range.
- [Pending Orders](/admin/accounts-funding/trading/accounts-service_-orders-list): Return the working/inactive orders for the specified trading account.
- [Get Portfolio](/admin/accounts-funding/trading/accounts-service_-portfolio-get): Return the account portfolio snapshot, including balance, equity, margin, and related trading state values.
- [Position History](/admin/accounts-funding/trading/accounts-service_-position-history): Return historical positions for the specified trading account within the requested date range.
- [Admin APIs](/admin): gRPC-gateway REST endpoints for platform administration — CRM, accounts, funding, and corporate actions.
- [Home](/): Official API documentation for the Helio multi-asset trading platform — Admin REST APIs and Trader REST plus WebSocket APIs.
- [Login](/trader/api/authentication/client-login): Authenticates a client profile and returns JWT token with account information
- [OHLCV Bars](/trader/api/charting/get-bars): Returns historical OHLCV bars for the specified symbol and timeframe
- [Current OHLC Bars](/trader/api/charting/get-current-bars): Returns the last OHLCV bar for each requested symbol and timeframe in a single call
- [Symbols](/trader/api/configuration/get-symbols): Returns a list of trading symbols for a specific account group, enriched with template data
- [Exchange Rates](/trader/api/data/get-exchange-rate)
- [Get Tickers](/trader/api/data/get-public-ticker): Returns live mid prices and % change for all symbols, optionally filtered by asset class or symbol names. No authentication required.
- [List Deals](/trader/api/history/deal-history): Returns deal history for the authenticated user
- [List Orders](/trader/api/history/order-history): Returns order history for the authenticated user
- [List Positions](/trader/api/history/position-history): Returns position history for the authenticated user
- [HTTP API](/trader/api): End-user trading — symbols, portfolio, history, metrics, exchange rates, orders, positions, and authentication.
- [Funding Rates History](/trader/api/perps/get-funding-rate-history-by-symbol): Returns raw historical funding rates for a perpetual symbol. If `to` is omitted, defaults to the current UTC time.

- [Funding Rates](/trader/api/perps/get-funding-rate): Returns the live funding rate and next settlement for a perpetual symbol, scoped to the authenticated user's funding profile. Returns 404 if the symbol has no active funding rate or the account group has no funding profile.

- [Get Key](/trader/api/settings/get-client-setting): Returns the string value stored for the authenticated profile under the given key.
This is a general-purpose key-value store used for per-profile data such as watchlists,
UI preferences, notes, or account-level configuration. Callers may store any string;
JSON-encoded objects are common but not required.
Returns 400 if the key format is invalid, or 404 if the key has never been written.

- [Settings](/trader/api/settings/get-client-settings-batch): Returns the stored values for one or more keys belonging to the authenticated profile.
Pass a single key or a comma-separated list of keys via the `keys` query parameter.
Keys that have never been written are included in the response with a null value.
Returns 400 if any key fails the format validation (^[A-Za-z0-9_\-:#]+$, max 256 chars each).
Max 50 keys per request.

- [Update Key](/trader/api/settings/update-client-setting): Stores a string value under the given key for the authenticated profile (upsert).
This is a general-purpose key-value store used for per-profile data such as watchlists,
UI preferences, notes, or account-level configuration. Callers may store any text;
JSON-encoded objects are common but not required.
Max body size: 128 KB. Keys must match ^[A-Za-z0-9_\-:#]+$ (max 256 chars).

- [Amend Order](/trader/api/trading/amend-order): Amends an existing trading order for the authenticated user's account, including support for multi-level take profit and stop loss
- [Amend Position](/trader/api/trading/amend-position): Modifies multi-level take profit and stop loss orders for an existing position
- [Cancel Order](/trader/api/trading/cancel-order): Cancel a trading order for the authenticated user's account
- [Close Position](/trader/api/trading/close-position): Creates a market order to close an existing position (partial or full closing supported)
- [New Order](/trader/api/trading/create-order): Creates a new trading order for the authenticated user's account
- [Double Position](/trader/api/trading/double-position): Places a market order matching the position's symbol, side, and remaining open quantity. When the order fills, the resulting deal is merged into the existing position (VWAP recalculation + quantity increase).
- [Account Metrics](/trader/api/trading/get-account-metrics): Returns latest metrics snapshot for the authenticated user's account (PnL, Equity, Balance, Margins)
- [My Profile](/trader/api/trading/get-my-profile): Returns the profile of the authenticated user, identified by the JWT subject.
Includes identity fields (id, email, first/last name) and profile metadata
(language, country, address, etc.).

- [Portfolio](/trader/api/trading/get-portfolio): Returns account balances, metrics, positions, and orders for the authenticated user
- [Reverse Position](/trader/api/trading/reverse-position): Closes an open position with a market order and, on terminal fill, automatically opens an opposing position with the same filled quantity.
- [Trader APIs](/trader): Market data, trading, and streaming endpoints for building custom terminals, mobile apps, and algo/API trading.
- [Websocket API](/trader/websocket): Real-time streaming over a single authenticated WebSocket connection — quotes, depth, account metrics, and execution events.