List followers of a user

GET

/2/profile/{handle}/followers

const url = 'https://api.fxtwitter.com/2/profile/example/followers?count=20';
const options = {method: 'GET'};

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

curl --request GET \
  --url 'https://api.fxtwitter.com/2/profile/example/followers?count=20'

Parameters

Path Parameters

handle

required

string

Username without @, or numeric user id as id:<rest_id> (e.g. id:783214). Case-insensitive id: prefix.

Query Parameters

count

integer

default: 20 >= 1 <= 100

Page size (default 20)

cursor

string

Pagination cursor from prior response

Responses

200

Followers page

application/json

object

code

required

number

results

required

Array<object>

object

type

required

Discriminator: full user profile (API v2).

string

Allowed values: profile

required

string

name

required

string

screen_name

required

string

avatar_url

required

string

nullable

banner_url

required

string

nullable

description

required

string

raw_description

required

object

text

required

string

facets

required

Array<object>

object

type

required

Facet kind: e.g. url, mention, hashtag, bold, media, custom_emoji (Mastodon custom emoji image)

string

indices

required

Start and end UTF-16 indices

Array<number>

>= 2 items <= 2 items

original

string

replacement

string

display

string

location

required

string

url

required

string

protected

required

boolean

followers

required

number

following

required

number

statuses

required

number

media_count

required

number

likes

required

number

joined

required

string

website

required

object

url

required

string

display_url

required

string

birthday

object

day

number

month

number

year

number

verification

object

verified

required

boolean

type

required

string

nullable

Allowed values: organization government individual

verified_at

string

nullable

identity_verified

boolean

verified_by

string

about_account

object

based_in

string

nullable

location_accurate

boolean

created_country_accurate

boolean

nullable

source

string

nullable

username_changes

object

count

required

number

last_changed_at

required

string

nullable

profile_embed

boolean

cursor

required

object

top

required

string

nullable

bottom

required

string

nullable

Example

{
  "results": [
    {
      "type": "profile",
      "verification": {
        "type": "organization"
      }
    }
  ]
}

400

Invalid path or query parameters (e.g. count out of range)

application/json

object

code

required

number

Allowed values: 400

message

required

string

Example

{
  "code": 400
}

404

User not found or list unavailable

application/json

object

code

required

number

results

required

Array<object>

object

type

required

Discriminator: full user profile (API v2).

string

Allowed values: profile

required

string

name

required

string

screen_name

required

string

avatar_url

required

string

nullable

banner_url

required

string

nullable

description

required

string

raw_description

required

object

text

required

string

facets

required

Array<object>

object

type

required

Facet kind: e.g. url, mention, hashtag, bold, media, custom_emoji (Mastodon custom emoji image)

string

indices

required

Start and end UTF-16 indices

Array<number>

>= 2 items <= 2 items

original

string

replacement

string

display

string

location

required

string

url

required

string

protected

required

boolean

followers

required

number

following

required

number

statuses

required

number

media_count

required

number

likes

required

number

joined

required

string

website

required

object

url

required

string

display_url

required

string

birthday

object

day

number

month

number

year

number

verification

object

verified

required

boolean

type

required

string

nullable

Allowed values: organization government individual

verified_at

string

nullable

identity_verified

boolean

verified_by

string

about_account

object

based_in

string

nullable

location_accurate

boolean

created_country_accurate

boolean

nullable

source

string

nullable

username_changes

object

count

required

number

last_changed_at

required

string

nullable

profile_embed

boolean

cursor

required

object

top

required

string

nullable

bottom

required

string

nullable

Example

{
  "results": [
    {
      "type": "profile",
      "verification": {
        "type": "organization"
      }
    }
  ]
}

500

Upstream or processing error

application/json

object

code

required

number

results

required

Array<object>

object

type

required

Discriminator: full user profile (API v2).

string

Allowed values: profile

required

string

name

required

string

screen_name

required

string

avatar_url

required

string

nullable

banner_url

required

string

nullable

description

required

string

raw_description

required

object

text

required

string

facets

required

Array<object>

object

type

required

Facet kind: e.g. url, mention, hashtag, bold, media, custom_emoji (Mastodon custom emoji image)

string

indices

required

Start and end UTF-16 indices

Array<number>

>= 2 items <= 2 items

original

string

replacement

string

display

string

location

required

string

url

required

string

protected

required

boolean

followers

required

number

following

required

number

statuses

required

number

media_count

required

number

likes

required

number

joined

required

string

website

required

object

url

required

string

display_url

required

string

birthday

object

day

number

month

number

year

number

verification

object

verified

required

boolean

type

required

string

nullable

Allowed values: organization government individual

verified_at

string

nullable

identity_verified

boolean

verified_by

string

about_account

object

based_in

string

nullable

location_accurate

boolean

created_country_accurate

boolean

nullable

source

string

nullable

username_changes

object

count

required

number

last_changed_at

required

string

nullable

profile_embed

boolean

cursor

required

object

top

required

string

nullable

bottom

required

string

nullable

Example

{
  "results": [
    {
      "type": "profile",
      "verification": {
        "type": "organization"
      }
    }
  ]
}