> ## Documentation Index
> Fetch the complete documentation index at: https://chainstack-docs-polygon-erigon-trace-deprecation.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Set display name | Hyperliquid exchange

> Set or clear your account display name on Hyperliquid (for leaderboards and social features). On Hyperliquid exchange.

<Info>
  You can only use this endpoint on the official Hyperliquid public API. It is not available through Chainstack, as the open-source node implementation does not support it yet. See [Hyperliquid methods](/docs/hyperliquid-methods) for the full availability breakdown.
</Info>

<Note>
  This endpoint requires signature authentication. See our comprehensive [Authentication via Signatures guide](/docs/hyperliquid-authentication-guide) for implementation details.
</Note>

The `setDisplayName` action sets your account's display name, used in leaderboards and social features. Set an empty string to remove the display name.

## Parameters

### Required parameters

* `action` (object, required) — The set-display-name action:
  * `type` (string) — Must be `"setDisplayName"`.
  * `displayName` (string) — The display name (max 20 characters). An empty string removes it.
* `nonce` (number, required) — Current timestamp in milliseconds.
* `signature` (object, required) — EIP-712 signature of the action.

### Optional parameters

* `expiresAfter` (number, optional) — Timestamp in milliseconds after which the request is rejected.

## Returns

Returns an object with the action status:

* `status` — `"ok"` if the request was processed.
* `response` — Contains operation details, with `type` `"default"`.

## Example request

<CodeGroup>
  ```shell cURL theme={null}
  curl -X POST https://api.hyperliquid.xyz/exchange \
    -H "Content-Type: application/json" \
    -d '{
      "action": {"type": "setDisplayName", "displayName": "satoshi"},
      "nonce": 1234567890123,
      "signature": {...}
    }'
  ```

  ```python Python (hyperliquid-python-sdk) theme={null}
  # Note: the official hyperliquid-python-sdk does not expose a setDisplayName
  # helper yet, so build and post the signed action directly.
  from hyperliquid.exchange import Exchange
  from hyperliquid.utils import constants
  from hyperliquid.utils.signing import sign_l1_action, get_timestamp_ms
  import eth_account

  # Public Hyperliquid mainnet endpoint
  wallet = eth_account.Account.from_key("0x...")  # your private key
  exchange = Exchange(wallet, constants.MAINNET_API_URL)

  timestamp = get_timestamp_ms()
  action = {"type": "setDisplayName", "displayName": "satoshi"}
  signature = sign_l1_action(
      wallet,
      action,
      None,  # vault_address
      timestamp,
      None,  # expires_after
      exchange.base_url == constants.MAINNET_API_URL,
  )
  result = exchange._post_action(action, signature, timestamp)
  print(result)
  ```

  ```typescript TypeScript (@nktkas/hyperliquid) theme={null}
  import { ExchangeClient, HttpTransport } from "@nktkas/hyperliquid";
  import { privateKeyToAccount } from "viem/accounts";

  // Public Hyperliquid mainnet endpoint (default transport)
  const wallet = privateKeyToAccount("0x..."); // viem or ethers account
  const transport = new HttpTransport();
  const exchange = new ExchangeClient({ transport, wallet });

  const result = await exchange.setDisplayName({ displayName: "satoshi" });

  console.log(result);
  ```
</CodeGroup>

## Response example

```json theme={null}
{
  "status": "ok",
  "response": {
    "type": "default"
  }
}
```

## Use cases

* **Personalize your account** — Show a name on leaderboards
* **Social features** — Make your account recognizable
* **Clear your name** — Send an empty string to remove the display name


## OpenAPI

````yaml openapi/hyperliquid_node_api/hypercore_exchange/exchange_set_display_name.json post /exchange
openapi: 3.0.0
info:
  title: Hyperliquid Exchange API
  version: 1.0.0
  description: >-
    API for trading operations on Hyperliquid exchange requiring authentication.
    ⚠️ WARNING: These endpoints require EIP-712 signatures for authentication.
    The example values provided will NOT work without proper cryptographic
    signing. You must implement EIP-712 signing to use these endpoints
    successfully.
servers:
  - url: https://api.hyperliquid.xyz
security: []
paths:
  /exchange:
    post:
      tags:
        - hyperliquid exchange
      summary: Set display name
      operationId: setDisplayName
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                action:
                  type: object
                  properties:
                    type:
                      type: string
                      default: setDisplayName
                      enum:
                        - setDisplayName
                      description: Action type
                    displayName:
                      type: string
                      description: >-
                        Display name (max 20 characters). Set to an empty string
                        to remove it.
                  required:
                    - type
                    - displayName
                nonce:
                  type: integer
                  description: Current timestamp in milliseconds
                signature:
                  type: object
                  description: EIP-712 signature of the action with r, s, v components
                  properties:
                    r:
                      type: string
                      example: >-
                        0x1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef
                    s:
                      type: string
                      example: >-
                        0xfedcba0987654321fedcba0987654321fedcba0987654321fedcba0987654321
                    v:
                      type: integer
                      example: 27
                  required:
                    - r
                    - s
                    - v
                expiresAfter:
                  type: integer
                  description: >-
                    Timestamp in milliseconds after which the request is
                    rejected (optional)
              required:
                - action
                - nonce
                - signature
            example:
              action:
                type: setDisplayName
                displayName: satoshi
              nonce: 1705234567890
              signature:
                r: >-
                  0x1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef
                s: >-
                  0xfedcba0987654321fedcba0987654321fedcba0987654321fedcba0987654321
                v: 27
      responses:
        '200':
          description: Set display name result
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                    description: Request status
                  response:
                    type: object
                    properties:
                      type:
                        type: string
                        default: default
                example:
                  status: ok
                  response:
                    type: default

````