---
title: "Get current user leaderboard neighborhood"
method: GET
path: "/v1/leaderboard/users/me/neighborhood"
tags: ["user"]
---

# Get current user leaderboard neighborhood

`GET /v1/leaderboard/users/me/neighborhood`

## Request

- Base URL: `https://app.legend.trade/api/rest`
- URL: `https://app.legend.trade/api/rest/v1/leaderboard/users/me/neighborhood`
- Auth: HTTP bearer

## Query parameters

- `network` 'hyperliquid_mainnet' | 'hyperliquid_testnet'

## Response `200`

Successful response

- LeaderboardNeighborhoodOutput
  - `entries` LeaderboardNeighborhoodEntry[], required
    - `rank` integer, required
    - `isCurrentUser` boolean, required
    - `user` AvatarUser, required
      - `callerActions` UserActions: Null or false hides an action. Mutations check current permissions again.
        - `callerId` string, uuid, required
        - `follow` UserFollowAction, required
          - `isFollowing` boolean, required
        - `shareProfile` boolean, required
        - `autocopy` UserAutocopyAction, required
          - `activeCopyProfileId` string, uuid, nullable, required: The active copy owned by the caller. Null means no active copy exists.
        - `sendFunds` UserSendFundsAction, required
          - `walletAddress` string, required
        - `chat` boolean, required: Show the chat action. The chat API still checks access.
        - `clanInvite` UserClanInviteAction, required
          - `clanId` string, uuid, required
          - `status` 'available' | 'pending' | 'limit_reached', required: Enable the invite action only when the status is available.
        - `mute` UserMuteAction, required
          - `isMuted` boolean, required
        - `report` boolean, required
      - `id` string, required
      - `username` string, required
      - `display_name` string, required
      - `avatar_url` string, required
      - `rank` integer, nullable, required
      - `clan_id` string, nullable, required
      - `clan` UserClan, nullable
        - `id` string, required
        - `name` string, required
        - `description` string, nullable, required
        - `image_url` string, nullable, required
        - `banner_url` string, nullable, required
        - `chat_room_id` string, nullable, required
        - `created_at` string, required
        - `updated_at` string, required
      - `account_value_tier` integer, required
      - `is_official` boolean, required
  - `rank` integer, nullable, required
  - `total` integer, required

## Other responses

- `400`: Invalid input data
- `401`: Authorization not provided
- `403`: Insufficient access
- `404`: Not found
- `500`: Internal server error

## Changes

- **2026-10-25** `8d368659667e`: 5 breaking, 5 info
  - the response property `entries/items/user/clan/anyOf[subschema #1]/banner_url` became nullable for the status `200`
  - the response property `entries/items/user/clan/anyOf[subschema #1]/chat_room_id` became nullable for the status `200`
  - the response property `entries/items/user/clan/anyOf[subschema #1]/description` became nullable for the status `200`
  - the response property `entries/items/user/clan/anyOf[subschema #1]/image_url` became nullable for the status `200`
  - …6 more
- **2026-10-07** `440fd2d98e59`: 1 info
  - added the optional property `entries/items/user/callerActions` to the response with the `200` status
- **2026-08-27** `2e6f0d9a237e`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/legend/apis/legend-api/changes/v1/leaderboard/users/me/neighborhood/get.md)

---

[API](https://skmtc.dev/legend/apis/legend-api.md) - [All operations](https://skmtc.dev/legend/apis/legend-api/llms.txt) - [OpenAPI document](https://skmtc.dev/legend/apis/legend-api/revisions/c3e45061cf81?raw)