API Documentation
Version: Beta 0.3
GET https://api.rugp.app/v1/{network}/token/{address}
Headers
| Header | Description |
|---|---|
Content-Type |
Specifies the format of the request body. Must be application/json. |
Accept |
Specifies the expected response format. Must be application/json. |
Authorization |
Bearer token for authorization. Use Bearer {token}. |
Rate Limit
Currently, there is no rate limit. However, we recommend limiting requests to 10 requests per minute to avoid potential future issues.
Parameters
| Parameter | Type | Description |
|---|---|---|
{network} |
string (required) | One of the following values: [ton, bsc, base, eth, tron, solana]. Represents the network where the token is being searched. |
{address} |
string (required) | Contract address in one of the following formats: token address, pool address, or $TICKER (if already scanned and in our database). Preferred format: token address. |
Responses
Error Response
{
"success": false,
"error": "Error description"
}
Success Response
{
"success": true,
"token": {
"address": string,
"name": string,
"symbol": string,
"image": ?string,
"description": ?string,
"holders_count": int,
"supply": int,
"links": [
{
"url": string,
"label": string
}
],
"is_known_master": bool,
"is_known_wallet": bool,
"is_revoked": bool,
"is_honeypot": bool,
"is_rugpull": bool,
"is_original": bool,
"is_scam": bool,
"is_low_liquidity": bool,
"likes_count": int,
"dislikes_count": int
},
"pools": [
{
"link": string,
"dex": string,
"address": string,
"price": float,
"supply": int,
"fdv": float,
"reserve": float,
"can_buy": bool,
"can_sell": bool,
"tax_buy": ?bool,
"tax_sell": ?bool,
"stats": {
"m5": {
"volume": float,
"price_change": float,
"buys": int,
"sells": int
},
"h1": {
"volume": float,
"price_change": float,
"buys": int,
"sells": int
},
"h6": {
"volume": float,
"price_change": float,
"buys": int,
"sells": int
},
"h24": {
"volume": float,
"price_change": float,
"buys": int,
"sells": int
}
},
"burned": {
"amount": ?float,
"percent": ?float
},
"locked": {
"type": ?string,
"percent": ?float,
"dyor": bool,
"unlocks_at": ?string
}
}
]
}
Descriptions of Response Fields
Note: Fields prefixed with "?" can accept a null value.
Stats
| Field | Description |
|---|---|
| volume | The trading volume for the given period. |
| price_change | The change in price over the specified period. |
| buys | Number of buy transactions during the specified period. |
| sells | Number of sell transactions during the specified period. |
Token
| Field | Description |
|---|---|
| address | Address of the token. |
| name | Name of the token. |
| symbol | Symbol or ticker of the token. |
| image | Link to the image of the token. Can be null. |
| description | Description of the token. Can be null. |
| holders_count | Number of holders of the token. |
| supply | Total supply of the token. |
| links | Links to social media or relevant websites related to the token. |
| is_known_master | Indicates whether the token has a standard contract code. |
| is_known_wallet | Indicates whether the token uses a standard wallet code. |
| is_revoked | Indicates whether the permissions have been revoked. |
| is_honeypot | Indicates whether the token is a honeypot. |
| is_rugpull | Indicates whether the token is potentially a rugpull. |
| is_original | Indicates whether the token is original. |
| is_scam | Indicates whether the token is a scam. |
| is_low_liquidity | Indicates whether the token has low liquidity. |
| likes_count | Number of likes the token has received on RUGP. |
| dislikes_count | Number of dislikes the token has received on RUGP. |