---
title: "X Lead Finder"
method: GET
path: "/v1/x/leads"
tags: ["x"]
---

# X Lead Finder

`GET /v1/x/leads`

## Request

- Base URL: `https://chatterapi.com`
- URL: `https://chatterapi.com/v1/x/leads`
- Auth: HTTP bearer

Find tweets where people ask for a recommendation, compare tools, or complain about a tool in your category. Returns leads ranked by an intent score (0 to 1) with the matched phrases and the author's handle. Costs 3 credits per page. Tip: pass competitors to catch people looking to switch. Costs 3 credits.

## Query parameters

- `q` string, required
- `competitors` union
  - string
  - string[]
- `exclude` union
  - string
  - string[]
- `time` 'day' | 'week' | 'month' | 'year'
- `minScore` number
- `intents` union
  - string
  - string[]
- `cursor` string
- `lang` string

## Response `200`

Success

- object
  - `data` Lead[], required
    - `platform` 'reddit' | 'x', required
    - `kind` 'post' | 'comment' | 'tweet', required
    - `id` string, required
    - `url` string, required
    - `text` string, required
    - `author` string, nullable, required
    - `authorUrl` string, nullable, required
    - `community` string, nullable, required
    - `score` number, nullable, required
    - `createdAt` string, nullable, required: ISO 8601 UTC timestamp
    - `intent` 'asking_for_recommendation' | 'comparing_tools' | 'complaining_about_tool' | 'other', required
    - `intentScore` number, required
    - `matchedTerms` string[], required
  - `page` PageInfo
    - `nextCursor` string, nullable, required
    - `hasMore` boolean, required
  - `credits` Credits, required
    - `charged` integer, required
    - `remaining` integer, required
  - `requestId` string, required
  - `cached` boolean, required
  - `warnings` Warning[]
    - `code` 'partial_data' | 'stale_data' | 'platform_unavailable' | 'source_unavailable', required
    - `platform` 'reddit' | 'x'
    - `source` string
    - `fields` string[]

## Other responses

- `400`: Bad request: invalid_input
- `401`: Unauthorized: missing_key, invalid_key, key_revoked
- `402`: Payment required: insufficient_credits
- `403`: Forbidden: account_suspended, scope_denied
- `404`: Not found: not_found
- `429`: Too many requests: rate_limited
- `500`: Internal error: internal
- `502`: Bad gateway: upstream_error
- `504`: Gateway timeout: upstream_timeout

---

[API](https://skmtc.dev/chatterapi/apis/chatterapi-api.md) · [All operations](https://skmtc.dev/chatterapi/apis/chatterapi-api/llms.txt) · [OpenAPI document](https://skmtc.dev/chatterapi/apis/chatterapi-api/revisions/74036d6f908a?raw)