Search Users

Search for users by username, display name, or keywords in their bio. Returns matching user profiles with comprehensive data. Useful for finding accounts related to specific topics or interests.

GET /v1/twitter/users/search_users

Search users

cURL

curl --request GET \
  --url https://scrapebadger.com/v1/twitter/users/search_users \
  --header 'x-api-key: <api-key>'

import requests

url = "https://scrapebadger.com/v1/twitter/users/search_users"

headers = {"x-api-key": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};

fetch('https://scrapebadger.com/v1/twitter/users/search_users', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://scrapebadger.com/v1/twitter/users/search_users",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "x-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://scrapebadger.com/v1/twitter/users/search_users"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-api-key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://scrapebadger.com/v1/twitter/users/search_users")
  .header("x-api-key", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://scrapebadger.com/v1/twitter/users/search_users")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'

response = http.request(request)
puts response.read_body

200

{
  "data": [
    {
      "id": "44196397",
      "username": "elonmusk",
      "name": "Elon Musk",
      "created_at": "Tue Jun 02 20:12:29 +0000 2009",
      "description": "Mars & Cars, Chips & Dips",
      "location": "Mars",
      "url": "<string>",
      "profile_image_url": "<string>",
      "profile_banner_url": "<string>",
      "followers_count": 0,
      "following_count": 0,
      "tweet_count": 0,
      "listed_count": 0,
      "favourites_count": 123,
      "media_count": 123,
      "verified": false,
      "verified_type": "<string>",
      "is_blue_verified": true,
      "created_at_datetime": "<string>",
      "protected": true,
      "possibly_sensitive": true,
      "followed_by": true,
      "following": true,
      "can_dm": true,
      "professional_type": "<string>",
      "pinned_tweet_ids": [
        "<string>"
      ]
    }
  ],
  "next_cursor": "<string>"
}

{
  "error": "Invalid or missing API key"
}

{
  "error": "Insufficient credits"
}

{
  "error": "Rate limit exceeded. Please retry after a short delay."
}

Authorizations

x-api-key · string · header · required

Your ScrapeBadger API key. You can find this in your dashboard at https://scrapebadger.com/dashboard/api-keys.

Query Parameters

query · string · required

Search query to match against usernames, display names, and bios.

Example:

"machine learning"

cursor · string

Pagination cursor for fetching the next page of results.

Response

200

application/json

Successfully retrieved search results.

Paginated list of users.

data · object[] | null

Array of user objects.

Show child attributes

next_cursor · string | null

Cursor for fetching the next page. Null if no more results.