Social

Stack and user follow/unfollow operations

post

Manage stack subscriptions and user follow relationships. Auth requirements vary by action.

Authorizations

X-API-KEYstringRequired

API key with the ix_ prefix. You can generate an API Key by navigating to Settings -> API Key in the web app. Pass it in the X-API-KEY header on every request.

Query parameters

actionstring · enumRequired

The subscription action to perform.

Possible values:

Body

or

Responses

200

Successful response. Shape depends on action.

application/json

or

or

or

or

or

or

or

400

Bad request (missing fields, already following, not following, user not found, etc.).

application/json

post/api/subscription.php

POST /api/subscription.php?action=followers HTTP/1.1
Host: api.indexify.finance
X-API-KEY: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 14

{
  "stack_id": 1
}

{
  "followers": 1,
  "is_following": true,
  "success": "success"
}

Creator leaderboard

get

Returns a ranked list of creators sorted by the chosen metric. Authentication is optional; when authenticated, is_following is populated for each creator.

Authorizations

X-API-KEYstringOptional

API key with the ix_ prefix. You can generate an API Key by navigating to Settings -> API Key in the web app. Pass it in the X-API-KEY header on every request.

Query parameters

actionstring · enumRequiredPossible values:

periodstring · enumOptional

Time period for leaderboard metrics.

Default: 7dPossible values:

limitinteger · max: 100Optional

Number of creators to return.

Default: 20

offsetintegerOptional

Pagination offset.

Default: 0

sort_bystring · enumOptional

Metric to sort creators by.

Default: pointsPossible values:

Responses

200

Leaderboard data.

application/json

400

Invalid sort_by parameter.

application/json

500

Internal server error.

application/json

get/api/user_info.php?action=leaderboard

GET /api/user_info.php?action=leaderboard?action=leaderboard HTTP/1.1
Host: api.indexify.finance
X-API-KEY: YOUR_API_KEY
Accept: */*

{
  "creators": [
    {
      "rank": 1,
      "username": "text",
      "avatar": "text",
      "stacks_created": 1,
      "stack_trades": 1,
      "hit_rate": 1,
      "best_stack_ath": 1,
      "combined_pnl": 1,
      "points": 1,
      "last_activity": "text",
      "last_accessed": "text",
      "last_active": "text",
      "top_stack": {},
      "follower_count": 1,
      "is_following": true
    }
  ],
  "pagination": {
    "total_count": 1,
    "has_next": true,
    "offset": 1,
    "limit": 1
  },
  "metadata": {
    "period": "text",
    "sort_by": "text",
    "updated_at": "text",
    "source": "text"
  }
}

Top creators

post

Returns up to 5 top creators with their stack and follower counts. Authentication is optional; when authenticated, is_following is populated.

Authorizations

X-API-KEYstringOptional

API key with the ix_ prefix. You can generate an API Key by navigating to Settings -> API Key in the web app. Pass it in the X-API-KEY header on every request.

Query parameters

actionstring · enumRequiredPossible values:

Responses

200

Array of top creators.

application/json

usernamestringOptional

avatarstring · nullableOptional

stack_countintegerOptional

follower_countintegerOptional

is_followingboolean · nullableOptional

post/api/user_info.php?action=top_creators

POST /api/user_info.php?action=top_creators?action=top_creators HTTP/1.1
Host: api.indexify.finance
X-API-KEY: YOUR_API_KEY
Accept: */*

200

Array of top creators.

[
  {
    "username": "text",
    "avatar": "text",
    "stack_count": 1,
    "follower_count": 1,
    "is_following": true
  }
]

Public user profile

post

Returns a user's public profile information. No authentication required.

Authorizations

X-API-KEYstringRequired

API key with the ix_ prefix. You can generate an API Key by navigating to Settings -> API Key in the web app. Pass it in the X-API-KEY header on every request.

Query parameters

actionstring · enumRequiredPossible values:

Body

usernamestringRequired

Username to look up.

Responses

200

Public profile data.

application/json

usernamestringOptional

avatarstring · nullableOptional

biostring · nullableOptional

created_atstringOptional

slippagenumber · nullableOptional

priority_feenumber · nullableOptional

telegramstring · nullableOptional

discordstring · nullableOptional

twitterstring · nullableOptional

linkedinstring · nullableOptional

personalstring · nullableOptional

404

User not found.

application/json

500

Internal server error.

application/json

post/api/user_info.php?action=public_profile

POST /api/user_info.php?action=public_profile?action=public_profile HTTP/1.1
Host: api.indexify.finance
X-API-KEY: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 19

{
  "username": "text"
}

{
  "username": "text",
  "avatar": "text",
  "bio": "text",
  "created_at": "text",
  "slippage": 1,
  "priority_fee": 1,
  "telegram": "text",
  "discord": "text",
  "twitter": "text",
  "linkedin": "text",
  "personal": "text"
}

Public user profile metrics

post

Returns a user's public profile performance metrics. No authentication required.

Authorizations

X-API-KEYstringRequired

API key with the ix_ prefix. You can generate an API Key by navigating to Settings -> API Key in the web app. Pass it in the X-API-KEY header on every request.

Query parameters

actionstring · enumRequiredPossible values:

Body

usernamestringRequired

Username to look up.

Responses

200

Public profile metrics data.

application/json

best_stack_athnumber · nullableOptional

hit_ratenumber · nullableOptional

