Get an API key; the examples use
api.socialscrape.dev.Before you start
- An API key, sent in the
x-api-keyheader. Keep it on your server. - For this endpoint you send
query. The X post search page lists every parameter.
Step 1: Send the request
GET /v1/twitter/search/posts. Pick your language; each one reads the key from SOCIALSCRAPE_API_KEY.
1curl -G "https://api.socialscrape.dev/v1/twitter/search/posts" \2 -H "x-api-key: $SOCIALSCRAPE_API_KEY" \3 --data-urlencode 'query=ai agents'1import os2import requests34params = {5 "query": "ai agents",6}7res = requests.get(8 "https://api.socialscrape.dev/v1/twitter/search/posts",9 headers={"x-api-key": os.environ["SOCIALSCRAPE_API_KEY"]},10 params=params,11 timeout=60,12)13body = res.json()1415if body["ok"]:16 print(body["data"])17else:18 print(body["error"]["code"], body["error"]["message"])1const url = new URL("https://api.socialscrape.dev/v1/twitter/search/posts");2url.search = new URLSearchParams({3 query: "ai agents",4}).toString();5const res = await fetch(url, {6 headers: { "x-api-key": process.env.SOCIALSCRAPE_API_KEY },7});8const body = await res.json();910if (body.ok) {11 console.log(body.data);12} else {13 console.error(body.error.code, body.error.message);14}1const url = new URL("https://api.socialscrape.dev/v1/twitter/search/posts");2url.search = new URLSearchParams({3 query: "ai agents",4}).toString();5const res = await fetch(url, {6 headers: { "x-api-key": process.env.SOCIALSCRAPE_API_KEY! },7});8const body = await res.json();910if (body.ok) {11 console.log(body.data);12} else {13 console.error(body.error.code, body.error.message);14}1package main23import (4 "fmt"5 "io"6 "net/http"7 "net/url"8 "os"9)1011func main() {12 q := url.Values{}13 q.Set("query", "ai agents")14 req, _ := http.NewRequest("GET", "https://api.socialscrape.dev/v1/twitter/search/posts" + "?" + q.Encode(), nil)15 req.Header.Set("x-api-key", os.Getenv("SOCIALSCRAPE_API_KEY"))16 res, err := http.DefaultClient.Do(req)17 if err != nil {18 panic(err)19 }20 defer res.Body.Close()21 body, _ := io.ReadAll(res.Body)22 fmt.Println(res.StatusCode, string(body))23}1<?php2$query = http_build_query([3 'query' => 'ai agents',4]);5$ch = curl_init('https://api.socialscrape.dev/v1/twitter/search/posts' . "?" . $query);6curl_setopt_array($ch, [7 CURLOPT_RETURNTRANSFER => true,8 CURLOPT_HTTPHEADER => ["x-api-key: " . getenv("SOCIALSCRAPE_API_KEY")],9]);10$body = json_decode(curl_exec($ch), true);11curl_close($ch);1213if ($body["ok"]) {14 print_r($body["data"]);15} else {16 echo $body["error"]["code"], " ", $body["error"]["message"], "\n";17}1require "net/http"2require "json"34uri = URI('https://api.socialscrape.dev/v1/twitter/search/posts')5uri.query = URI.encode_www_form('query' => 'ai agents')6req = Net::HTTP::Get.new(uri)7req["x-api-key"] = ENV.fetch("SOCIALSCRAPE_API_KEY")8res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(req) }9body = JSON.parse(res.body)1011if body["ok"]12 puts body["data"]13else14 puts body["error"]["code"], body["error"]["message"]15end1import java.net.URI;2import java.net.URLEncoder;3import java.net.http.HttpClient;4import java.net.http.HttpRequest;5import java.net.http.HttpResponse;6import java.nio.charset.StandardCharsets;78public class Main {9 public static void main(String[] args) throws Exception {10 String query = "query=" + URLEncoder.encode("ai agents", StandardCharsets.UTF_8);11 HttpRequest req = HttpRequest.newBuilder()12 .uri(URI.create("https://api.socialscrape.dev/v1/twitter/search/posts" + "?" + query))13 .header("x-api-key", System.getenv("SOCIALSCRAPE_API_KEY"))14 .GET()15 .build();16 HttpResponse<String> res = HttpClient.newHttpClient().send(req, HttpResponse.BodyHandlers.ofString());17 System.out.println(res.statusCode() + " " + res.body());18 }19}1using System;2using System.Net.Http;34var client = new HttpClient();5client.DefaultRequestHeaders.Add("x-api-key", Environment.GetEnvironmentVariable("SOCIALSCRAPE_API_KEY"));6var query = string.Join("&", new[] {7 "query=" + Uri.EscapeDataString("ai agents"),8});9var res = await client.GetAsync("https://api.socialscrape.dev/v1/twitter/search/posts" + "?" + query);10Console.WriteLine((int)res.StatusCode);11Console.WriteLine(await res.Content.ReadAsStringAsync());Step 2: Read the response
Results are in data.items. Here is what one item gives you, from a recorded sample.
1for item in body["data"]["items"]:2 print(item["text"])3 print(item["id"])4 print(item["stats"]["likes"])1for (const item of body.data.items) {2 console.log(item.text);3 console.log(item.id);4 console.log(item.stats.likes);5}SampleFields printed above
1{2 "text": "BREAKING: New updates to AI Agents on Public\n\n→ We’ve launched the first-ever marketplace of AI Agents for your portfolio.\n→ Deploy them immediately or custo...",3 "id": "2089382171291070550",4 "stats": {5 "likes": 2716 }7}A field the platform does not give comes back as null. The full field list is on the endpoint page.
Step 3: Get the next page
Send the same request with the cursor you got back, until has_more is false. Each page costs its own price.
1import os2import requests34url = "https://api.socialscrape.dev/v1/twitter/search/posts"5headers = {"x-api-key": os.environ["SOCIALSCRAPE_API_KEY"]}6params = {"query": "ai agents"}78items = []9while len(items) < 100:10 body = requests.get(url, headers=headers, params=params, timeout=60).json()11 if not body["ok"]:12 raise RuntimeError(body["error"]["code"])13 items += body["data"]["items"]14 if not body["has_more"]:15 break16 params["cursor"] = body["cursor"]1718print(len(items), "items")1const url = new URL("https://api.socialscrape.dev/v1/twitter/search/posts");2url.searchParams.set("query", "ai agents");3const headers = { "x-api-key": process.env.SOCIALSCRAPE_API_KEY };45const items = [];6while (items.length < 100) {7 const body = await (await fetch(url, { headers })).json();8 if (!body.ok) throw new Error(body.error.code);9 items.push(...body.data.items);10 if (!body.has_more) break;11 url.searchParams.set("cursor", body.cursor);12}1314console.log(items.length, "items");Step 4: Handle errors
Check ok, then branch on error.code and error.retryable, never on the message.
1body = res.json()2if not body["ok"]:3 err = body["error"]4 if err["retryable"]:5 ... # wait a moment and send the same request again6 else:7 raise RuntimeError(f'{err["code"]}: {err["message"]}')1const body = await res.json();2if (!body.ok) {3 const { code, message, retryable } = body.error;4 if (retryable) {5 // wait a moment and send the same request again6 } else {7 throw new Error(`${code}: ${message}`);8 }9}| Code | HTTP | Retry | Meaning |
|---|---|---|---|
invalid_params | 400 | no | A parameter is missing, unknown or has the wrong type. |
not_found | 404 | no | The platform says this profile, post or item does not exist. |
upstream_blocked | 503 | yes | The platform blocked this fetch; retry (a fresh exit is used). |
Other errors, such as unauthorized or rate_limited, are on the errors page.
With the SDK
The Python and TypeScript clients wrap all of this: typed errors, retries, and cursor paging. Install them with pip install socialscrape-sdk or npm install socialscrape.
1from socialscrape import SocialScrape23client = SocialScrape() # reads SOCIALSCRAPE_API_KEY45for item in client.paginate(client.twitter.search_posts, query="ai agents", max_items=100):6 print(item["text"])1import { SocialScrape } from "socialscrape";23const client = new SocialScrape(); // reads SOCIALSCRAPE_API_KEY45for await (const item of client.paginate(client.twitter.searchPosts, { query: "ai agents" }, { maxItems: 100 })) {6 console.log(item.text);7}What it costs
1 credit. A failed request costs nothing. Add max_age_days to reuse a cached result for 0 credits. Results are kept 30 days.
Next
- X post search API: sample response and every parameter.
- All X (Twitter) endpoints.