Skip to main content

Search Users

Immutable Catalog Entry

This descriptor comes from the active versioned Portal catalog.

READscrape-creators.scrape_creators_tiktok_get_v1_tiktok_search_users
  • Contract tier: legacy
  • Risk: read
  • Catalog version: scrape-creators-2026.07.12.1
  • Descriptor hash: 98ee850d5312661630edaba664cf989d17a09dc8dde43cbfa647afa1d0a23ce2

Use this when you need ScrapeCreators TikTok data from GET /v1/tiktok/search/users for Search Users. Searches for TikTok users by keyword or name — useful for finding creators or accounts matching a query. Returns users, an array of objects each containing user_info (nickname, unique_id, signature/bio, follower_count, following_count, avatar) and associated items. Paginate with cursor from the previous response. Returns the ScrapeCreators response in the standard MCP envelope with ok/data/error/meta. This is read-only. Requires the portal grant header and a ScrapeCreators BYOK API key.

Request Body​

{
  "jsonrpc": "2.0",
  "id": "scrape-creators-scrape-creators-tiktok-get-v1-tiktok-search-users-example",
  "method": "tools/call",
  "params": {
    "name": "scrape-creators.scrape_creators_tiktok_get_v1_tiktok_search_users",
    "arguments": {
      "body": "",
      "trim": "",
      "query": "",
      "cursor": "",
      "params": "",
      "compact": "",
      "max_items": "",
      "include_raw": false,
      "path_params": "",
      "search_query": ""
    }
  }
}

Arguments Schema​

{
  "type": "object",
  "properties": {
    "body": {
      "anyOf": [
        {
          "type": "object",
          "additionalProperties": true
        },
        {
          "type": "array",
          "items": {}
        },
        {
          "type": "null"
        }
      ],
      "title": "Body",
      "default": null,
      "description": "JSON request body for provider endpoints that accept one."
    },
    "trim": {
      "anyOf": [
        {
          "type": "boolean"
        },
        {
          "type": "null"
        }
      ],
      "title": "Trim",
      "default": null,
      "description": "Set to true to get a trimmed response"
    },
    "query": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Query",
      "default": null,
      "description": "Search query for users"
    },
    "cursor": {
      "anyOf": [
        {
          "type": "number"
        },
        {
          "type": "null"
        }
      ],
      "title": "Cursor",
      "default": null,
      "description": "Cursor to get more users. Get 'cursor' from previous response."
    },
    "params": {
      "anyOf": [
        {
          "type": "object",
          "additionalProperties": true
        },
        {
          "type": "null"
        }
      ],
      "title": "Params",
      "default": null,
      "description": "Optional advanced query parameter object. Prefer the documented top-level parameters when available."
    },
    "compact": {
      "anyOf": [
        {
          "type": "boolean"
        },
        {
          "type": "null"
        }
      ],
      "title": "Compact",
      "default": null,
      "description": "When true, trims large list payloads before returning them to the agent."
    },
    "max_items": {
      "anyOf": [
        {
          "type": "integer"
        },
        {
          "type": "null"
        }
      ],
      "title": "Max Items",
      "default": null,
      "description": "Maximum number of list items to return when compacting provider responses."
    },
    "include_raw": {
      "type": "boolean",
      "title": "Include Raw",
      "default": false,
      "description": "When true, returns both compact normalized data and the raw provider payload; this can be large."
    },
    "path_params": {
      "anyOf": [
        {
          "type": "object",
          "additionalProperties": true
        },
        {
          "type": "null"
        }
      ],
      "title": "Path Params",
      "default": null,
      "description": "Path template values for endpoints that expose path placeholders."
    },
    "search_query": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Search Query",
      "default": null,
      "description": "Alias for query: Search query for users"
    },
    "cache_ttl_seconds": {
      "anyOf": [
        {
          "type": "integer"
        },
        {
          "type": "null"
        }
      ],
      "title": "Cache Ttl Seconds",
      "default": null,
      "description": "Optional cache lifetime for idempotent GET requests."
    },
    "confirm_high_cost": {
      "type": "boolean",
      "title": "Confirm High Cost",
      "default": false,
      "description": "Set true only when intentionally running a high-credit or write-intent request."
    }
  },
  "additionalProperties": false
}

Output Schema​

{
  "type": "object",
  "required": [
    "ok",
    "data",
    "error",
    "meta"
  ],
  "properties": {
    "ok": {
      "type": "boolean",
      "description": "Whether the local or provider operation completed successfully."
    },
    "data": {
      "anyOf": [
        {
          "type": "object",
          "additionalProperties": true
        },
        {
          "type": "array",
          "items": {}
        },
        {
          "type": "string"
        },
        {
          "type": "number"
        },
        {
          "type": "boolean"
        },
        {
          "type": "null"
        }
      ],
      "description": "Bounded operation result when ok is true."
    },
    "meta": {
      "type": "object",
      "description": "Safe request, pagination, cache, and timing metadata.",
      "additionalProperties": true
    },
    "error": {
      "anyOf": [
        {
          "type": "object",
          "additionalProperties": true
        },
        {
          "type": "null"
        }
      ],
      "description": "Safe structured error when ok is false."
    }
  },
  "description": "Scrape Creators MCP normalized response envelope.",
  "additionalProperties": false
}

Code Examples​

curl -X POST 'https://portal.madpanda3d.com/api/mcp' \
  -H 'Authorization: Bearer mad_live_***' \
  -H 'Content-Type: application/json' \
  -d '{
  "jsonrpc": "2.0",
  "id": "scrape-creators-scrape-creators-tiktok-get-v1-tiktok-search-users-example",
  "method": "tools/call",
  "params": {
    "name": "scrape-creators.scrape_creators_tiktok_get_v1_tiktok_search_users",
    "arguments": {
      "body": "",
      "trim": "",
      "query": "",
      "cursor": "",
      "params": "",
      "compact": "",
      "max_items": "",
      "include_raw": false,
      "path_params": "",
      "search_query": ""
    }
  }
}'

Example Responses​

{
  "ok": true,
  "message": "Tool scrape-creators.scrape_creators_tiktok_get_v1_tiktok_search_users executed successfully.",
  "note": "Response shape varies by MCP tool. Inspect live responses for exact fields."
}