Xquik

https://xquik.com/docs
Admin
Xquik is a REST API platform providing programmatic access to X data and automation, with endpoints...
Tokens:3,522
Snippets:35
Trust Score:7.5
Update:5 months ago
Show doc for...
Tokens:
Raw
### Opt-in Response Contract Example

Source: https://xquik.com/docs

Shows how to opt-in to the best-practice response contract by sending the `xquik-api-contract` header.

```APIDOC
## GET /api/v1/events (Opt-in Contract)

### Description
Fetches events using the opt-in best-practice response contract.

### Method
GET

### Endpoint
/api/v1/events

### Headers
- **xquik-api-contract** (string) - Required - Set to `2026-04-29` to opt-in.

### Request Example
```bash
curl "https://xquik.com/api/v1/events" \
 -H "x-api-key: xq_YOUR_KEY_HERE" \
 -H "xquik-api-contract: 2026-04-29"
```

### Response
#### Success Response (200)
- **events** (array) - List of event objects.
- **has_more** (boolean) - Indicates if there are more results.
- **next_cursor** (string) - The cursor for the next page of results.

#### Response Example
```json
{
  "events": [],
  "has_more": true,
  "next_cursor": "MjAyNi0wMi0yNFQxMDozMDowMC4wMDBa..."
}
```
```

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

### X Data Endpoint Pagination Example

Source: https://xquik.com/docs

Illustrates pagination for X data endpoints, where `next_cursor` is used with the `cursor` query parameter.

```APIDOC
## GET /api/v1/x/tweets/search

### Description
Searches for tweets using X data endpoints with cursor-based pagination.

### Method
GET

### Endpoint
/api/v1/x/tweets/search

### Query Parameters
- **query** (string) - Required - The search query.
- **cursor** (string) - Optional - The cursor to fetch results after.

### Request Example
```bash
curl "https://xquik.com/api/v1/x/tweets/search?query=xquik&cursor=DAABCgABGRnYttk__..." \
 -H "x-api-key: xq_YOUR_KEY_HERE"
```

### Response
#### Success Response (200)
- **tweets** (array) - List of tweet objects.
- **has_next_page** (boolean) - Indicates if there are more results.
- **next_cursor** (string) - The cursor for the next page of results.

#### Response Example
```json
{
  "tweets": [],
  "has_next_page": true,
  "next_cursor": "DAABCgABGRnYttk__..."
}
```
```

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

### Xquik API Key Authentication Header

Source: https://xquik.com/docs

Example of how to pass your API key using the 'x-api-key' header for authentication.

```text
x-api-key: xq_YOUR_KEY_HERE
```

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

### Verify API Key

Source: https://xquik.com/docs

This example demonstrates how to make a request to the /account endpoint to verify your API key. Replace `xq_YOUR_KEY_HERE` with your actual API key. A successful response indicates your key is valid.

```APIDOC
## GET /account

### Description
Retrieves account information, including plan details, usage limits, and credit information.

### Method
GET

### Endpoint
https://xquik.com/api/v1/account

### Parameters
#### Headers
- **x-api-key** (string) - Required - Your API key for authentication.

### Request Example
```bash
curl -s https://xquik.com/api/v1/account \
  -H "x-api-key: xq_YOUR_KEY_HERE"
