Social platforms

Check whether one X user follows another · Twitter / X API

GET/x/friendships/show
$min $0.001

Return the directional follow relationship between two X accounts — whether the source follows the target and vice versa — identified by user IDs or screen names. Useful for verifying connections and detecting one-way follows.

Using ChatGPT, Claude Code or another client? See the setup steps

Request
curl https://api.unifapi.com/x/friendships/show \
  -H "Authorization: Bearer $UNIFAPI_KEY"

Parameters

source_idquery
target_idquery
source_screen_namequery
target_screen_namequery
Overview

This operation is part of the Twitter / X API in the social platforms category. It uses the same Bearer token, request tracing, error model, and billing envelope as every UnifAPI endpoint, so agents can switch between platforms without custom per-vendor glue code.

Use it when a workflow needs Twitter / X public data alongside other social networks, but should still keep one API key, one account balance, and one predictable JSON contract.

Common agent workflows

  • Resolve a public Twitter / X identity into structured profile metadata for enrichment agents.
  • Refresh creator, company, or account snapshots without managing source-specific response shapes.
  • Give an AI agent a stable Twitter / X data source without building a per-platform integration.
  • Normalize Twitter / X responses into the same UnifAPI envelope used across the catalog.
Response shape

Unified envelope, platform-native fields

  • Lookup responses return one canonical object in `data` with stable identifiers, source URLs where available, and platform-specific metadata normalized into predictable JSON.
  • The `billing.records_charged` field reports the charged billable-record quantity for the successful response.
  • A not-found or invalid-input condition uses the unified UnifAPI error shape, so callers do not need special handling for each source platform.

Response status codes

200400401402404429500502503

Billing

This operation charges 1 credit per billable record, with a 1 credit ($0.001) operation minimum. Public responses include billing metadata with credits charged, records charged, and remaining workspace balance. Incorrect Credit deductions caused by platform failures can be restored as billing corrections.

Errors and retries

Authentication, validation, rate-limit, not-found, and provider errors use the unified UnifAPI error format. Agents should log `request_id`, retry only retryable failures, and treat invalid API keys, disabled keys, and expired keys as the same public `unauthorized` error type.

Response fields

Fields in the data object

A successful Check whether one X user follows another call returns one data object with these fields.

source_idstring
source_usernamestring
target_idstring
target_usernamestring
followingboolean
followed_byboolean
rawany
Related endpoints

More Twitter / X operations

Combine endpoints from the same platform, then join the results with other UnifAPI categories without changing authentication or response parsing.

GET/x/communities/search

Search X Communities

Search X Communities by query string and return a cursor-paginated set of matching Communities with their metadata. Useful for discovering active topic-based groups to monitor or analyze.

GET/x/lists/{id}/followers

Get followers/subscribers of an X List

Return the accounts that subscribe to (follow) an X List, as a cursor-paginated list of full profiles. Useful for sizing and analyzing the audience that tracks a curated List.

GET/x/autocomplete

Autocomplete X users, topics, hashtags, and cashtags

Return X search autocomplete suggestions for a partial query, grouped into matching users, topics, hashtags, and cashtags. Useful for type-ahead search, entity discovery, and expanding a seed term into related handles and tags.

GET/x/users

Get X users by IDs

Batch-resolve up to 100 X accounts in one call from a comma-separated list of numeric user IDs, returning the same profile fields as the single-user lookup. Useful for hydrating profiles behind a list of IDs without one request per account.

GET/x/users/{id}

Get X user by ID

Resolve a single X (Twitter) account by its numeric user ID and return the full public profile — handle, display name, bio, follower and following counts, verification status, and profile media. Useful when you already hold a stable user ID and need the current profile.

GET/x/users/{id}/followers

Get an X user's followers

Return a cursor-paginated followers list for a given X (Twitter) user — every account that follows them, with a full profile object per follower. Useful for audience analysis and mapping who follows a brand, creator, or competitor.