xiaohongshu.users.search@v1

Xiaohongshu user search

UserSearch

Read one page of public Xiaohongshu users by keyword.

POST/v1/xiaohongshu/users/search

Chinese name: 小红书用户搜索 · 用户 · 搜索
按关键词读取一页公开小红书用户。

Use it when

Use it to discover public Xiaohongshu users by keyword.

Do not use it for

Do not use it for exhaustive discovery, sensitive profiling, or identity inference.

Request parameters

FieldTypeConstraints and defaultsRequirement

FieldkeywordstringminLength: 1 · maxLength: 128Required

FieldcursorstringminLength: 1Optional

Full request JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "keyword": {
      "type": "string",
      "minLength": 1,
      "maxLength": 128
    },
    "cursor": {
      "type": "string",
      "minLength": 1
    }
  },
  "required": [
    "keyword"
  ],
  "additionalProperties": false
}

Static response example

application/json

{
  "code": 200,
  "request_id": "req_example_xhs_users_search_01",
  "message": "success",
  "data": {
    "items": [
      {
        "id": "user-01",
        "nickname": "Example user",
        "red_id": "example-red-id",
        "avatar_url": "https://ci.xiaohongshu.com/avatar",
        "bio": "Public profile",
        "followers": 1200,
        "following": 20,
        "note_count": 42
      }
    ]
  },
  "page": {
    "next_cursor": null
  },
  "warnings": [],
  "meta": {
    "result_status": "complete",
    "balance_after": "0.81",
    "listing_id": "xiaohongshu.users.search",
    "version": "v1",
    "catalog_release_id": "catalog-production-2026-09-17.1",
    "price_book_version": "pricebook-production-2026-09-17.1",
    "charged_amount": "0.19",
    "currency": "CNY"
  }
}

Run live

Complete and empty results are charged; partial results and failures are not.

Request JSON body

Security check

Loading the security check…

6-digit code

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

Fieldcodenumberconst: 200Required

Fieldrequest_idstringNo additional constraintsRequired

Fieldmessagestringconst: "success"Required

FielddataobjectNo additional constraintsRequired

FieldpageobjectNo additional constraintsRequired

FieldwarningsarrayNo additional constraintsRequired

FieldmetaobjectNo additional constraintsRequired

Full 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",
                "minLength": 1
              },
              "nickname": {
                "anyOf": [
                  {
                    "type": "string"
                  },
                  {
                    "type": "null"
                  }
                ]
              },
              "red_id": {
                "anyOf": [
                  {
                    "type": "string"
                  },
                  {
                    "type": "null"
                  }
                ]
              },
              "avatar_url": {
                "anyOf": [
                  {
                    "type": "string"
                  },
                  {
                    "type": "null"
                  }
                ]
              },
              "bio": {
                "anyOf": [
                  {
                    "type": "string"
                  },
                  {
                    "type": "null"
                  }
                ]
              },
              "followers": {
                "anyOf": [
                  {
                    "type": "integer",
                    "minimum": 0,
                    "maximum": 9007199254740991
                  },
                  {
                    "type": "null"
                  }
                ]
              },
              "following": {
                "anyOf": [
                  {
                    "type": "integer",
                    "minimum": 0,
                    "maximum": 9007199254740991
                  },
                  {
                    "type": "null"
                  }
                ]
              },
              "note_count": {
                "anyOf": [
                  {
                    "type": "integer",
                    "minimum": 0,
                    "maximum": 9007199254740991
                  },
                  {
                    "type": "null"
                  }
                ]
              }
            },
            "required": [
              "id",
              "nickname",
              "red_id",
              "avatar_url",
              "bio",
              "followers",
              "following",
              "note_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": "xiaohongshu.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

Pagination continues only when the upstream response explicitly supplies next_page and a search session ID; result count is never used to infer continuation.
Limited V1 does not guarantee exhaustive recall or stable ordering.

Integration example

REST (cURL)

curl -X POST https://api.dataxapi.com/v1/xiaohongshu/users/search \
  -H "Authorization: Bearer $DATAXAPI_API_KEY" \
  -H "Idempotency-Key: your-stable-intent-key" \
  -H "Content-Type: application/json" \
  -d '{"keyword":"AI"}'

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.

View client compatibility →

Catalog release: catalog-production-2026-09-17.1 · PriceBook: pricebook-production-2026-09-17.1