Interface: UserApi

Reads about any user.

Methods

info()

info(pk): Promise<{
[key: string]: unknown;
  biography?: string;
  external_url?: string | null;
  follower_count?: number | null;
  following_count?: number | null;
  full_name?: string;
  is_private?: boolean;
  is_verified?: boolean;
  media_count?: number | null;
  pk?: string;
  profile_pic_url?: string | null;
  username?: string;
}>;

A user's profile by id.

Parameters

Parameter	Type
pk	string

Returns

Promise<{ [key: string]: unknown; biography?: string; external_url?: string | null; follower_count?: number | null; following_count?: number | null; full_name?: string; is_private?: boolean; is_verified?: boolean; media_count?: number | null; pk?: string; profile_pic_url?: string | null; username?: string; }>

---

infoByUsername()

infoByUsername(username): Promise<{
[key: string]: unknown;
  biography?: string;
  external_url?: string | null;
  follower_count?: number | null;
  following_count?: number | null;
  full_name?: string;
  is_private?: boolean;
  is_verified?: boolean;
  media_count?: number | null;
  pk?: string;
  profile_pic_url?: string | null;
  username?: string;
}>;

A user's profile by username.

Parameters

Parameter	Type
username	string

Returns

Promise<{ [key: string]: unknown; biography?: string; external_url?: string | null; follower_count?: number | null; following_count?: number | null; full_name?: string; is_private?: boolean; is_verified?: boolean; media_count?: number | null; pk?: string; profile_pic_url?: string | null; username?: string; }>