```

### Response
#### Success Response (200)
- **plan** (string) - The current account plan.
- **monitorsAllowed** (integer) - The maximum number of monitors allowed.
- **monitorsUsed** (integer) - The number of monitors currently in use.
- **monitorBilling** (object) - Details about monitor billing.
  - **activeDailyEstimate** (string) - Estimated daily cost for active monitors.
  - **activeHourlyBurn** (string) - Hourly burn rate for active monitors.
  - **creditsPerActiveMonitorDay** (string) - Credits consumed per active monitor day.
  - **creditsPerActiveMonitorHour** (string) - Credits consumed per active monitor hour.
  - **eventsIncluded** (boolean) - Indicates if events are included.
  - **instantCheckIntervalSeconds** (integer) - The interval for instant checks in seconds.
  - **unlimitedSlots** (boolean) - Indicates if unlimited monitor slots are available.
- **creditInfo** (object) - Information about account credits.
  - **balance** (string) - The current credit balance.
  - **lifetimePurchased** (string) - Total credits purchased lifetime.
  - **lifetimeUsed** (string) - Total credits used lifetime.
  - **autoTopupEnabled** (boolean) - Whether auto top-up is enabled.
  - **autoTopupAmountDollars** (integer) - The amount in dollars for auto top-up.
  - **autoTopupThreshold** (string) - The threshold for triggering auto top-up.

#### Response Example
```json
{
  "plan": "active",
  "monitorsAllowed": 9007199254740991,
  "monitorsUsed": 0,
  "monitorBilling": {
    "activeDailyEstimate": "0",
    "activeHourlyBurn": "0",
    "creditsPerActiveMonitorDay": "500",
    "creditsPerActiveMonitorHour": "21",
    "eventsIncluded": true,
    "instantCheckIntervalSeconds": 1,
    "unlimitedSlots": true
  },
  "creditInfo": {
    "balance": "140000",
    "lifetimePurchased": "140000",
    "lifetimeUsed": "0",
    "autoTopupEnabled": false,
    "autoTopupAmountDollars": 10,
    "autoTopupThreshold": "50000"
  }
}
```
```

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

### Cursor-based Pagination Example

Source: https://xquik.com/docs

Demonstrates how to use cursor-based pagination to fetch subsequent pages of results. The `nextCursor` value from a previous response is passed as the `after` query parameter.

```APIDOC
## GET /api/v1/events

### Description
Fetches a list of events with cursor-based pagination.

### Method
GET

### Endpoint
/api/v1/events

### Query Parameters
- **after** (string) - Optional - The cursor to fetch results after.

### Request Example
```bash
curl "https://xquik.com/api/v1/events?after=MjAyNi0wMi0yNFQxMDozMDowMC4wMDBa..." \
 -H "x-api-key: xq_YOUR_KEY_HERE"
```

### Response
#### Success Response (200)
- **events** (array) - List of event objects.
- **hasMore** (boolean) - Indicates if there are more results.
- **nextCursor** (string) - The cursor for the next page of results.

#### Response Example
```json
{
  "events": [],
  "hasMore": true,
  "nextCursor": "MjAyNi0wMi0yNFQxMDozMDowMC4wMDBa..."
}
```
```

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

### Opt-in Error Handling Example

Source: https://xquik.com/docs

Illustrates the error response format when using the opt-in response contract, specifically for dependency failures.

```APIDOC
### Error Response (Opt-in Contract)

#### Error Response (424)
- **error** (object) - Contains error details.
  - **type** (string) - The type of error.
  - **code** (string) - The machine-readable error code.
  - **message** (string) - A human-readable error message.

#### Response Example
```json
{
  "error": {
    "type": "dependency_error",
    "code": "x_api_unavailable",
    "message": "X data source temporarily unavailable. Retry shortly."
  }
}
```
```

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

### Opt-In Response Contract Structure

Source: https://xquik.com/docs

Example of the response structure when opting into the v2 contract, featuring snake_case fields and updated pagination.

```json
{
  "events": [],
  "has_more": true,
  "next_cursor": "MjAyNi0wMi0yNFQxMDozMDowMC4wMDBa..."
}
```

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

### Successful Account Endpoint Response

Source: https://xquik.com/docs

Example JSON response when successfully verifying an API key with the account endpoint. This shows plan status, monitor limits, and credit information.

```json
{
  "plan": "active",
  "monitorsAllowed": 9007199254740991,
  "monitorsUsed": 0,
  "monitorBilling": {
    "activeDailyEstimate": "0",
    "activeHourlyBurn": "0",
    "creditsPerActiveMonitorDay": "500",
    "creditsPerActiveMonitorHour": "21",
    "eventsIncluded": true,
    "instantCheckIntervalSeconds": 1,
    "unlimitedSlots": true
  },
  "creditInfo": {
    "balance": "140000",
    "lifetimePurchased": "140000",
    "lifetimeUsed": "0",
    "autoTopupEnabled": false,
    "autoTopupAmountDollars": 10,
    "autoTopupThreshold": "50000"
  }
}
```

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

