# HyperLink Docs

## Docs

- [Introduction](https://docs.hyperlink.xyz/start/readme.md): HyperLink is a prime broker for Hyperliquid: confidential trading through a secure enclave with Hyperliquid's liquidity, lowest fees, and provable solvency.
- [Why Build HyperLink](https://docs.hyperlink.xyz/start/why-build-hyperlink.md): Why HyperLink is building the prime brokerage layer for Hyperliquid: pooled volume for lower fees, private execution, and a familiar API for serious trading teams.
- [Getting Started](https://docs.hyperlink.xyz/start/getting-started.md): Get started trading confidentially on HyperLink, the prime broker for Hyperliquid: connect a wallet, deposit funds, and place your first private trade.
- [Deposits & Withdrawals](https://docs.hyperlink.xyz/trade/deposits.md): How to deposit and withdraw funds on HyperLink, the prime broker for Hyperliquid: gasless HyperCore transfers into and out of your trading account.
- [Trading](https://docs.hyperlink.xyz/trade/trading.md): How trading works on HyperLink, the prime broker for Hyperliquid: order types, leverage, margining, liquidation, and open order limits explained.
- [Fees](https://docs.hyperlink.xyz/trade/fees.md): HyperLink trading, deposit, and withdrawal fees: the lowest Hyperliquid trading fee rates available to the protocol through pooled prime broker volume.
- [API Quickstart](https://docs.hyperlink.xyz/api/setup.md): Quickstart for HyperLink's API: base URLs, request signing, and a working code example to start trading Hyperliquid markets programmatically today.
- [Authentication & Keys](https://docs.hyperlink.xyz/api/api-keys.md): How HyperLink API keys work: agent wallets, EIP-712 signing, permissions, and how to create or revoke keys for programmatic Hyperliquid trading access.
- [Exchange Methods](https://docs.hyperlink.xyz/api/exchange-methods.md): Reference for HyperLink's unified POST /exchange endpoint: request format, action families, and Hyperliquid-compatible order and query examples used.
- [order](https://docs.hyperlink.xyz/api/exchange-methods/order.md)
- [cancelByCloid](https://docs.hyperlink.xyz/api/exchange-methods/cancelbycloid.md)
- [cancel](https://docs.hyperlink.xyz/api/exchange-methods/cancel.md)
- [withdraw](https://docs.hyperlink.xyz/api/exchange-methods/withdraw.md)
- [approveAgent](https://docs.hyperlink.xyz/api/exchange-methods/approveagent.md)
- [approveBuilderFee](https://docs.hyperlink.xyz/api/exchange-methods/approvebuilderfee.md)
- [claimRewards](https://docs.hyperlink.xyz/api/exchange-methods/claimrewards.md)
- [usdClassTransfer](https://docs.hyperlink.xyz/api/exchange-methods/usdclasstransfer.md)
- [sendAsset](https://docs.hyperlink.xyz/api/exchange-methods/sendasset.md)
- [agentSendAsset](https://docs.hyperlink.xyz/api/exchange-methods/agentsendasset.md)
- [updateLeverage](https://docs.hyperlink.xyz/api/exchange-methods/updateleverage.md)
- [updateIsolatedMargin](https://docs.hyperlink.xyz/api/exchange-methods/updateisolatedmargin.md)
- [topUpIsolatedOnlyMargin](https://docs.hyperlink.xyz/api/exchange-methods/topupisolatedonlymargin.md)
- [spotClearinghouseState](https://docs.hyperlink.xyz/api/exchange-methods/spotclearinghousestate.md)
- [clearinghouseState](https://docs.hyperlink.xyz/api/exchange-methods/clearinghousestate.md)
- [extraAgents](https://docs.hyperlink.xyz/api/exchange-methods/extraagents.md)
- [openOrders](https://docs.hyperlink.xyz/api/exchange-methods/openorders.md)
- [activeAssetData](https://docs.hyperlink.xyz/api/exchange-methods/activeassetdata.md)
- [userFills](https://docs.hyperlink.xyz/api/exchange-methods/userfills.md)
- [portfolio](https://docs.hyperlink.xyz/api/exchange-methods/portfolio.md)
- [userRateLimit](https://docs.hyperlink.xyz/api/exchange-methods/userratelimit.md)
- [userHistoricalOrders](https://docs.hyperlink.xyz/api/exchange-methods/userhistoricalorders.md)
- [userFundings](https://docs.hyperlink.xyz/api/exchange-methods/userfundings.md)
- [userNonFundingLedgerUpdates](https://docs.hyperlink.xyz/api/exchange-methods/usernonfundingledgerupdates.md)
- [maxBuilderFee](https://docs.hyperlink.xyz/api/exchange-methods/maxbuilderfee.md)
- [approvedBuilders](https://docs.hyperlink.xyz/api/exchange-methods/approvedbuilders.md)
- [Builder Codes](https://docs.hyperlink.xyz/api/builder-codes.md): Builder codes on HyperLink: charge an approved per-order fee on the orders your app routes to Hyperliquid, with fixed fee tiers and API-based claims.
- [WebSocket API](https://docs.hyperlink.xyz/api/websocket.md): HyperLink's WebSocket API for real-time private order, fill, and account updates, plus signed trading actions over one persistent connection to Hyperliquid.
- [SDKs](https://docs.hyperlink.xyz/api/sdks.md): Python and TypeScript SDKs for trading on HyperLink, the prime broker for Hyperliquid, using Hyperliquid-compatible signing and order formats throughout.
- [Security](https://docs.hyperlink.xyz/security/security.md): How HyperLink's secure enclave keeps Hyperliquid trading confidential, provably solvent, and always exitable, and what you still rely on to trust it.
- [Risks](https://docs.hyperlink.xyz/security/risks.md): Risks to understand before using HyperLink, the prime broker for Hyperliquid: smart contract, enclave, market, privacy, and dependency risk categories.
- [Audits](https://docs.hyperlink.xyz/security/audits.md): Independent security audits of HyperLink's smart contracts and TEE design by Sherlock, Trail of Bits, Obsidian Security, and Zenith Security firms.
- [Bug Bounty](https://docs.hyperlink.xyz/security/bug-bounty.md): HyperLink's bug bounty program: scope, severity-based rewards, and how to responsibly report vulnerabilities affecting funds, privacy, or trading integrity.
- [Smart Contracts](https://docs.hyperlink.xyz/security/smart-contracts.md): HyperLink's on-chain smart contracts on HyperEVM: addresses and purpose for deposits, withdrawals, fees, enclave verification, and hlHYPE staking.
- [Staking (hlHYPE)](https://docs.hyperlink.xyz/more/staking.md): Stake HYPE for hlHYPE, a liquid staking token from HyperLink, the prime broker for Hyperliquid, that grows in value as validator staking rewards accrue.
- [Official Links](https://docs.hyperlink.xyz/more/official-links.md): Official HyperLink links: website, web app, API, documentation, and social channels, to help you avoid impersonation and stale endpoints when trading.
- [Brand Assets](https://docs.hyperlink.xyz/more/brand-assets.md): Official HyperLink logo and logomark assets and the hlHYPE icon, available for press coverage, integrations, and community use cases.
- [FAQ](https://docs.hyperlink.xyz/more/faq.md): Common questions about HyperLink: confidentiality, deposits and withdrawals, fees, trading, and API integration.
- [Terms of Use](https://docs.hyperlink.xyz/legal/terms-of-use.md): The Terms of Use governing access to and use of HyperLink's web app, API, and other interfaces, including risk disclosures and dispute resolution.
- [Privacy Policy](https://docs.hyperlink.xyz/legal/privacy-policy.md): HyperLink's Privacy Policy: what information is collected across the web app, API, and other interfaces, and how that information is used and shared.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information, you can query the documentation dynamically by asking a question.
Perform an HTTP GET request on a page URL with the `ask` query parameter:
```
GET https://docs.hyperlink.xyz/start/readme.md?ask=<question>
```
The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.
Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
