Quick Start

warning

The Silhouette API and SDK are in beta. We are actively adding new operations.

This guide will walk you through making your first API call to the Silhouette exchange, from setting up prerequisites to checking your balance.

Prerequisites

Before you can use the Silhouette API, you need to complete the following steps:

1. You must have a wallet address on Hyperliquid's L1 chain (HyperCore). This is your identity on the Silhouette platform.

2. Use Hyperliquid's spotSend operation to transfer funds to the Silhouette address to activate your account in Silhouette:

   Network	Silhouette address
   Mainnet	0x20b533DEFba689b6146a5C49250A59f2dbc75681
   Testnet	0xBc0E81a9A41e0119387ced63456deC0C597478E9

   tip

   For testnet, you can obtain free test USDC from the Hyperliquid testnet faucet.

   The spotSend operation transfers assets between addresses on the Hyperliquid network. Refer to the Hyperliquid documentation for details on executing this operation.

Quick Start

Step 0: Meet the Prerequisites

Make sure you meet all the prerequisites before interacting with Silhouette.

Step 1: Obtain a Bearer Token

warning

Anyone with your bearer token will have full access to your Silhouette account until it expires.

You need a bearer token to authenticate your API requests. The easiest way to obtain one is through the login assistant:

1. Visit the login assistant
2. Connect your Ethereum wallet
3. Sign the authentication message
4. Copy the bearer token provided

For detailed information about the authentication process, including manual authentication flow, see the Authentication page.

Step 2: Make Your First API Call

Now that you have a bearer token, you can make your first API call. Let's retrieve your account balance using the getBalances operation.

Request:

curl https://api.silhouette.exchange/v0 \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_TOKEN_HERE" \
  -d '{
    "operation": "getBalances"
  }'

Replace YOUR_TOKEN_HERE with the bearer token you obtained in Step 1.

Expected response:

{
  "operation": "getBalances",
  "balances": [
    {
      "token": "USDC",
      "available": "1000000000",
      "availableFloat": "1000.0",
      "locked": "0",
      "lockedFloat": "0.0",
      "total": "1000000000",
      "totalFloat": "1000.0"
    }
  ],
  "responseMetadata": {
    "timestamp": 1234567890,
    "requestId": "550e8400-e29b-41d4-a716-446655440000"
  }
}

The balances array shows your available balance for each token. Note that balances are represented in the token's smallest unit (for USDC, this is micro-USDC, so the value "1000000000" represents 1,000 USDC).

You've successfully made your first API call. You can now explore other operations in the Reference documentation.

Next Steps

• Explore the Authentication page for detailed information about SIWE authentication
• Review the Reference for all available API operations
• Check the Troubleshooting page if you encounter any issues
• Try the Python SDK for a higher-level integration