InsightSocial
GET /v1/twitter/friendshipsbeta

Twitter/X Friendships API

Check whether one X account follows another, by handles or numeric user ids.

20 credits a call · single call · failed calls free · 10 free calls to start

curl "https://api.insightsocial.app/v1/twitter/friendships?source=<source>&target=<target>" \
-H "x-api-key: $INSIGHTSOCIAL_API_KEY"
200 OKJSON
{
"success": true,
"platform": "twitter",
"endpoint": "/v1/twitter/friendships",
"schema_version": "2",
"data": {
"<field>": "<value>"
},
"unavailable": [],
"credits_used": "<integer>"
}

Parameters

Query parameters for GET /v1/twitter/friendships. Send your key in the x-api-key header.

NameRequiredDescription
sourceYesSource account (the potential follower). Handle without the leading @, or numeric user id.
targetYesTarget account (the potential followee). Handle without the leading @, or numeric user id.
byNoTreat source and target as handles or numeric user ids. Defaults to id when a value is all digits.

Response

This endpoint is beta: data holds the platform's own fields under our naming rules (snake_case keys, string ids, ISO times where the platform gives a timestamp) rather than a unified post or profile, and those fields may change.

Every field, error and example is in the Twitter/X Friendships API reference.

How much does the Twitter/X Friendships API cost?

20 credits per successful call.

  • Failed calls are free

    A call that errors or finds nothing costs 0 credits.

  • Know the price first

    Add dry_run=1 and the response quotes the call without making it. Nothing is charged.

  • One balance

    API calls and Chrome extension exports share the same credits, on the free plan too.

Twitter/X Friendships API: frequently asked questions

Send GET /v1/twitter/friendships with the source and target parameters and your key in the x-api-key header. Check whether one X account follows another, by handles or numeric user ids.