Noctus API Documentation

Last Updated: Aug 20, 2024

Introduction

Welcome to the Noctus API Documentation. This API is automatically included at no additional cost with your Wallet Finder (Pro) or Influencer Wallet Database tool purchases. These endpoints allow authenticated users with the appropriate access level to retrieve the most recent data.

Authentication

All requests to the API endpoints require an access_key parameter for authentication. The access_key is the key used to access your services.

Rate Limits

The API enforces a rate limit of 20 requests per minute. If the rate limit is exceeded, the API will return an error message indicating the rate limit has been exceeded.

Error Responses


Wallet Finder API

Endpoint

GET /api/wallet-finder

Description

Retrieve the current full list of copy trade wallets with their corresponding details.

Parameters

Example Request

GET https://noctus.xyz/api/wallet-finder?key=YOUR_ACCESS_KEY

Response

{
    "status": "success",
    "wallets": [
        {
            "wallet": "Wallet Address",
            "chain": "Blockchain",
            "profit_30d": "Profit in USD (30 Days)",
            "roi_30d": "Return on Investment Percentage (30 Days)",
            "win_rate_30d": "Win Rate Percentage (30 Days)",
            "number_of_trades": "Number of Trades",
            "days_active": "Days Active",
            "avg_trades_per_day": "Average Trades Per Day",
            "pv_ratio": "P/V Ratio",
            "quality_score": "Quality Score",
            "platform": "Trading Platform",
            "last_trade": "Last Trade Date"
        }
        ...
    ]
}

Example Response

{
    "status": "success",
    "wallets": [
        {
            "wallet": "5DkN...MDS3",
            "chain": "Solana",
            "profit_30d": "10000",
            "roi_30d": "127",
            "win_rate_30d": "80",
            "number_of_trades": "50",
            "days_active": "30",
            "avg_trades_per_day": "5",
            "pv_ratio": "0.91",
            "quality_score": "8.5",
            "platform": "BullX",
            "last_trade": "07-27 00:52"
        }
    ]
}

Influencer Database API

Endpoint

GET /api/influencer-database

Description

Retrieve the current full list of influencer wallets along with their details, such as social media links and confidence scores.

Parameters

Example Request

GET https://noctus.xyz/api/influencer-database?key=YOUR_ACCESS_KEY

Response

{
    "status": "success",
    "wallets": [
        {
            "id": "Wallet ID",
            "wallet": "Wallet Address",
            "chain": "Blockchain",
            "image": "Image URL",
            "owner": "Owner Alias",
            "confidence": "Confidence Percentage (0-100)",
            "socials": {
                "twitter": "Twitter URL",
                "telegram": "Telegram URL",
                "telegram_group": "Telegram Group URL",
                "discord": "Discord URL",
                "discord_server": "Discord Server URL",
                "youtube": "YouTube URL"
            }
        }
        ...
    ]
}

Example Response

{
    "status": "success",
    "wallets": [
        {
            "id": "1",
            "wallet": "3xkN...A4E1",
            "chain": "Solana",
            "image": "https://noctus.xyz/image.png",
            "owner": "Influencer Name",
            "confidence": 99,
            "socials": {
                "twitter": "https://x.com/influencer",
                "telegram": null,
                "telegram_group": "https://t.me/influencer_group",
                "discord": "https://discord.com/influencer",
                "discord_server": null,
                "youtube": "https://youtube.com/influencer"
            }
        }
    ]
}

Additional Notes

Pagination: The APIs currently do not require pagination. All available data will be returned in a single response.

Data Accuracy: The data provided by the API is based on the latest available information and is subject to change as new data is collected and processed.

For further assistance, please contact us.

2024 © noctus.xyz