User Reads

Check Follow Relationship Batch

Check the directional relationship between one fixed account and up to 100 others in one request: one source against up to 100 targets, or one target against up to 100 sources. Each item carries the same relationship object GET /user/check_follow_relationship returns, read from the source's side: whether the source follows the target (following) and the target follows the source (followed_by), plus block, mute, and DM-eligibility flags. Results come back in request order, each with its relationship object or an error code. Cost: $0.0008 per billed item.

get/user/check_follow_relationship/batch

Request

  • Base URL: https://api.twitterapis.com/twitter
  • URL: https://api.twitterapis.com/twitter/user/check_follow_relationship/batch
  • Auth: HTTP bearer

Query parameters

source_user_idstring

Numeric ID of the single source account, when the list is targets. Used as sent, with no lookup; wins over source_username when both are sent.

Example:102812444
source_usernamestring

Handle of the single source account, when the list is targets. Resolved to its numeric ID first; an unknown handle returns a 404 and nothing is billed.

Example:stripe
target_usernamesstring

Comma-separated target handles, with or without the leading @, checked against the single source. Send this or target_user_ids, never both, and never together with a source list. Between 1 and 100 distinct entries after duplicates are removed (handles compare case-insensitively). A malformed handle returns a 400 for the whole request.

Example:nasa,openai
target_user_idsstring

Comma-separated numeric target IDs, as an alternative to target_usernames. Same 1 to 100 limit. Leading zeros are ignored for duplicates (012 and 12 are one account); results echo each ID as you sent it.

Example:11348282,4398626122
target_user_idstring

Numeric ID of the single target account, when the list is sources. Used as sent, with no lookup; wins over target_username when both are sent.

Example:102812444
target_usernamestring

Handle of the single target account, when the list is sources. Resolved to its numeric ID first; an unknown handle returns a 404 and nothing is billed.

Example:stripe
source_usernamesstring

Comma-separated source handles, with or without the leading @, each checked against the single target. Send this or source_user_ids, never both, and never together with a target list. Between 1 and 100 distinct entries after duplicates are removed (handles compare case-insensitively). A malformed handle returns a 400 for the whole request.

Example:nasa,openai
source_user_idsstring

Comma-separated numeric source IDs, as an alternative to source_usernames. Same 1 to 100 limit. Leading zeros are ignored for duplicates (012 and 12 are one account); results echo each ID as you sent it.

Example:11348282,4398626122
fieldsstring

Comma-separated list of dotted field paths to keep in the response (one parameter, never repeated), applied to every object in the returned lists and to nested objects (for example fields=id,text,author.username; the list's own name may prefix a path, fields=tweets.id). A path prefix that lands on an array applies to each element (media.media_url_https). Pagination and envelope keys (next_cursor, cursor, has_more, count, partial, error, message, reason) are always kept. Unknown paths are ignored; up to 50 paths of up to 6 segments. Projection never changes status codes or billing, and applies to data reads only: account, feedback, session status, monitor (other than deliveries), webhook and stream-compat reads return their bodies unchanged.

compact'1'

Set to 1 (or true) to apply the built-in compact preset: ids, url, text, created_at, lang, the engagement counts, the is_retweet/is_reply/is_quote flags, conversation ids, the author's id/username/name/followers_count/verification, and the quoted or retweeted tweet's id/url/author username. The preset trims what it recognises and leaves alone what it would empty, so it never turns a body into {}. Combine with fields to add paths on top of the preset. Typically cuts a tweet page by 70 to 90 percent for LLM tool callers.

Response

Check one account's follow relationship with up to 100 others in one request.

source_user_idstring

Numeric ID of the single source account. Present when the list is targets.

target_user_idstring

Numeric ID of the single target account. Present when the list is sources.

requestedinteger

Number of distinct accounts in the list, after duplicates were removed.

servedinteger

Number of items that returned a relationship object.

billed_itemsinteger

Number of pairs this call was billed for: every pair that came back with a relationship object (not_found is free). Multiply by $0.0008 for the charge.

Changes

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