Skip to main content
GET
/
v1
/
addresses
/
{identifier}
/
profile
Get Profile
curl --request GET \
  --url https://api.clicker.xyz/v1/addresses/{identifier}/profile \
  --header 'Authorization: Bearer <token>'
{
  "id": "<string>",
  "name": "<string>",
  "images": {
    "raw": "<string>",
    "xs": "<string>",
    "sm": "<string>"
  },
  "addresses": [
    "<string>"
  ],
  "metadata": {
    "farcasterUsername": "<string>",
    "farcasterId": 123,
    "lensHandle": "<string>",
    "ensName": "<string>",
    "twitterHandle": "<string>",
    "debankName": "<string>",
    "hlName": "<string>",
    "commentCount30d": 123,
    "pnl30d": 123,
    "winRate30d": 123,
    "tradeCount30d": 123,
    "roiPercent30d": 123,
    "pnl7d": 123,
    "winRate7d": 123,
    "tradeCount7d": 123,
    "roiPercent7d": 123,
    "medianHoldingTimeMinutes": 123,
    "perAddressPnl30d": {},
    "perAddressRoiPercent30d": {},
    "perChainPnl30d": {
      "solana": 123,
      "ethereum": 123,
      "base": 123,
      "hyperliquid": 123
    },
    "perChainRoiPercent30d": {
      "solana": 123,
      "ethereum": 123,
      "base": 123,
      "hyperliquid": 123
    },
    "perChainVolumeUsd30d": {
      "solana": 123,
      "ethereum": 123,
      "base": 123,
      "hyperliquid": 123
    },
    "perChainPnl7d": {
      "solana": 123,
      "ethereum": 123,
      "base": 123,
      "hyperliquid": 123
    },
    "perChainRoiPercent7d": {
      "solana": 123,
      "ethereum": 123,
      "base": 123,
      "hyperliquid": 123
    },
    "perChainVolumeUsd7d": {
      "solana": 123,
      "ethereum": 123,
      "base": 123,
      "hyperliquid": 123
    }
  },
  "isNSFW": false,
  "metrics": {
    "thisPartner": {
      "followingCount": 123,
      "followerCount": 123
    },
    "allPartners": {
      "followingCount": 123,
      "followerCount": 123
    },
    "comments": {
      "commentCount30d": 123,
      "commentCountAllTime": 123
    },
    "copytradedAllTime": {
      "count": 123,
      "distinctActors": 123,
      "volumeUSD": 123
    }
  },
  "status": "unnamed",
  "externalId": "<string>",
  "isFollowedByUser": true
}

Documentation Index

Fetch the complete documentation index at: https://docs.clicker.xyz/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
identifier
string
required

Either a Profile UUID, wallet address

Query Parameters

​
viewerAddresses
string[]

Optional viewer address(es) to populate isFollowedByUser. Accepts a single address or an array of the viewer’s linked wallets (additional addresses beyond 10 are ignored).

Response

200

​
id
string
required
​
name
string
required
​
images
object
required

URLs for different size squares.

​
addresses
string[]
required
​
metadata
object
required
​
isNSFW
required

false when the profile is clean. Otherwise an object with nsfwImage and nsfwText booleans indicating which axes the scanner flagged. Clients decide whether to render, censor, or hide the underlying content.

Available options:
false
​
metrics
object
required

Social metrics for the profile

​
status
enum<string>
required

Indicates whether the profile's addresses are being tracked by the swaps indexer. unnamed means no addresses-to-check entries exist yet, backfilling means at least one is still pending backfill, active means all entries exist and have finished backfilling.

Available options:
unnamed,
backfilling,
active
​
externalId
string
​
isFollowedByUser
boolean

Whether the viewer follows this profile. Only populated on endpoints that accept a viewerAddresses query param (e.g. GET /v1/addresses/:identifier/profile). Absent on endpoints that do not surface follow status.