# Crosswalk API

This document provides detailed information on the Crosswalk Ecosystem’s API endpoints, which allow for transparent access to token data, supply, and distribution details.

***

#### Base URL

All API endpoints are available under the following base URL:

`https://crosswalk.pro/api/`

***

### 1. Circulating Supply

**Endpoint:** `/circulating-supply`

**Method:** `GET`

**Description:** Returns the current circulating supply of the Crosswalk (CSW) token. This value represents tokens that are in circulation.

**Example URL:** `https://crosswalk.pro/api/circulating-supply`

**Response Example:**

```json
{
  "circulatingSupply": 6000000000
}
```

***

### 2. Total Supply

**Endpoint:** `/total-supply`

**Method:** `GET`

**Description:** Returns the total supply of the Crosswalk (CSW) token. This includes all tokens minted, whether they are in circulation, locked, or vested.

**Example URL:** `https://crosswalk.pro/api/total-supply`

**Response Example:**

```json
{
  "totalSupply": 8887375215.13
}
```

***

### 3. Top 100 Holders

**Endpoint:** `/holders-top100`

**Method:** `GET`

**Description:** Provides a list of the top 100 holders of the CSW token, along with their balances. Useful for analyzing the distribution of the largest holders.

**Example URL:** `https://crosswalk.pro/api/holders-top100`

**Response Example:**

```json
[
  {
    "address": "Fm3mQzfhBgqRowKTKsQkWJhtcs2J4tW1u8NsbAzc6Ktr",
    "balance": 1203700039.53,
    "percentage": 13.54
  },
  ...
]
```

***

### 4. Tokenomics

**Endpoint:** `/tokenomics`

**Method:** `GET`

**Description:** Returns comprehensive tokenomics data, including locked and unlocked amounts for each allocation category (e.g., Development, Team, Marketing), as well as vesting schedules, progress, and status (locked/unlocked) for each vesting tranche. The Liquidity Pool lock details are also included with real-time unlock countdown.

**Example URL:** `https://crosswalk.pro/api/tokenomics`

**Response Example:**

```json
{
  "totalSupply": 8887375215.13,
  "lockedAmount": 3037037054,
  "categories": {
    "development": {
      "purpose": "Ecosystem Development",
      "percentage": 35,
      "vesting": [
        {
          "start": "2024-09-06T18:17:00",
          "end": "2024-11-01T18:17:00",
          "unlockAmount": 116666666.55,
          "totalAmount": 259259259,
          "progress": 45.5,
          "status": "locked"
        },
        ...
      ]
    },
    "team": {
      ...
    },
    "marketing": {
      "purpose": "Marketing",
      "percentage": 13,
      "unlockedAmount": 100000000,
      "vesting": "Unlocked, used for promotional purposes"
    },
    "liquidityPool": {
      "purpose": "Liquidity Pool",
      "locked": true,
      "platform": "UNCX",
      "lockDetails": {
        "sol": {
          "amount": 222.715254928,
          "percentage": 50
        },
        "csw": {
          "amount": 1058296942.37,
          "percentage": 50
        },
        "lockId": 34,
        "unlockDate": "2035-08-08T16:14:24Z",
        "expiry": "10 years 8 months 29 days",
        "owner": "ABWB6tk1WPAA2V7x8Y8ovut2Top9WyuJ9xbKWdhBjMzb"
      },
      "url": "https://solana.uncx.network/lockers/cpmm/7BbZ9gu8ks5yAwRNx7oMc4otpZVunvyJqCS4rywpD7L6"
    }
  }
}
```

***

### 5. Launch Date

**Endpoint:** `/launch-date`

**Method:** `GET`

**Description:** Returns the public launch date of the Crosswalk (CSW) token, indicating when the token was initially released to the public.

**Example URL:** `https://crosswalk.pro/api/launch-date`

**Response Example:**

```json
{
  "launchDate": "2024-08-28T00:00:00Z"
}
```

***

### 6. Latest Burn Event

**Endpoint:** `/latest-burn`

**Method:** `GET`

**Description:** Provides details of the latest burn event for the CSW token, including the amount burned, transaction ID, and timestamp.

**Example URL:** `https://crosswalk.pro/api/latest-burn`

**Response Example:**

```json
{
  "transactionId": "5Nx6J...",
  "amountBurned": 1000000,
  "timestamp": "2024-11-10T14:33:00Z",
  "details": {
    "burner": "AiscHF...spKvrD",
    "burnAmount": 1000000,
    "mint": "AZGFPtxBRbnZtXw4hgQF4BuSmWK3EhUg8omdUA9DEL3Y"
  }
}
```

***

### Usage Notes

* **Rate Limits**: Each endpoint may be subject to rate limits. For high-frequency requests, consider caching responses or staggering requests to avoid hitting rate limits.
* **Data Refresh**: Circulating and total supply are fetched in real-time. For accurate token distribution and vesting details, data is updated periodically and may reflect the latest status as of the current date.
* **API Response Format**: All endpoints return JSON responses for ease of integration.

***

These endpoints provide a complete and transparent overview of Crosswalk token data. For further customization or additional data needs, please reach out to the Crosswalk team.


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://crosswalk-ecosystem.gitbook.io/crosswalk-ecosystem-docs/crosswalk-api.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.