XTracker

https://xtracker.polymarket.com/docs
Admin
The XTracker API provides access to user tracking data, tweet metrics, and analytics for Polymarket.
Tokens:1,489
Snippets:8
Trust Score:9.9
Update:10 months ago
Show doc for...
Tokens:
Raw
### Get All Tracked Users Response Example (JSON)

Source: https://xtracker.polymarket.com/docs/index

This JSON object demonstrates the structure of a successful response when retrieving all tracked users. It includes user details, platform information, and tracking counts. The 'trackings' field would contain an array of tracking period objects.

```json
{
  "success": true,
  "data": [
    {
      "id": "uuid",
      "handle": "elonmusk",
      "name": "Elon Musk",
      "platformId": "44196397",
      "avatarUrl": "https://...",
      "verified": true,
      "trackings": [...],
      "_count": { "posts": 1250 }
    }
  ]
}
```

--------------------------------

### GET /users/[handle]

Source: https://xtracker.polymarket.com/docs/index

Retrieves details for a specific user identified by their handle.

```APIDOC
## GET /users/[handle]

### Description
Retrieves details for a specific user using their unique handle.

### Method
GET

### Endpoint
/users/[handle]

### Parameters
#### Path Parameters
- **handle** (string) - Required - The handle of the user to retrieve.

### Response
#### Success Response (200)
- **success** (boolean) - Indicates if the request was successful.
- **data** (object) - The user object containing details.

### Request Example
```
// Example: GET /users/elonmusk
```
```

--------------------------------

### GET /metrics/[userId]

Source: https://xtracker.polymarket.com/docs/index

Retrieves metrics for a specific user. Supports filtering by metric type, start date, and end date.

```APIDOC
## GET /metrics/[userId]

### Description
Retrieves metrics for a specific user identified by their ID. You can filter the metrics by type and date range.

### Method
GET

### Endpoint
/metrics/[userId]

### Parameters
#### Path Parameters
- **userId** (string) - Required - The ID of the user for whom to retrieve metrics.
#### Query Parameters
- **type** (string) - Optional, defaults to "daily" - Metric type (e.g., "daily", "hourly").
- **startDate** (ISO date) - Optional - Start date filter for metrics.
- **endDate** (ISO date) - Optional - End date filter for metrics.

### Response
#### Success Response (200)
- **success** (boolean) - Indicates if the request was successful.
- **data** (object) - The metrics object for the user.
```

--------------------------------

### GET /users

Source: https://xtracker.polymarket.com/docs/index

Retrieves a list of all tracked users along with their tracking periods. Supports filtering to include inactive trackings.

```APIDOC
## GET /users

### Description
Retrieves a list of all tracked users and their tracking periods. You can optionally include inactive trackings in the results.

### Method
GET

### Endpoint
/users

### Parameters
#### Query Parameters
- **includeInactive** (boolean) - Optional - Include inactive trackings

### Response
#### Success Response (200)
- **success** (boolean) - Indicates if the request was successful.
- **data** (array) - An array of user objects, each containing tracking information.
  - **id** (string) - The unique identifier for the user.
  - **handle** (string) - The user's platform handle.
  - **name** (string) - The user's display name.
  - **platformId** (string) - The user's platform-specific ID.
  - **avatarUrl** (string) - The URL of the user's avatar.
  - **verified** (boolean) - Indicates if the user is verified.
  - **trackings** (array) - An array of tracking period objects.
  - **_count** (object) - An object containing counts, e.g., posts.
    - **posts** (integer) - The number of posts.

### Response Example
{
  "success": true,
  "data": [
    {
      "id": "uuid",
      "handle": "elonmusk",
      "name": "Elon Musk",
      "platformId": "44196397",
      "avatarUrl": "https://...",
      "verified": true,
      "trackings": [...],
      "_count": { "posts": 1250 }
    }
  ]
}
```

--------------------------------

### GET /trackings

Source: https://xtracker.polymarket.com/docs/index

Retrieves all tracking periods across all users. Supports filtering to return only active trackings.

```APIDOC
## GET /trackings

### Description
Retrieves a list of all tracking periods across all users. By default, it returns only active trackings, but this can be overridden.

### Method
GET

### Endpoint
/trackings

### Parameters
#### Query Parameters
- **activeOnly** (boolean) - Optional, defaults to true - Filter to active trackings only

### Response
#### Success Response (200)
- **success** (boolean) - Indicates if the request was successful.
- **data** (array) - An array of tracking period objects.
```

--------------------------------

### GET /trackings/[id]

Source: https://xtracker.polymarket.com/docs/index

Retrieves a specific tracking period by its ID. Optionally includes computed statistics.

```APIDOC
## GET /trackings/[id]

### Description
Retrieves a specific tracking period identified by its unique ID. This endpoint can also include computed statistics for the tracking period.

### Method
GET

### Endpoint
/trackings/[id]

### Parameters
#### Path Parameters
- **id** (string) - Required - The unique identifier of the tracking period.
#### Query Parameters
- **includeStats** (boolean) - Optional - Include computed statistics

### Response
#### Success Response (200)
- **success** (boolean) - Indicates if the request was successful.
- **data** (object) - The tracking period object, potentially with statistics.
```

--------------------------------

### GET /users/[handle]/trackings

Source: https://xtracker.polymarket.com/docs/index

Retrieves all tracking periods associated with a specific user's handle. Can filter to return only active trackings.

```APIDOC
## GET /users/[handle]/trackings

### Description
Retrieves all tracking periods for a specific user, identified by their handle. You can filter the results to only include active trackings.

### Method
GET

### Endpoint
/users/[handle]/trackings

### Parameters
#### Path Parameters
- **handle** (string) - Required - The handle of the user.
#### Query Parameters
- **activeOnly** (boolean) - Optional - Only return active trackings

### Response
#### Success Response (200)
- **success** (boolean) - Indicates if the request was successful.
- **data** (array) - An array of tracking period objects for the user.
```

--------------------------------

### API Success and Error Response Formats (JSON)

Source: https://xtracker.polymarket.com/docs/index

These JSON structures define the standard format for all API responses. The success response includes a boolean flag, data payload, and an optional message. The error response indicates failure with a boolean flag and a descriptive error message.

```json
// Success Response
{
  "success": true,
  "data": { ... },
  "message": "Optional success message"
}

// Error Response
{
  "success": false,
  "error": "Error message description"
}
```
Tokens:
Raw