Skip to main content
KOL Play Logo

API Documentation

The KOLPLAY Developer API allows you to build powerful trading tools, analytics, and social applications on top of our real-time engine.

Base URL

https://vps.kolplay.xyz/api/v1

Authentication

Include your API key in the x-api-key header for all REST requests.

const response = await axios.get('https://vps.kolplay.xyz/api/v1/user/stats', {
  headers: { 'x-api-key': 'your_api_key_here' }
});

1. Tokens

Get Token Metrics

Returns real-time on-chain metrics for a specific token mint.

GET

/tokens/:mint/metrics

Real-time on-chain data

Get Token Mindmap

Fetches social mindmap data illustrating KOL involvement and social weight.

GET

/tokens/:mint/mindmap

Social influence & KOL network

Predict Token Performance

Get AI-powered trade predictions for a list of tokens.

POST

/tokens/predict

AI Confidence & Recommendations
No path parameters required.

2. Trades

Execute Swap

Queue an on-chain trade through the KOLPLAY execution engine.

POST

/trades/swap

On-chain execution
No path parameters required.

WebSockets

Real-time updates for trades and mindmap changes are delivered via Socket.IO.

Event
kol_trade_update

Broadcasts when any KOL executes a trade.

Event
mindmap_update

Fired when a token's social score shifts.