Profile API

Get Wallet Profile

curl --request GET \
  --url https://api.formo.so/v0/profiles/{id} \
  --header 'Authorization: Bearer <token>'

{
  "address": "0x9CC3cB28cd94eB4423B15cdA73346e204f59a407",
  "net_worth_usd": 125000.5,
  "ens": "vitalik.eth",
  "farcaster": null,
  "lens": null,
  "basenames": null,
  "linea": null,
  "discord": null,
  "telegram": null,
  "website": "https://example.com",
  "github": "github.com/username",
  "twitter": "@username",
  "linkedin": null,
  "email": null,
  "instagram": null,
  "facebook": null,
  "tiktok": null,
  "youtube": null,
  "reddit": null,
  "avatar": "https://example.com/avatar.png",
  "description": "Wallet description",
  "display_name": "Display Name",
  "updated_at": "2025-01-20T14:22:00Z",
  "tx_count": 1234,
  "first_onchain": "2024-01-15T10:30:00Z",
  "last_onchain": "2025-01-20T14:22:00Z",
  "first_seen": "2024-01-15T10:30:00Z",
  "last_seen": "2025-01-20T14:22:00Z",
  "first_utm_source": "google",
  "last_utm_source": "direct",
  "first_utm_medium": "cpc",
  "last_utm_medium": null,
  "first_utm_campaign": "summer_sale",
  "last_utm_campaign": null,
  "first_utm_content": null,
  "last_utm_content": null,
  "first_utm_term": null,
  "last_utm_term": null,
  "first_referrer": "example.com",
  "last_referrer": null,
  "first_referrer_url": "https://example.com/page",
  "last_referrer_url": null,
  "first_ref": "ref123",
  "last_ref": null,
  "location": "US",
  "device": "Desktop",
  "browser": "Chrome",
  "os": "macOS",
  "last_type": "track",
  "last_event": "Page Viewed",
  "last_properties": "{\"page\":\"/home\"}",
  "num_sessions": 45,
  "revenue": 1500.75,
  "volume": 50000,
  "points": 2500,
  "activity_dates": [
    "2024-01-15",
    "2024-01-16",
    "2024-01-20"
  ],
  "labels": [
    {
      "id": "label_123",
      "value": "Whale",
      "chain_id": "1",
      "source": "manual"
    }
  ],
  "apps": [
    {
      "chain_id": "1",
      "id": "uniswap",
      "name": "Uniswap",
      "img": "https://example.com/uniswap.png",
      "url": "https://uniswap.org",
      "balance_usd": 50000
    }
  ],
  "tokens": [
    {
      "chain_id": "1",
      "token_address": "0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48",
      "app_id": "usdc",
      "name": "USD Coin",
      "symbol": "USDC",
      "img": "https://example.com/usdc.png",
      "decimals": 6,
      "price": 1,
      "balance": "1000000000",
      "balance_usd": 1000
    }
  ]
}

GET

profiles

{id}

Get Wallet Profile

curl --request GET \
  --url https://api.formo.so/v0/profiles/{id} \
  --header 'Authorization: Bearer <token>'

{
  "address": "0x9CC3cB28cd94eB4423B15cdA73346e204f59a407",
  "net_worth_usd": 125000.5,
  "ens": "vitalik.eth",
  "farcaster": null,
  "lens": null,
  "basenames": null,
  "linea": null,
  "discord": null,
  "telegram": null,
  "website": "https://example.com",
  "github": "github.com/username",
  "twitter": "@username",
  "linkedin": null,
  "email": null,
  "instagram": null,
  "facebook": null,
  "tiktok": null,
  "youtube": null,
  "reddit": null,
  "avatar": "https://example.com/avatar.png",
  "description": "Wallet description",
  "display_name": "Display Name",
  "updated_at": "2025-01-20T14:22:00Z",
  "tx_count": 1234,
  "first_onchain": "2024-01-15T10:30:00Z",
  "last_onchain": "2025-01-20T14:22:00Z",
  "first_seen": "2024-01-15T10:30:00Z",
  "last_seen": "2025-01-20T14:22:00Z",
  "first_utm_source": "google",
  "last_utm_source": "direct",
  "first_utm_medium": "cpc",
  "last_utm_medium": null,
  "first_utm_campaign": "summer_sale",
  "last_utm_campaign": null,
  "first_utm_content": null,
  "last_utm_content": null,
  "first_utm_term": null,
  "last_utm_term": null,
  "first_referrer": "example.com",
  "last_referrer": null,
  "first_referrer_url": "https://example.com/page",
  "last_referrer_url": null,
  "first_ref": "ref123",
  "last_ref": null,
  "location": "US",
  "device": "Desktop",
  "browser": "Chrome",
  "os": "macOS",
  "last_type": "track",
  "last_event": "Page Viewed",
  "last_properties": "{\"page\":\"/home\"}",
  "num_sessions": 45,
  "revenue": 1500.75,
  "volume": 50000,
  "points": 2500,
  "activity_dates": [
    "2024-01-15",
    "2024-01-16",
    "2024-01-20"
  ],
  "labels": [
    {
      "id": "label_123",
      "value": "Whale",
      "chain_id": "1",
      "source": "manual"
    }
  ],
  "apps": [
    {
      "chain_id": "1",
      "id": "uniswap",
      "name": "Uniswap",
      "img": "https://example.com/uniswap.png",
      "url": "https://uniswap.org",
      "balance_usd": 50000
    }
  ],
  "tokens": [
    {
      "chain_id": "1",
      "token_address": "0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48",
      "app_id": "usdc",
      "name": "USD Coin",
      "symbol": "USDC",
      "img": "https://example.com/usdc.png",
      "decimals": 6,
      "price": 1,
      "balance": "1000000000",
      "balance_usd": 1000
    }
  ]
}