### Verify API Key with Account Endpoint

Source: https://xquik.com/docs

A curl command to test your API key by fetching account information. Replace 'xq_YOUR_KEY_HERE' with your actual key. Ensure the header name is lowercase 'x-api-key'.

```bash
curl -s https://xquik.com/api/v1/account \
  -H "x-api-key: xq_YOUR_KEY_HERE" | jq
```

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

### Opt-In Response Contract (v2)

Source: https://xquik.com/docs

Send 'xquik-api-contract: 2026-04-29' to opt in to the best-practice response contract. This contract uses snake_case field names, Unix timestamps, structured errors, and 'has_more'/'next_cursor' pagination.

```bash
curl "https://xquik.com/api/v1/events" \
 -H "x-api-key: xq_YOUR_KEY_HERE" \
 -H "xquik-api-contract: 2026-04-29"
```

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

### Cursor-Based Pagination (X Data Endpoints)

Source: https://xquik.com/docs

X data endpoints use a different pagination shape. When more results exist, the response includes 'has_next_page: true' and a 'next_cursor' value. Pass 'next_cursor' as the 'cursor' query parameter to fetch the next page.

```json
{
  "tweets": [],
  "has_next_page": true,
  "next_cursor": "DAABCgABGRnYttk__..."
}
```

```bash
curl "https://xquik.com/api/v1/x/tweets/search?query=xquik&cursor=DAABCgABGRnYttk__..." \
 -H "x-api-key: xq_YOUR_KEY_HERE"
```

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

### Cursor-Based Pagination (Platform Endpoints)

Source: https://xquik.com/docs

For endpoints like events, draws, and extractions, use cursor-based pagination. When more results exist, the response includes 'hasMore: true' and a 'nextCursor' value. Pass 'nextCursor' as the 'after' query parameter to fetch the next page.

```json
{
  "events": [],
  "hasMore": true,
  "nextCursor": "MjAyNi0wMi0yNFQxMDozMDowMC4wMDBa..."
}
```

```bash
curl "https://xquik.com/api/v1/events?after=MjAyNi0wMi0yNFQxMDozMDowMC4wMDBa..." \
 -H "x-api-key: xq_YOUR_KEY_HERE"
```

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

### Opt-In Error Handling (Dependency Failure)

Source: https://xquik.com/docs

Legacy dependency failures returning '502' will return '424 Failed Dependency' in the opt-in contract, with a structured error object.

```json
{
  "error": {
    "type": "dependency_error",
    "code": "x_api_unavailable",
    "message": "X data source temporarily unavailable. Retry shortly."
  }
}
```

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

### Xquik OpenAPI Specification YAML URL

Source: https://xquik.com/docs

Alternative URL for the API specification in YAML format.

```text
https://docs.xquik.com/openapi.yaml
```

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

### Xquik API Service Discovery URL

Source: https://xquik.com/docs

URL for API service discovery, following RFC 9727 conventions.

```text
https://xquik.com/.well-known/api-catalog
```

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

### Xquik OpenAPI Specification URL

Source: https://xquik.com/docs

URL to the full API specification in OpenAPI 3.1 format. This can be used with tools like Postman or to generate client libraries.

```text
https://xquik.com/openapi.json
```

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

### ID Format Convention

Source: https://xquik.com/docs

All IDs are returned as strings representing bigint values. Treat IDs as opaque strings and never parse them as numbers.

```json
{ "id": "123456789" }
```

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

### Xquik API Base URL

Source: https://xquik.com/docs

The base URL for all Xquik API v1 endpoints. All requests must use HTTPS.

```text
https://xquik.com/api/v1
```

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

### Error Response Format

Source: https://xquik.com/docs

All errors return a JSON body with an 'error' field containing a machine-readable error code. Common errors include 'invalid_input', 'unauthenticated', and 'not_found'.

```json
{ "error": "error_code" }
```

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

### Timestamp Format Convention

Source: https://xquik.com/docs

All timestamps use ISO 8601 format in UTC. Store and compare timestamps as strings or parse them into proper date objects.

```json
{ "createdAt": "2026-02-24T10:30:00.000Z" }
```
Tokens:
Raw