combined_pnlnumber · nullableOptional

followersintegerOptional

stack_countintegerOptional

pointsnumber · nullableOptional

404

User not found.

application/json

500

Internal server error.

application/json

post/api/user_info.php?action=public_profile_metrics

POST /api/user_info.php?action=public_profile_metrics?action=public_profile_metrics HTTP/1.1
Host: api.indexify.finance
X-API-KEY: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 19

{
  "username": "text"
}

{
  "best_stack_ath": 1,
  "hit_rate": 1,
  "combined_pnl": 1,
  "followers": 1,
  "stack_count": 1,
  "points": 1
}

Generate a referral link

post

Creates a new referral link with an auto-generated access code for the authenticated user.

Authorizations

X-API-KEYstringRequired

API key with the ix_ prefix. You can generate an API Key by navigating to Settings -> API Key in the web app. Pass it in the X-API-KEY header on every request.

Body

referral_codestringRequired

The referral code to embed in the link.

Responses

200

Referral link created.

application/json

referral_linkstringOptional

Full referral URL.

access_codestringOptional

Generated early-access code.

access_code_namestringOptional

Descriptive name of the access code.

referral_codestringOptional

The referral code that was provided.

expires_atstringOptional

Expiration timestamp of the access code.

400

Missing referral_code or invalid body.

application/json

401

User not authenticated.

application/json

405

Method not allowed (only POST is accepted).

application/json

500

Internal server error.

application/json

post/api/refer.php

POST /api/refer.php HTTP/1.1
Host: api.indexify.finance
X-API-KEY: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 24

{
  "referral_code": "text"
}

{
  "referral_link": "text",
  "access_code": "text",
  "access_code_name": "text",
  "referral_code": "text",
  "expires_at": "text"
}

Get referral data

get

Returns the authenticated user's multi-level referral tree with volume data for each referred user.

Authorizations

X-API-KEYstringRequired

API key with the ix_ prefix. You can generate an API Key by navigating to Settings -> API Key in the web app. Pass it in the X-API-KEY header on every request.

Responses

200

Multi-level referral data with volume statistics.

application/json

paginationobjectOptional

Pagination metadata from the incentive service.

401

User not authenticated.

application/json

404

User not found or username not set.

application/json

405

Method not allowed (only GET is accepted).

application/json

500

Internal server error.

application/json

get/api/referrals.php

GET /api/referrals.php HTTP/1.1
Host: api.indexify.finance
X-API-KEY: YOUR_API_KEY
Accept: */*

{
  "level1": [
    {
      "userId": "text",
      "username": "text",
      "volume_data": {
        "username": "text",
        "total_successful_orders": 1,
        "total_orders": 1,
        "total_volume_micro_usdc": 1,
        "total_volume_usdc": 1,
        "total_platform_fees_micro_usdc": 1,
        "total_platform_fees_usdc": 1,
        "total_creator_fees_micro_usdc": 1,
        "total_creator_fees_usdc": 1,
        "first_order_timestamp": 1,
        "last_order_timestamp": 1,
        "buy_volume_micro_usdc": 1,
        "buy_volume_usdc": 1,
        "sell_volume_micro_usdc": 1,
        "sell_volume_usdc": 1,
        "buy_orders_count": 1,
        "sell_orders_count": 1,
        "success_rate": 1
      }
    }
  ],
  "level2": [
    {
      "userId": "text",
      "username": "text",
      "volume_data": {
        "username": "text",
        "total_successful_orders": 1,
        "total_orders": 1,
        "total_volume_micro_usdc": 1,
        "total_volume_usdc": 1,
        "total_platform_fees_micro_usdc": 1,
        "total_platform_fees_usdc": 1,
        "total_creator_fees_micro_usdc": 1,
        "total_creator_fees_usdc": 1,
        "first_order_timestamp": 1,
        "last_order_timestamp": 1,
        "buy_volume_micro_usdc": 1,
        "buy_volume_usdc": 1,
        "sell_volume_micro_usdc": 1,
        "sell_volume_usdc": 1,
        "buy_orders_count": 1,
        "sell_orders_count": 1,
        "success_rate": 1
      }
    }
  ],
  "level3": [
    {
      "userId": "text",
      "username": "text",
      "volume_data": {
        "username": "text",
        "total_successful_orders": 1,
        "total_orders": 1,
        "total_volume_micro_usdc": 1,
        "total_volume_usdc": 1,
        "total_platform_fees_micro_usdc": 1,
        "total_platform_fees_usdc": 1,
        "total_creator_fees_micro_usdc": 1,
        "total_creator_fees_usdc": 1,
        "first_order_timestamp": 1,
        "last_order_timestamp": 1,
        "buy_volume_micro_usdc": 1,
        "buy_volume_usdc": 1,
        "sell_volume_micro_usdc": 1,
        "sell_volume_usdc": 1,
        "buy_orders_count": 1,
        "sell_orders_count": 1,
        "success_rate": 1
      }
    }
  ],
  "summary": {
    "total_referrals": 1,
    "total_volume_usdc": 1,
    "total_platform_fees_usdc": 1,
    "total_successful_orders": 1,
    "by_level": {
      "ANY_ADDITIONAL_PROPERTY": {
        "count": 1,
        "total_volume_usdc": 1,
        "total_platform_fees_usdc": 1,
        "total_successful_orders": 1
      }
    }
  },
  "pagination": {}
}