Retrieves wallet profile information for a given address. Returns comprehensive profile data including wallet properties, labels, on-chain activity, tokens, apps, and user engagement metrics.

Authentication

This endpoint requires authentication using a Workspace API Key with profiles:read permission. Include the API key in your request headers:

Authorization: Bearer <your_workspace_api_key>

The API key needs to have the read permission for profiles in the API settings. You can configure this in your workspace API key settings.

Authorizations

Authorization

string

header

required

JWT Bearer token for authentication. Format: 'Bearer '

Path Parameters

string

required

The wallet address to retrieve profile information for (must be a valid Ethereum address)

Response

Successfully retrieved wallet profile

address

string

required

The wallet address

net_worth_usd

number

required

Total net worth in USD

updated_at

string<date-time>

required

Last update timestamp (ISO 8601)

tx_count

integer

required

Total transaction count

first_onchain

string<date-time>

required

First on-chain activity timestamp (ISO 8601)

last_onchain

string<date-time>

required

Last on-chain activity timestamp (ISO 8601)

labels

object[]

required

Array of wallet labels

Show child attributes

ens

string | null

ENS name

farcaster

string | null

Farcaster username

lens

string | null

Lens handle

basenames

string | null

Base names

linea

string | null

Linea identifier

discord

string | null

Discord username

string | null

Telegram username

website

string | null

Website URL

github

string | null

GitHub username

twitter

string | null

Twitter/X handle

string | null

LinkedIn profile

string | null

Email address

instagram

string | null

Instagram handle

facebook

string | null

Facebook profile

tiktok

string | null

TikTok handle

youtube

string | null

YouTube channel

string | null

Reddit username

avatar

string | null

Avatar image URL

description

string | null

Profile description

display_name

string | null

Display name

first_seen

string<date-time> | null

First seen timestamp (ISO 8601)

last_seen

string<date-time> | null

Last seen timestamp (ISO 8601)

first_utm_source

string | null

First UTM source

last_utm_source

string | null

Last UTM source

first_utm_medium

string | null

First UTM medium

last_utm_medium

string | null

Last UTM medium

first_utm_campaign

string | null

First UTM campaign

last_utm_campaign

string | null

Last UTM campaign

first_utm_content

string | null

First UTM content

last_utm_content

string | null

Last UTM content

first_utm_term

string | null

First UTM term

last_utm_term

string | null

Last UTM term

first_referrer

string | null

First referrer domain

last_referrer

string | null

Last referrer domain

first_referrer_url

string | null

First referrer full URL

last_referrer_url

string | null

Last referrer full URL

first_ref

string | null

First referral code

last_ref

string | null

Last referral code

location

string | null

User location

device

string | null

Device type

browser

string | null

Browser name

string | null

Operating system

last_type

string | null

Last event type

last_event

string | null

Last event name

last_properties

string | null

Last event properties (JSON string)

num_sessions

integer | null

Total number of sessions

revenue

number | null

Total revenue

volume

number | null

Total volume

points

number | null

Total points

activity_dates

string<date>[] | null

Array of activity dates (YYYY-MM-DD format)

apps

object[] | null

Array of wallet apps (only included if wallet has associated apps)

Show child attributes

tokens

object[] | null

Array of wallet tokens (only included if wallet has associated tokens)

Show child attributes

Unsubscribe from Form Events

⌘I

API Documentation

Events API

Forms API

Profile API

Authentication

Authorizations

Path Parameters

Response

API Documentation

Events API

Forms API

Profile API

​Authentication

Authorizations

Path Parameters

Response

Authentication