STX.CITY Documentation
  • 🏙️Welcome to STXCITY
  • Features
    • 💡Deploy Token
      • 🧑‍🔧Update token metadata
      • 🔥Burn token
    • 🎁Airdrop Token
    • 💸Listing Token
    • 📈Portfolio
    • 🤖Swap Bot Notification
  • Bonding Curve
    • ❓How does it work?
    • ⚡How to Create a Bonding Curve Token
    • ⚡Deploy incomplete dex
    • 🧑‍🏫Technical explanation
    • 🔐Audited & Secured Contract
  • API
    • Get Bonding Curve List
    • Search tokens
    • Analytics
    • Get All Deployed Tokens
  • Support
    • 💰Pricing
    • ❓Frequently Asked Questions
Powered by GitBook
On this page
  • Analytics API Documentation
  • Overview
  • Endpoints
  • Error Handling

Was this helpful?

  1. API

Analytics

PreviousSearch tokensNextGet All Deployed Tokens

Last updated 8 months ago

Was this helpful?

Analytics API Documentation

Overview

The Analytics API provides endpoints to fetch various analytics data related to bonding curve activities and token & airdrops.

It is designed to support client-side applications that require real-time data for analytics dashboards.

Endpoints

1. Activities Summary for Bonding Curve

  • Endpoint: /api/fetchFrontEnd/activities_summary

  • Method: GET

  • Query Parameters:

    • timeframe: (string) The timeframe for fetching the summary data. Acceptable values: daily, weekly, monthly, all.

  • Response:

    • 200 OK

      {
        "dailyVolumeSTX": number,
        "dailyVolumeUSD": number,
        "dailyUniqueAddresses": number,
        "dailyTotalTXs": number,
        "weeklyVolumeSTX": number,
        "weeklyVolumeUSD": number,
        "weeklyUniqueAddresses": number,
        "weeklyTotalTXs": number,
        "monthlyVolumeSTX": number,
        "monthlyVolumeUSD": number,
        "monthlyUniqueAddresses": number,
        "monthlyTotalTXs": number,
        "allVolumeSTX": number,
        "allVolumeUSD": number,
        "allUniqueAddresses": number,
        "allTotalTXs": number
      }

2. Normal Tokens and Airdrop Summary

  • Endpoint: /api/fetchFrontEnd/analytics_tokens_airdrop

  • Query Parameters:

    • timeframe: (string) The timeframe for which to fetch the token airdrop data. Acceptable values: daily, weekly, monthly, all.

  • Response:

    • 200 OK

      {
        "dailyTokenCreation": number,
        "dailyAirdropEvent": number,
        "weeklyTokenCreation": number,
        "weeklyAirdropEvent": number,
        "monthlyTokenCreation": number,
        "monthlyAirdropEvent": number,
        "allTokenCreation": number,
        "allAirdropEvent": number
      }

Error Handling

  • 400 Bad Request: Returned when the request parameters are invalid.

  • 404 Not Found: Returned when the requested resource does not exist.

  • 500 Internal Server Error: Returned when there is an unexpected error on the server.

Method: GET

https://stx.city/api/fetchFrontEnd/activities_summary?timeframe=all
https://stx.city/api/fetchFrontEnd/analytics_tokens_airdrop?timeframe=all