Skip to content
RelayXRelayX API

Get user profile 'about'

GET
/twitter/user_about
const url = 'https://api.relayxapi.com/twitter/user_about?userName=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);
}

Return the extended ‘about’ panel for a profile: category, location, website and joined date, where the account publishes them.

Parameters

Section titled “ Parameters ”

Query Parameters

Section titled “Query Parameters”
userName
required
Username
string

Header Parameters

Section titled “Header Parameters”
x-api-key
X-Api-Key
string

Responses

Section titled “ Responses ”

200

Section titled “200”

Successful Response

Media typeapplication/json
Example
{
  "status": "success",
  "msg": "",
  "data": {
    "data": {
      "user_result_by_screen_name": {
        "rest_id": "12",
        "result": {
          "__typename": "User",
          "about_profile": {
            "account_based_in": "United Kingdom",
            "affiliate_url": "https://twitter.com/Square",
            "affiliate_username": "Square",
            "created_country_accurate": true,
            "learn_more_url": "https://help.twitter.com/managing-your-account/about-twitter-verified-accounts",
            "location_accurate": true,
            "report_problem_url": "https://help.x.com/forms/about-this-account-feedback",
            "source": "United States App Store",
            "username_changes": {
              "count": "0"
            },
            "verified_since_msec": "1324658988066"
          },
          "affiliates_highlighted_label": {
            "label": {
              "badge": {
                "url": "https://pbs.twimg.com/profile_images/1285655593592791040/HtwPZgej_bigger.jpg"
              },
              "description": "Square",
              "url": {
                "url": "https://twitter.com/Square",
                "url_type": "DeepLink"
              },
              "user_label_display_type": "Badge",
              "user_label_type": "BusinessLabel"
            }
          },
          "avatar": {
            "image_url": "https://pbs.twimg.com/profile_images/1661201415899951105/azNjKOSH_normal.jpg"
          },
          "core": {
            "created_at_ms": 1142974214000,
            "name": "jack",
            "screen_name": "jack"
          },
          "is_blue_verified": true,
          "privacy": {
            "protected": false,
            "suspended": false
          },
          "profile_image_shape": "Circle",
          "verification": {
            "is_blue_verified": true,
            "is_verified_organization": false,
            "is_verified_organization_affiliate": true,
            "verified": false
          },
          "verification_info": {
            "is_identity_verified": false,
            "reason": {}
          }
        }
      }
    }
  }
}

422

Section titled “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
Examplegenerated
{
  "detail": [
    {
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example"
    }
  ]
}