Skip to content
ProspectAPIs

API reference / People reads

Search posts (live)

Written and maintained by The ProspectAPIs team

POST/v1/posts/search

POST /v1/posts/search is the ProspectAPIs operation searchPosts, in the People reads group of the REST API. Search public posts by keywords, read fresh, optionally inside a date window (date_posted: past-24h, past-week or past-month) and sorted by relevance or recent. Each result is a post with its id, share_id, text, created_at, author, media summary and counts (null when the result does not carry them, never zero). Returns the first 1,000 results per query; page with start. $0.012 per live read. Billed per call once the reads are live; while they are not yet on sale the call is free (GET /pricing reports people_reads.available). Cost: Not available yet. Send your API key as a Bearer token in the Authorization header.

The quickstart shows this call in context, next to the first requests most integrations make.

Parameters

Parameters of POST /v1/posts/search
NameInTypeDescription
Idempotency-KeyheaderstringOptional, 1 to 255 printable ASCII characters. A retry with the same key and body within 24 hours gets the first answer back with Idempotent-Replayed: true and is never charged again. The same key with a different body is 422; a retry while the first call is still running is 409.

Request body

JSON.

Request body of POST /v1/posts/search
FieldTypeDescription
keywords requiredstringFree-text keywords. At most 500 characters.
date_postedstring: past-24h, past-week, past-monthOnly posts from this window.
sortstring: relevance, recentOrder of results. Default relevance.
startintegerZero-based offset into the first 1,000 results. 0 to 999.
countintegerResults per page. 1 to 50.
Example body
{
  "keywords": "keywords"
}

Responses

Response codes of POST /v1/posts/search
StatusMeaning
200The matching posts and the page envelope, read fresh.
400The request was invalid (e.g. a bad filter or input); nothing was charged.
401The API key is missing or invalid.
402Out of credits. The body carries top_up_url; nothing was charged.
429Too many requests; retry after the window.
503This read is temporarily unavailable. Nothing was charged.

Every error answers with the same JSON body, an error string and sometimes a code; the errors page lists each status and when it happens. A per-key 429 carries Retry-After; see rate limits.

200 response fields

The matching posts and the page envelope, read fresh. The body is a PeopleReadResult.

Fields of the 200 response
FieldTypeDescription
data requiredobjectThe read result. For search, posts, engagers and followers this is { items, page }; for a profile it is the profile object.
coverage requiredobjectHow complete the source was.
coverage.filledinteger
coverage.ofinteger
Response headers
HeaderMeaning
RateLimit-LimitRequests this API key may make per minute.
RateLimit-RemainingRequests left in the current one-minute window.
RateLimit-ResetSeconds until the current window resets.

Code samples

Each sample sends the same request. Set PROSPECTAPIS_KEY in your environment first. Values come from the spec's examples; replace them with your own.

curl
curl -X POST https://api.prospectapis.com/v1/posts/search \
  -H "Authorization: Bearer $PROSPECTAPIS_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "keywords": "keywords" }'
JavaScript (fetch)
const res = await fetch("https://api.prospectapis.com/v1/posts/search", {
  method: "POST",
  headers: { Authorization: `Bearer ${process.env.PROSPECTAPIS_KEY}`, "Content-Type": "application/json" },
  body: JSON.stringify({
    "keywords": "keywords"
  }),
});
if (!res.ok) throw new Error(`${res.status}: ${(await res.json().catch(() => ({}))).error ?? res.statusText}`);
const data = await res.json();
console.log(data);
Python (requests)
import os, requests

res = requests.post(
    "https://api.prospectapis.com/v1/posts/search",
    headers={"Authorization": f"Bearer {os.environ['PROSPECTAPIS_KEY']}"},
    json={
        "keywords": "keywords",
    },
    timeout=30,
)
res.raise_for_status()
data = res.json()
print(data)

Billing

Billing reserves before it serves: the call holds what it may cost, serves at most what that hold covers, and refunds the rest when the response closes. Any non-2xx answer refunds the whole hold, so a failed call costs nothing. The response reports your balance in X-Credits-Remaining.

Previous operation: Search company pages (live). Next operation: List a page's employees (live). Every operation, grouped by area, is on the API reference index.

Create a free account to get a key, then run the samples above with your own values (this call acts for real, so use real inputs).

Was this page helpful?