API Endpoints

This page covers all available API endpoints, including request formats, response structures, and example queries to help you get started.


1. Token Analysis

GET /v1/token/:address

Returns comprehensive token analysis, including:

  • Risk indicators and scoring

  • Market metrics and valuation

  • Liquidity pool analysis

  • Ownership distribution

  • Deployment details

  • Audit risk factors

1.1 Response Type:

interface TokenData {
  address: string;
  tokenName: string;
  tokenSymbol: string;
  tokenImg: string;
  score: number;
  deployTime: string;
  marketCap: number;
  externals: string;
  price: string;
  supplyAmount: number;
  mktCap: number;

  auditRisk: {
    mintDisabled: boolean;
    freezeDisabled: boolean;
    lpBurned: boolean;
    top10Holders: boolean;
  };

  tokenOverview: {
    deployer: string;
    mint: string;
    address: string;
    type: string;
  };

  indicatorData: {
    high: { count: number; details: string };
    moderate: { count: number; details: string };
    low: { count: number; details: string };
    specific: { count: number; details: string };
  };

  liquidityList: Array<Record<string, {
    address: string;
    amount: number;
    lpPair: string;
  }>>;

  ownersList: {
    address: string;
    amount: string;
    percentage: string;
  }[];
}

2. AI Agents

2.1 List Available Agents

GET /v1/agents

Returns all available AI agents with their capabilities:

  • Agent identification

  • Supported analysis types

  • Specialization areas

  • System configuration

2.2 Response Type:

interface Agent {
  id: string;
  name: string;
  description: string;
  capabilities: ('token_analysis' | 'market_analysis' | 'risk_assessment')[];
}

3. Get Specific Agent

GET /v1/agents/:id

Returns detailed information about a specific AI agent:

  • Complete agent profile

  • Available capabilities

  • System configuration

  • Specialization details


4. Chat with an AI Agent

POST /v1/agents/:id/chat

Interactive conversation with AI agents, allowing:

  • Token analysis requests

  • Risk assessment queries

  • Market insights

  • Custom analysis requests

4.1 Request Body:

{
  "messages": [
    {
      "role": "user" | "assistant" | "system" | "function",
      "content": "string",
      "name": "string (optional)"
    }
  ]
}

4.2 Response Type:

interface AgentResponse {
  response: string;  // AI-generated analysis
  timestamp: string; // Response timestamp
}

Check out the Flexo SDK for seamless integration into your applications. The SDK simplifies access to our powerful API endpoints with easy-to-use pre-built functions.

Last updated