Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.curl "https://apis.io/api/v1/apis/xquik-api-webhooks-api"curl "https://apis.io/api/v1/apis?limit=25"Discovery needs no key. Ratings and market analysis are Pro.
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
openapi: 3.2.0
info:
title: Xquik Webhooks API
version: '1.0'
description: Xquik is an independent third-party service.
x-guidance: '## Common tasks
**Find a tweet** - GET /x/tweets/{id}. Returns text, author, metrics, media, and creation time. Cost: $0.00015 per lookup.
**Search tweets** - GET /x/tweets/search?q={query}&limit={n}. Supports X operators, structured filters, Tweet IDs, and status URLs. Omit mode for automatic coverage. Cost: $0.00015 per returned tweet.
**Find a user** - GET /x/users/{id}. Accepts an ID or username. Cost: $0.00015 per lookup.
**Check if A follows B** - GET /x/followers/check?source={a}&target={b}. Accepts usernames or profile URLs. Cost: $0.00075.
**Get trends** - GET /trends?woeid={region}&count={n}. WOEID 1 is worldwide. Cost: $0.00045.
**Download media** - POST /x/media/download with `tweetIds`. Fresh Tweets cost 1 credit each. Cached repeats are free.
**Read an article** - GET /x/articles/{tweetId}. Cost: $0.00075.
## Pagination
Default platform pages return `hasMore` and `nextCursor`. X pages return `has_next_page` and `next_cursor`. The 2026-04-29 contract returns `has_more` and `next_cursor`. Pass cursors through `cursor`; `after` remains compatible. Dynamic pricing counts returned items, not requests.
Omit `mode` for automatic reads. Pass cursors unchanged. `mode=standard` remains legacy. Retry 409 responses after `Retry-After`. Restart 410 responses without a cursor.
## Authentication
Eligible reads accept guest wallets. Fixed-price lookups also accept MPP. Other features require an API key or OAuth 2.1 bearer token. API keys also support `Authorization: Bearer xq_...`.
## Best-Practice Response Contract
v1 remains the default. Send `xquik-api-contract: 2026-04-29` for snake_case, Unix timestamps, structured errors, unified pagination, resource objects, and prefixed IDs. Dependency failures use 424 instead of 502.'
contact:
name: Xquik
url: https://xquik.com
email: support@xquik.com
servers:
- url: https://xquik.com
security:
- apiKey: []
- oauthBearer: []
tags:
- name: Webhooks
description: Webhook endpoint management and delivery
paths:
/api/v1/webhooks:
get:
operationId: listWebhooks
summary: List webhooks
tags:
- Webhooks
security:
- apiKey: []
- oauthBearer: []
responses:
'200':
description: Webhook list
content:
application/json:
schema:
type: object
required:
- webhooks
properties:
webhooks:
type: array
items:
$ref: '#/components/schemas/Webhook'
example: []
example:
webhooks: []
'401':
$ref: '#/components/responses/Unauthenticated'
'429':
$ref: '#/components/responses/RateLimitExceeded'
default:
$ref: '#/components/responses/UnexpectedError'
description: List webhooks.
post:
operationId: createWebhook
summary: Create webhook
tags:
- Webhooks
security:
- apiKey: []
- oauthBearer: []
requestBody:
required: true
description: HTTPS callback URL and event types to subscribe to.
content:
application/json:
schema:
type: object
required:
- url
- eventTypes
properties:
url:
type: string
format: uri
description: HTTPS URL
example: https://example.com/webhook
eventTypes:
$ref: '#/components/schemas/EventTypeArray'
example:
- tweet.new
- tweet.reply
example:
url: https://example.com/webhook
eventTypes:
- tweet.new
- tweet.reply
responses:
'201':
description: Webhook created
content:
application/json:
schema:
type: object
required:
- id
- url
- secret
- eventTypes
- createdAt
properties:
id:
type: string
example: '42'
url:
type: string
format: uri
example: https://example.com/webhook
secret:
type: string
description: Plaintext HMAC signing secret returned only at creation.
example: a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2
eventTypes:
$ref: '#/components/schemas/EventTypeArray'
example:
- tweet.new
- tweet.reply
createdAt:
type: string
format: date-time
example: '2025-01-15T12:00:00Z'
example:
id: '42'
url: https://example.com/webhook
secret: a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2
eventTypes:
- tweet.new
- tweet.reply
createdAt: '2025-01-15T12:00:00Z'
'400':
$ref: '#/components/responses/InvalidInput'
'401':
$ref: '#/components/responses/Unauthenticated'
'429':
$ref: '#/components/responses/RateLimitExceeded'
default:
$ref: '#/components/responses/UnexpectedError'
description: Create webhook.
/api/v1/webhooks/{id}:
patch:
operationId: updateWebhook
summary: Update webhook
tags:
- Webhooks
security:
- apiKey: []
- oauthBearer: []
parameters:
- $ref: '#/components/parameters/ResourceId'
requestBody:
required: true
description: Updated URL, event types, or active status.
content:
application/json:
schema:
type: object
properties:
url:
type: string
format: uri
example: https://example.com/webhook
eventTypes:
$ref: '#/components/schemas/EventTypeArray'
example:
- tweet.new
isActive:
type: boolean
example: true
example:
url: https://example.com/webhook
isActive: true
responses:
'200':
description: Webhook updated
content:
application/json:
schema:
$ref: '#/components/schemas/Webhook'
example:
id: '42'
url: https://example.com/webhook
eventTypes:
- tweet.new
isActive: true
consecutiveFailures: 0
deliveryStatus: active
failureHardCap: 200
createdAt: '2025-01-15T12:00:00Z'
'400':
$ref: '#/components/responses/InvalidInput'
'401':
$ref: '#/components/responses/Unauthenticated'
'404':
$ref: '#/components/responses/NotFound'
'429':
$ref: '#/components/responses/RateLimitExceeded'
default:
$ref: '#/components/responses/UnexpectedError'
description: Update webhook.
delete:
operationId: deleteWebhook
summary: Deactivate webhook
tags:
- Webhooks
security:
- apiKey: []
- oauthBearer: []
parameters:
- $ref: '#/components/parameters/ResourceId'
responses:
'200':
$ref: '#/components/responses/Success'
'400':
$ref: '#/components/responses/InvalidInput'
'401':
$ref: '#/components/responses/Unauthenticated'
'404':
$ref: '#/components/responses/NotFound'
'429':
$ref: '#/components/responses/RateLimitExceeded'
default:
$ref: '#/components/responses/UnexpectedError'
description: Deactivate webhook.
/api/v1/webhooks/{id}/deliveries:
get:
operationId: listWebhookDeliveries
summary: List webhook deliveries
tags:
- Webhooks
security:
- apiKey: []
- oauthBearer: []
parameters:
- $ref: '#/components/parameters/ResourceId'
responses:
'200':
description: Delivery list
content:
application/json:
schema:
type: object
required:
- deliveries
properties:
deliveries:
type: array
items:
$ref: '#/components/schemas/Delivery'
example: []
example:
deliveries: []
'400':
$ref: '#/components/responses/InvalidInput'
'401':
$ref: '#/components/responses/Unauthenticated'
'404':
$ref: '#/components/responses/NotFound'
'429':
$ref: '#/components/responses/RateLimitExceeded'
default:
$ref: '#/components/responses/UnexpectedError'
description: List webhook deliveries.
/api/v1/webhooks/{id}/test:
post:
operationId: testWebhook
summary: Test webhook endpoint
tags:
- Webhooks
security:
- apiKey: []
- oauthBearer: []
parameters:
- $ref: '#/components/parameters/ResourceId'
responses:
'200':
description: Test result
content:
application/json:
schema:
type: object
required:
- success
- statusCode
properties:
success:
type: boolean
example: true
statusCode:
type: integer
example: 200
error:
type: string
example: ''
example:
success: true
statusCode: 200
'400':
$ref: '#/components/responses/InvalidInput'
'401':
$ref: '#/components/responses/Unauthenticated'
'404':
$ref: '#/components/responses/NotFound'
'429':
$ref: '#/components/responses/RateLimitExceeded'
default:
$ref: '#/components/responses/UnexpectedError'
description: Test webhook endpoint.
/api/v1/webhooks/{id}/resume:
post:
operationId: resumeWebhook
summary: Test and resume webhook endpoint
tags:
- Webhooks
security:
- apiKey: []
- oauthBearer: []
parameters:
- $ref: '#/components/parameters/ResourceId'
responses:
'200':
description: Webhook resumed after a successful test delivery
content:
application/json:
schema:
type: object
required:
- success
- statusCode
- webhook
properties:
success:
type: boolean
example: true
statusCode:
type: integer
example: 200
webhook:
$ref: '#/components/schemas/Webhook'
example:
success: true
statusCode: 200
webhook:
id: '42'
url: https://example.com/webhook
eventTypes:
- tweet.new
isActive: true
consecutiveFailures: 0
deliveryStatus: active
failureHardCap: 200
createdAt: '2025-01-15T12:00:00Z'
'400':
description: Webhook test failed
content:
application/json:
schema:
type: object
additionalProperties: false
required:
- error
- statusCode
- success
properties:
error:
type: string
description: Delivery failure returned by the webhook sender.
example: Connection timed out
statusCode:
type: integer
description: Webhook response status, or 0 before a response.
example: 0
success:
type: boolean
const: false
example:
error: Connection timed out
statusCode: 0
success: false
'401':
$ref: '#/components/responses/Unauthenticated'
'404':
$ref: '#/components/responses/NotFound'
'429':
$ref: '#/components/responses/RateLimitExceeded'
default:
$ref: '#/components/responses/UnexpectedError'
description: Test and resume webhook endpoint.
webhooks:
monitorEvent:
post:
description: Receive one signed Xquik monitor event.
operationId: receiveMonitorEvent
requestBody:
content:
application/json:
example:
data:
id: '1893456789012345678'
text: Example post.
eventType: tweet.new
username: example
schema:
properties:
data:
additionalProperties: true
type: object
eventType:
$ref: '#/components/schemas/EventType'
username:
type: string
required:
- eventType
- data
type: object
required: true
responses:
'200':
description: Event accepted.
security: []
summary: Receive monitor event
tags:
- Webhooks
components:
parameters:
ResourceId:
name: id
in: path
required: true
schema:
type: string
description: Resource ID returned by the matching create or list endpoint.
schemas:
EventType:
description: Type of monitor event fired when account activity occurs.
type: string
enum:
- tweet.new
- tweet.reply
- tweet.retweet
- tweet.quote
- tweet.media
- tweet.link
- tweet.poll
- tweet.mention
- tweet.hashtag
- tweet.longform
- profile.avatar.changed
- profile.banner.changed
- profile.name.changed
- profile.username.changed
- profile.bio.changed
- profile.location.changed
- profile.url.changed
- profile.verified.changed
- profile.protected.changed
- profile.pinned_tweet.changed
- profile.unavailable.changed
Webhook:
description: Webhook endpoint registered to receive event deliveries.
type: object
required:
- id
- url
- eventTypes
- isActive
- consecutiveFailures
- deliveryStatus
- failureHardCap
- createdAt
properties:
id:
type: string
url:
type: string
format: uri
eventTypes:
$ref: '#/components/schemas/EventTypeArray'
isActive:
type: boolean
consecutiveFailures:
type: integer
description: Consecutive failed delivery attempts since the last success.
deliveryStatus:
type: string
enum:
- active
- paused
- needs_attention
description: Endpoint delivery state. needs_attention means delivery stopped after repeated failures.
failureHardCap:
type: integer
description: Consecutive delivery failures that pause the endpoint.
createdAt:
type: string
format: date-time
Error:
description: 'Error response. Default v1 returns a legacy string error code. Send `xquik-api-contract: 2026-04-29` to receive the structured best-practice error object.
'
type: object
required:
- error
properties:
error:
x-stainless-naming:
python:
type_name: ErrorValue
java:
type_name: ErrorValue
oneOf:
- type: string
title: LegacyErrorCode
enum:
- internal_error
- account_already_connected
- account_needs_reauth
- account_not_found
- account_required
- account_restricted
- api_key_limit_reached
- article_not_found
- closed
- dm_not_permitted
- invalid_format
- invalid_id
- invalid_input
- invalid_params
- invalid_tool_type
- invalid_tweet_id
- invalid_tweet_url
- invalid_user_id
- invalid_user_ids
- invalid_username
- invalid_json
- insufficient_credits
- login_cooldown
- login_failed
- media_download_failed
- missing_params
- missing_query
- monitor_already_exists
- monitor_profile_unavailable
- no_media
- no_credits
- no_subscription
- not_found
- payment_failed
- rate_limit_exceeded
- service_unavailable
- style_not_found
- subscription_inactive
- tweet_not_found
- unauthenticated
- unsupported_field
- user_not_found
- body_too_large
- checkout_unavailable
- connection_challenge_expired
- connection_challenge_inactive
- coverage_cursor_gone
- coverage_cursor_unavailable
- draft_not_found
- expired
- favoriters_unavailable
- forbidden
- guest_wallet_unavailable
- guest_wallets_disabled
- guest_wallets_unavailable
- idempotency_conflict
- idempotency_key_conflict
- invalid_community_id
- invalid_complete_replies_request
- invalid_coverage_cursor
- invalid_coverage_request
- invalid_idempotency_key
- invalid_list_id
- invalid_output_options
- invalid_payment_amount
- invalid_range
- invalid_reply_options
- login_rate_limited
- login_service_unavailable
- missing_idempotency_key
- missing_ids
- missing_url
- no_cached_style
- passkey_required
- rate_limited
- read_request_timeout
- replies_incomplete
- support_media_rate_limit
- support_request_rate_limit
- too_many_ids
- too_many_tweets
- unknown_field
- unsupported_media_type
- webhook_inactive
- write_tracking_unavailable
- x_write_unconfirmed
- x_account_feature_required
- x_account_protected
- x_account_suspended
- x_api_rate_limited
- x_api_unavailable
- x_api_unauthorized
- x_auth_failure
- x_content_too_long
- x_daily_limit
- x_dm_not_allowed
- x_duplicate_action
- x_login_auth_failed
- x_login_challenge
- x_login_denied
- x_login_failed
- x_login_proxy_error
- x_login_rate_limited
- x_login_service_unavailable
- x_login_suspended
- x_rate_limited
- x_rejected
- x_target_not_found
- x_transient_error
- x_user_lookup_failed
- x_write_ambiguous
- x_write_failed
- type: object
title: StructuredError
required:
- message
- type
- code
properties:
message:
type: string
type:
type: string
enum:
- api_error
- authentication_error
- billing_error
- dependency_error
- invalid_request_error
- permission_error
- rate_limit_error
code:
type: string
title: ErrorCode
enum:
- internal_error
- account_already_connected
- account_needs_reauth
- account_not_found
- account_required
- account_restricted
- api_key_limit_reached
- article_not_found
- closed
- dm_not_permitted
- invalid_format
- invalid_id
- invalid_input
- invalid_params
- invalid_tool_type
- invalid_tweet_id
- invalid_tweet_url
- invalid_user_id
- invalid_user_ids
- invalid_username
- invalid_json
- insufficient_credits
- login_cooldown
- login_failed
- media_download_failed
- missing_params
- missing_query
- monitor_already_exists
- monitor_profile_unavailable
- no_media
- no_credits
- no_subscription
- not_found
- payment_failed
- rate_limit_exceeded
- service_unavailable
- style_not_found
- subscription_inactive
- tweet_not_found
- unauthenticated
- unsupported_field
- user_not_found
- body_too_large
- checkout_unavailable
- connection_challenge_expired
- connection_challenge_inactive
- coverage_cursor_gone
- coverage_cursor_unavailable
- draft_not_found
- expired
- favoriters_unavailable
- forbidden
- guest_wallet_unavailable
- guest_wallets_disabled
- guest_wallets_unavailable
- idempotency_conflict
- idempotency_key_conflict
- invalid_community_id
- invalid_complete_replies_request
- invalid_coverage_cursor
- invalid_coverage_request
- invalid_idempotency_key
- invalid_list_id
- invalid_output_options
- invalid_payment_amount
- invalid_range
- invalid_reply_options
- login_rate_limited
- login_service_unavailable
- missing_idempotency_key
- missing_ids
- missing_url
- no_cached_style
- passkey_required
- rate_limited
- read_request_timeout
- replies_incomplete
- support_media_rate_limit
- support_request_rate_limit
- too_many_ids
- too_many_tweets
- unknown_field
- unsupported_media_type
- webhook_inactive
- write_tracking_unavailable
- x_write_unconfirmed
- x_account_feature_required
- x_account_protected
- x_account_suspended
- x_api_rate_limited
- x_api_unavailable
- x_api_unauthorized
- x_auth_failure
- x_content_too_long
- x_daily_limit
- x_dm_not_allowed
- x_duplicate_action
- x_login_auth_failed
- x_login_challenge
- x_login_denied
- x_login_failed
- x_login_proxy_error
- x_login_rate_limited
- x_login_service_unavailable
- x_login_suspended
- x_rate_limited
- x_rejected
- x_target_not_found
- x_transient_error
- x_user_lookup_failed
- x_write_ambiguous
- x_write_failed
message:
type: string
description: Human-readable error guidance.
reason:
type: string
description: Machine-readable reason for a login cooldown.
retryAfter:
type: integer
minimum: 1
description: Seconds until the next permitted request.
retryAfterMs:
type: integer
minimum: 1
description: Required wait in milliseconds.
EventTypeArray:
description: Array of event types to subscribe to.
type: array
items:
$ref: '#/components/schemas/EventType'
minItems: 1
Delivery:
description: Webhook delivery attempt record with status and retry count.
type: object
required:
- id
- streamEventId
- status
- attempts
- createdAt
properties:
id:
type: string
streamEventId:
type: string
status:
type: string
attempts:
type: integer
createdAt:
type: string
format: date-time
deliveredAt:
type: string
format: date-time
lastStatusCode:
type: integer
lastError:
type: string
responses:
InvalidInput:
description: Invalid input
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
example:
error: invalid_input
message: Invalid input. Check the request body.
NotFound:
description: Not found
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
example:
error: not_found
message: Resource not found.
Success:
description: Success
content:
application/json:
schema:
type: object
required:
- success
properties:
success:
type: boolean
const: true
example: true
example:
success: true
Unauthenticated:
description: Unauthenticated
headers:
Cache-Control:
description: Prevents storage of authentication responses.
schema:
type: string
const: no-store
WWW-Authenticate:
description: Bearer authentication challenge.
schema:
type: string
const: Bearer realm="xquik"
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
example:
error: unauthenticated
message: Authentication required. Provide a valid API key or bearer token.
RateLimitExceeded:
description: 'Xquik tier rate limit exceeded. The response includes a `Retry-After` header with the number of seconds to wait before retrying.
'
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/Error'
- type: object
properties:
retryAfter:
type: integer
example: 60
example:
error: rate_limit_exceeded
message: Too many requests. Try again later.
retryAfter: 60
headers:
Retry-After:
description: Seconds until the next permitted request.
schema:
example: 60
minimum: 1
type: integer
UnexpectedError:
content:
application/json:
example:
error: internal_error
message: Unexpected error. Try again.
schema:
$ref: '#/components/schemas/Error'
description: Unexpected error.
securitySchemes:
apiKey:
type: apiKey
in: header
name: x-api-key
description: 'Xquik API key passed through the x-api-key header. Xquik-Api-Key is a vendor-prefixed alias. API keys beginning with xq_ can also use Authorization: Bearer.'
oauthBearer:
type: http
scheme: bearer
description: 'OAuth 2.1 access token passed through Authorization: Bearer. Values beginning with xq_ remain Xquik API-key credentials, not OAuth tokens.'
cookieSession:
type: apiKey
in: cookie
name: __Host-xquik_session
description: Secure Xquik browser session cookie.
x-service-info:
categories:
- data
docs:
homepage: https://xquik.com
apiReference: https://docs.xquik.com
llms: https://docs.xquik.com/llms.txt
x-discovery:
ownershipProofs:
- dns:xquik.com