> ## Documentation Index
> Fetch the complete documentation index at: https://dexbuilder.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# DexBuilder Platform API authentication

> Use a Broker API Key and pass user wallet addresses on DexBuilder Platform endpoints.

Call DexBuilder Platform API endpoints at [https://api.dexbuilder.com](https://api.dexbuilder.com) using the /api/v4/dexbuilder path prefix. Every endpoint requires KEY, Timestamp, and SIGN headers. See [Broker API Key and signing](https://dexbuilder.mintlify.site/en/api-reference/common/broker-authentication.md).

Your Broker API Key needs the dex\_builder product permission. Read operations require read or read-write access; submission operations require read-write access. An end user's personal API Key cannot replace a Broker API Key.

## User wallet

Asset-configuration endpoints do not require `X-User-Wallet-Address`. User, deposit, and withdrawal endpoints require the target user's wallet address in this header. The gateway verifies that the wallet belongs to your Broker. See [Access on behalf of a user](https://dexbuilder.mintlify.site/en/api-reference/common/sub-user-wallet.md) for the full list.

## Device type

Some platform endpoints require the `x-perp-device-type` header. Supported values are `1` (Android), `2` (iOS), and `3` (WEB). `4` (H5) is not accepted by these DexBuilder Platform endpoints. Follow each endpoint's required parameters.

Withdrawal submission also requires Idempotency-Key. Other headers are specified on the relevant endpoint pages.

## Example request

```bash theme={null}
curl -i --request GET "https://api.dexbuilder.com/api/v4/dexbuilder/user/info" \
  --header "KEY: <BROKER_API_KEY>" \
  --header "SIGN: <SIGN>" \
  --header "Timestamp: <UNIX_SECONDS>" \
  --header "X-User-Wallet-Address: <USER_WALLET>" \
  --header "Accept: application/json"
```

Generate SIGN for the exact external path, method, query string, body, and timestamp that you send.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.