hyperliquid-sdk-cpp

A C++23 SDK for the Hyperliquid perpetuals and spot exchange API — REST (/info, /exchange) and WebSocket, with typed request/response models.

This SDK signs and submits real transactions on mainnet. Test against Environment::Testnet before pointing any code at Environment::Mainnet.

Requires CMake 3.16+, a C++23 compiler, and vcpkg for dependencies (OpenSSL, Boost.Asio/Beast, simdjson, nlohmann-json, spdlog, zlib, secp256k1, GTest).

git clone https://github.com/TuxedoFish/hyperliquid-sdk-cpp.git
cd hyperliquid-sdk-cpp

export VCPKG_ROOT=/path/to/vcpkg
cmake --preset default
cmake --build build -j "$(getconf _NPROCESSORS_ONLN)"

The default preset sets HYPERLIQUID_BUILD_EXAMPLES=ON and HYPERLIQUID_BUILD_TESTS=ON, and points CMAKE_TOOLCHAIN_FILE at $VCPKG_ROOT. To build only the library, configure manually with those options off:

cmake -B build -DCMAKE_TOOLCHAIN_FILE=$VCPKG_ROOT/scripts/buildsystems/vcpkg.cmake \
  -DHYPERLIQUID_BUILD_EXAMPLES=OFF -DHYPERLIQUID_BUILD_TESTS=OFF
cmake --build build -j "$(getconf _NPROCESSORS_ONLN)"

Run the test suite:

ctest --test-dir build

#include <hyperliquid/rest/RestApi.h>
#include <hyperliquid/config/Config.h>

int main() {
    hyperliquid::ApiConfig config;
    config.env = hyperliquid::Environment::Testnet;

    hyperliquid::RestApi api(config);

    auto meta = api.meta();
    for (const auto& asset : meta.universe) {
        // asset.name, asset.szDecimals, asset.maxLeverage
    }
}

See the Quickstart guide for the WebSocket equivalent and the async/typed-listener paths, and the Examples index for every runnable example in examples/ (order placement/modification, transfers, staking, vaults, and every websocket channel, over both REST and WebSocket).

Most examples read credentials from examples/test.json, a local, gitignored file you create yourself - it's never committed and the repo doesn't ship one. Copy the template at examples/example.json to examples/test.json and fill it in, or create it directly:

{
  "wallet": "0xYourAccountAddress",
  "privateKey": "yourPrivateKeyHex",
  "subaccount": "0xOptionalSubaccountAddress"
}

wallet/privateKey are required (subaccount is only read by the handful of examples that need one, e.g. ws_subaccount). Point this at a testnet wallet, not mainnet, while trying things out.

The tables below track which parts of the Hyperliquid API this SDK implements, cross-referenced against the current docs. This reflects main as of this writing — parallel work in the issue tracker is filling in gaps, so treat "not yet" as a snapshot, not a permanent gap.

Legend: ✅ implemented — ⬜ not yet implemented.

59 of 78 documented info endpoints implemented. One (tokenDetails) has a RestEndpointType enum value reserved but no request builder or method yet.

41 of 68 documented exchange actions implemented on REST (RestApi). WebsocketApi covers a smaller subset — placeOrder, cancelOrder, cancelOrderByCloid, scheduleCancel, modifyOrder, batchModifyOrder — plus posting meta/spotMeta/outcomeMeta/perpDexs info reads over the socket; the newer transfer/staking/TWAP actions are REST-only so far.

perpDeploy is a large multi-variant action (16 sub-actions sharing "type": "perpDeploy"); only registerAsset2 (deploying a new HIP-3 perp asset, optionally creating a new dex) is implemented. The other 15 variants (registerAsset, setOracle, setFundingMultipliers, setFundingInterestRates, haltTrading, setMarginTableIds, insertMarginTable, setFeeRecipient, setOpenInterestCaps, setSubDeployers, setMarginModes, setFeeScale, setGrowthModes, setPerpAnnotation, disableDex) are post-deployment admin/config actions for an already-deployed dex and are not yet implemented.

spotDeploy is likewise a multi-variant action (10 sub-actions sharing "type": "spotDeploy"); the 5 that make up the "create and launch a new spot token" (HIP-1/HIP-2) flow are implemented: registerToken2, userGenesis, genesis, registerSpot, registerHyperliquidity. The other 5 variants (setDeployerTradingFeeShare, enableQuoteToken, disableQuoteToken, requestEvmContract, outcome) are post-deployment admin/config actions on an already-deployed token and are not yet implemented.

24 of 24 documented channels have full typed parsing. fastAssetCtxs payloads are raw-DEFLATE (RFC 1951) compressed on the wire and decompressed internally (zlib) before parsing. outcomeMetaUpdates's data is itself an array of discriminated-union entries (one of outcomeCreated/outcomeSettled/questionUpdated/questionSettled per entry) - each entry dispatches its own onOutcomeMetaUpdate call.

• exchange-gateways — a multi-exchange connectivity layer providing low-latency order routing to Deribit (FIX 4.4) and Hyperliquid (WebSocket).

Using this SDK in your own project? Open a PR adding it here.

This SDK is under active development. Remaining endpoint and channel coverage is tracked in the issue tracker. See CHANGELOG.md for release history.

After cmake --install, downstream projects can consume the SDK via find_package:

find_package(hyperliquid-sdk CONFIG REQUIRED)
target_link_libraries(your_target PRIVATE hyperliquid-sdk::hyperliquid-sdk)

Contributions are welcome — see CONTRIBUTING.md for the repeatable pattern used to add a new endpoint, action, or websocket channel. This project follows a Code of Conduct; please report security vulnerabilities per SECURITY.md rather than in a public issue.

MIT — see LICENSE.