Check follow relationship

GET

/twitter/user/check_follow_relationship

const url = 'https://api.relayxapi.com/twitter/user/check_follow_relationship?source_user_name=example&target_user_name=example';
const options = {
  method: 'GET',
  headers: { 'X-API-Key': '<api-key>' },
};

try {
  const res = await fetch(url, options);
  const data = await res.json();
  console.log(data);
} catch (err) {
  console.error(err);
}

Check the follow relationship between two accounts in both directions.

Parameters

Query Parameters

source_user_name

required

Source User Name

string

target_user_name

required

Target User Name

string

Header Parameters

x-api-key

X-Api-Key

string

Responses

200

Successful Response

Media typeapplication/json

Example

{
  "status": "success",
  "message": "",
  "data": {
    "following": false,
    "followed_by": false,
    "can_dm": false,
    "blocking": null,
    "muting": null
  }
}

422

Validation Error

Media typeapplication/json

HTTPValidationError

object

detail

Detail

Array<object>

ValidationError

object

loc

required

Location

Array

msg

required

Message

string

type

required

Error Type

string

Example^generated

{
  "detail": [
    {
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example"
    }
  ]
}