Users

Relationship between two accounts

Whether one account follows another, and the other way round.

Reference: https://www.twittrapi.com/docs/reference/user-friendships-show

get/user/friendships/show

Request

  • Base URL: https://api.twittrapi.com
  • URL: https://api.twittrapi.com/user/friendships/show
  • Auth: API key in header X-API-KEY

Query parameters

source_screen_namestring required

First handle, with or without @.

target_screen_namestring required

Second handle, with or without @.

format'raw' | 'simple'

raw (default): X's JSON passed through. simple: flat camelCase JSON with a fixed schema and a {data, nextCursor, previousCursor, hasNextPage} envelope. Same price. The header X-Response-Format: simple does the same.

Response

Raw JSON of X's v1.1 friendships/show endpoint: relationship.source and relationship.target with following and followed_by.

With format=simple: {data: {source: {id, username}, target: {id, username}, following, followedBy, blocking, blockedBy, muting}}. following: source follows target.

OR
RawPassthrough required

X's own JSON (raw format, the default), passed through unchanged. The shape is X's and can change; see https://www.twittrapi.com/docs/response-format.

Changes

No recorded changes to this operation across all 1 revision of this API.