Check Twitter follow relationship

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

GET/v1/twitter/friendships
1credit
x-api-keystringheader

API key (`sfk_...`)

Parameters
3
sourcestringrequiredquery

Source account (the potential follower). Handle without the leading @, or numeric user id.

targetstringrequiredquery

Target account (the potential followee). Handle without the leading @, or numeric user id.

bystringoptionalquery

Treat source and target as handles or numeric user ids. Defaults to id when a value is all digits.

one of: id, handle

Response fields
26

Endpoint-specific response payload.

datalookupStatus
string

Whether both accounts resolved and a relationship payload was returned.

one of: found, not_found

Source account when both parties resolved. `null` when `lookupStatus` is `not_found`.

datasourceid
string

Numeric X user id.

min 1 chars

datasourcehandle
string

Screen name without the leading @.

min 1 chars

Target account when both parties resolved. `null` when `lookupStatus` is `not_found`.

datatargetid
string

Numeric X user id.

min 1 chars

datatargethandle
string

Screen name without the leading @.

min 1 chars

datafollowing
booleannullable

Whether the source account follows the target. `null` when `lookupStatus` is `not_found`.

datafollowedBy
booleannullable

Whether the target account follows the source. `null` when `lookupStatus` is `not_found`.

datacanDm
booleannullable

Whether the source can send a direct message to the target. `null` when `lookupStatus` is `not_found`.

datablocking
booleannullable

Whether the source account has blocked the target. `null` when `lookupStatus` is `not_found`.

datablockedBy
booleannullable

Whether the source account is blocked by the target. `null` when `lookupStatus` is `not_found`.

datamuting
booleannullable

Whether the source account has muted the target. `null` when `lookupStatus` is `not_found`.

datanotificationsEnabled
booleannullable

Whether the source account has notifications enabled for the target. `null` when `lookupStatus` is `not_found`.

datafollowRequestSent
booleannullable

Whether the source has a pending follow request to the target. `null` when `lookupStatus` is `not_found`.

datafollowRequestReceived
booleannullable

Whether the source has a pending follow request from the target. `null` when `lookupStatus` is `not_found`.

datawantRetweets
booleannullable

Whether the source wants to see retweets from the target. `null` when `lookupStatus` is `not_found`.

datamarkedSpam
booleannullable

Whether the source has marked the target as spam. `null` when `lookupStatus` is `not_found`.

dataallReplies
booleannullable

Whether the source is set to see all replies from the target. `null` when `lookupStatus` is `not_found`.

datacanMediaTag
booleannullable

Whether the source can tag the target in photos or videos. `null` when `lookupStatus` is `not_found`.

Metadata describing the request and billing outcome.

metarequestId
string

Unique request identifier for tracing this API call.

min 1 chars

metacreditsCharged
integer

Credits charged for this request.

≥ 0

metaversion
string

Public API version that served the response.

one of: v1

metacached
booleanoptional

True when served from shared response cache. Credits still apply (full endpoint price); Age header may be present.

Code example

curl "https://api.socialfetch.dev/v1/twitter/friendships?source=nasa&target=elonmusk" \
  -H "x-api-key: YOUR_API_KEY"

Responses

Follow relationship.