REST (cURL)
curl -X POST https://api.dataxapi.com/v1/x/users/search \
-H "Authorization: Bearer $DATAXAPI_API_KEY" \
-H "Idempotency-Key: your-stable-intent-key" \
-H "Content-Type: application/json" \
-d '{"query":"OpenAI"}'X (Twitter / 推特)
x.users.search@v1
X user search
UserSearch
Search one cursor-paginated page of public X users and return concise public profiles.
POST
/v1/x/users/searchChinese name: X 用户搜索 · 用户 · 搜索
按关键词分页搜索当前公开 X 用户，并返回精简公开资料。
Use it when
- Use it to discover public X users from a name, username fragment, or profile keyword.
Do not use it for
- Do not use it for identity verification, sensitive profiling, private data, email, or DM capability.
Request parameters
FieldTypeConstraints and defaultsRequirement
FieldqueryTypestringConstraints and defaultsminLength: 1 · maxLength: 128RequirementRequiredFieldcursorTypestringConstraints and defaultsminLength: 1RequirementOptionalFull request JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"query": {
"type": "string",
"minLength": 1,
"maxLength": 128
},
"cursor": {
"type": "string",
"minLength": 1
}
},
"required": [
"query"
],
"additionalProperties": false
}Static response example
application/json
{
"code": 200,
"request_id": "req_example_x_users_search",
"message": "success",
"data": {
"items": [
{
"id": "4398626122",
"username": "OpenAI",
"name": "OpenAI",
"description": "Public fixture profile",
"location": "San Francisco, CA",
"avatar_url": "https://pbs.twimg.com/profile_images/fixture.jpg",
"header_url": "https://pbs.twimg.com/profile_banners/fixture",
"created_at": "Thu Dec 03 18:33:20 +0000 2015",
"verified": true,
"verified_type": "Business",
"followers_count": 4200000,
"following_count": 4,
"posts_count": 1900,
"media_count": 300
}
]
},
"page": {
"next_cursor": "opaque_cursor_example"
},
"warnings": [],
"meta": {
"listing_id": "x.users.search",
"version": "v1",
"catalog_release_id": "catalog-production-2026-09-17.1",
"price_book_version": "pricebook-production-2026-09-17.1",
"result_status": "complete",
"charged_amount": "0.06",
"balance_after": "0.94",
"currency": "CNY"
}
}Run live
Complete and empty results are charged; partial results and failures are not.
Security check
Loading the security check…
Checking live execution status…
Execution result
// Result
Response contract
The field summary is for scanning; the full JSON Schema is the stable output contract.
FieldTypeConstraints and defaultsRequirement
FieldcodeTypenumberConstraints and defaultsconst: 200RequirementRequiredFieldrequest_idTypestringConstraints and defaultsNo additional constraintsRequirementRequiredFieldmessageTypestringConstraints and defaultsconst: "success"RequirementRequiredFielddataTypeobjectConstraints and defaultsNo additional constraintsRequirementRequiredFieldpageTypeobjectConstraints and defaultsNo additional constraintsRequirementRequiredFieldwarningsTypearrayConstraints and defaultsNo additional constraintsRequirementRequiredFieldmetaTypeobjectConstraints and defaultsNo additional constraintsRequirementRequiredFull response JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"code": {
"type": "number",
"const": 200
},
"request_id": {
"type": "string"
},
"message": {
"type": "string",
"const": "success"
},
"data": {
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"username": {
"type": "string"
},
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"description": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"location": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"avatar_url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"header_url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"created_at": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"verified": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
},
"verified_type": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"followers_count": {
"anyOf": [
{
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
{
"type": "null"
}
]
},
"following_count": {
"anyOf": [
{
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
{
"type": "null"
}
]
},
"posts_count": {
"anyOf": [
{
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
{
"type": "null"
}
]
},
"media_count": {
"anyOf": [
{
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
{
"type": "null"
}
]
}
},
"required": [
"id",
"username",
"name",
"description",
"location",
"avatar_url",
"header_url",
"created_at",
"verified",
"verified_type",
"followers_count",
"following_count",
"posts_count",
"media_count"
],
"additionalProperties": false
}
}
},
"required": [
"items"
],
"additionalProperties": false
},
"page": {
"type": "object",
"properties": {
"next_cursor": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"required": [
"next_cursor"
],
"additionalProperties": false
},
"warnings": {
"type": "array",
"items": {
"type": "string"
}
},
"meta": {
"type": "object",
"properties": {
"listing_id": {
"type": "string",
"const": "x.users.search"
},
"version": {
"type": "string",
"const": "v1"
},
"catalog_release_id": {
"type": "string",
"minLength": 1
},
"price_book_version": {
"type": "string",
"minLength": 1
},
"result_status": {
"type": "string",
"enum": [
"complete",
"empty",
"partial"
]
},
"charged_amount": {
"type": "string"
},
"balance_after": {
"type": "string"
},
"currency": {
"type": "string",
"const": "CNY"
}
},
"required": [
"listing_id",
"version",
"catalog_release_id",
"price_book_version",
"result_status",
"charged_amount",
"balance_after",
"currency"
],
"additionalProperties": false
}
},
"required": [
"code",
"request_id",
"message",
"data",
"page",
"warnings",
"meta"
],
"additionalProperties": false
}Known limitations
- Ordering, coverage, and page size follow current X user search and do not represent platform-wide user volume.
- V1 returns only allowlisted public fields; upstream email, canDm, and internal fields are always dropped.
Integration example
Exact MCP Preview (Codex config)
[mcp_servers.dataxapi] url = "https://api.dataxapi.com/mcp" bearer_token_env_var = "DATAXAPI_API_KEY"
The same API key exposes only the precise tools in its scope. Keep the key in an environment variable, never in the config file. Reuse an explicit idempotency_key for safe retries.