API reference / People reads

Read one post (live)

Written and maintained by The ProspectAPIs team

GET/v1/posts/detail

GET /v1/posts/detail is the ProspectAPIs operation getPostDetail, in the People reads group of the REST API. Read one public post in full, fetched fresh at request time: its author, text, created_at, a media summary (media.kind, media.count, media.title) and its counts (counts.reactions, counts.reactions_by_type for like, celebrate, support, love, insightful, funny and other, counts.comments, counts.reshares). $0.012 per live read. Give one of post_id, share_id or post_url; id and share_id in the answer are the references the engagers and resharers reads take. A post that cannot be found is a free 404. 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

An unknown query parameter is refused with a 400 rather than ignored, so a typo never widens a search you pay for.

Responses

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 post, read fresh. The body is a PeopleReadResult.

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 https://api.prospectapis.com/v1/posts/detail \
  -H "Authorization: Bearer $PROSPECTAPIS_KEY"

const res = await fetch("https://api.prospectapis.com/v1/posts/detail", {
  headers: { Authorization: `Bearer ${process.env.PROSPECTAPIS_KEY}` },
});
if (!res.ok) throw new Error(`${res.status}: ${(await res.json().catch(() => ({}))).error ?? res.statusText}`);
const data = await res.json();
console.log(data);

import os, requests

res = requests.get(
    "https://api.prospectapis.com/v1/posts/detail",
    headers={"Authorization": f"Bearer {os.environ['PROSPECTAPIS_KEY']}"},
    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.

Related

Previous operation: Read a company page (live). Next operation: Search company pages (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.