Look up an account
curl --request GET \
--url https://api.refmatter.com/v1/accounts/lookup \
--header 'Authorization: Bearer <token>'const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.refmatter.com/v1/accounts/lookup', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.refmatter.com/v1/accounts/lookup"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text){
"object": "account",
"id": "<string>",
"platform": "youtube",
"handle": "<string>",
"name": "<string>",
"description": "<string>",
"url": "<string>",
"avatar": [
{
"url": "<string>",
"width": 4503599627370495,
"height": 4503599627370495,
"expiresAt": "<string>"
}
],
"banner": [
{
"url": "<string>",
"width": 4503599627370495,
"height": 4503599627370495,
"expiresAt": "<string>"
}
],
"verified": true,
"stats": {
"followers": 4503599627370495,
"following": 4503599627370495,
"items": 4503599627370495,
"views": 4503599627370495
},
"links": [
{
"title": "<string>",
"url": "<string>"
}
],
"country": "<string>",
"joinedAt": "<string>",
"unavailableFields": [
"handle"
],
"youtube": {
"followersApproximate": true
},
"tiktok": {
"likes": 4503599627370495,
"private": true
},
"instagram": {
"private": true
},
"meta_ad_library": null,
"observedAt": "<string>",
"cached": true,
"usage": {
"creditsCharged": 4503599627370495,
"lines": [
{
"part": "fetch",
"credits": 4503599627370496
}
]
}
}{
"error": {
"code": "invalid_input",
"message": "<string>",
"retryable": true,
"requestId": "<string>",
"details": {}
}
}{
"error": {
"code": "invalid_input",
"message": "<string>",
"retryable": true,
"requestId": "<string>",
"details": {}
}
}{
"error": {
"code": "invalid_input",
"message": "<string>",
"retryable": true,
"requestId": "<string>",
"details": {}
}
}{
"error": {
"code": "invalid_input",
"message": "<string>",
"retryable": true,
"requestId": "<string>",
"details": {}
}
}{
"error": {
"code": "invalid_input",
"message": "<string>",
"retryable": true,
"requestId": "<string>",
"details": {}
}
}{
"error": {
"code": "invalid_input",
"message": "<string>",
"retryable": true,
"requestId": "<string>",
"details": {}
}
}{
"error": {
"code": "invalid_input",
"message": "<string>",
"retryable": true,
"requestId": "<string>",
"details": {}
}
}{
"error": {
"code": "invalid_input",
"message": "<string>",
"retryable": true,
"requestId": "<string>",
"details": {}
}
}{
"error": {
"code": "invalid_input",
"message": "<string>",
"retryable": true,
"requestId": "<string>",
"details": {}
}
}{
"error": {
"code": "invalid_input",
"message": "<string>",
"retryable": true,
"requestId": "<string>",
"details": {}
}
}{
"error": {
"code": "invalid_input",
"message": "<string>",
"retryable": true,
"requestId": "<string>",
"details": {}
}
}{
"error": {
"code": "invalid_input",
"message": "<string>",
"retryable": true,
"requestId": "<string>",
"details": {}
}
}Accounts
Look up an account
Costs 1 credit for a live page or the first serving of a stored account page with a row; empty pages, errors and repeats within maxAge are free.
GET
/
v1
/
accounts
/
lookup
Look up an account
curl --request GET \
--url https://api.refmatter.com/v1/accounts/lookup \
--header 'Authorization: Bearer <token>'const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.refmatter.com/v1/accounts/lookup', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.refmatter.com/v1/accounts/lookup"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text){
"object": "account",
"id": "<string>",
"platform": "youtube",
"handle": "<string>",
"name": "<string>",
"description": "<string>",
"url": "<string>",
"avatar": [
{
"url": "<string>",
"width": 4503599627370495,
"height": 4503599627370495,
"expiresAt": "<string>"
}
],
"banner": [
{
"url": "<string>",
"width": 4503599627370495,
"height": 4503599627370495,
"expiresAt": "<string>"
}
],
"verified": true,
"stats": {
"followers": 4503599627370495,
"following": 4503599627370495,
"items": 4503599627370495,
"views": 4503599627370495
},
"links": [
{
"title": "<string>",
"url": "<string>"
}
],
"country": "<string>",
"joinedAt": "<string>",
"unavailableFields": [
"handle"
],
"youtube": {
"followersApproximate": true
},
"tiktok": {
"likes": 4503599627370495,
"private": true
},
"instagram": {
"private": true
},
"meta_ad_library": null,
"observedAt": "<string>",
"cached": true,
"usage": {
"creditsCharged": 4503599627370495,
"lines": [
{
"part": "fetch",
"credits": 4503599627370496
}
]
}
}{
"error": {
"code": "invalid_input",
"message": "<string>",
"retryable": true,
"requestId": "<string>",
"details": {}
}
}{
"error": {
"code": "invalid_input",
"message": "<string>",
"retryable": true,
"requestId": "<string>",
"details": {}
}
}{
"error": {
"code": "invalid_input",
"message": "<string>",
"retryable": true,
"requestId": "<string>",
"details": {}
}
}{
"error": {
"code": "invalid_input",
"message": "<string>",
"retryable": true,
"requestId": "<string>",
"details": {}
}
}{
"error": {
"code": "invalid_input",
"message": "<string>",
"retryable": true,
"requestId": "<string>",
"details": {}
}
}{
"error": {
"code": "invalid_input",
"message": "<string>",
"retryable": true,
"requestId": "<string>",
"details": {}
}
}{
"error": {
"code": "invalid_input",
"message": "<string>",
"retryable": true,
"requestId": "<string>",
"details": {}
}
}{
"error": {
"code": "invalid_input",
"message": "<string>",
"retryable": true,
"requestId": "<string>",
"details": {}
}
}{
"error": {
"code": "invalid_input",
"message": "<string>",
"retryable": true,
"requestId": "<string>",
"details": {}
}
}{
"error": {
"code": "invalid_input",
"message": "<string>",
"retryable": true,
"requestId": "<string>",
"details": {}
}
}{
"error": {
"code": "invalid_input",
"message": "<string>",
"retryable": true,
"requestId": "<string>",
"details": {}
}
}{
"error": {
"code": "invalid_input",
"message": "<string>",
"retryable": true,
"requestId": "<string>",
"details": {}
}
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Query Parameters
Absolute HTTP(S) YouTube, Instagram or TikTok account URL
Maximum string length:
2048The account platform when using handle or id
Available options:
youtube, instagram, tiktok Account handle, with or without @
Required string length:
1 - 3124-character YouTube channel id; YouTube only
Pattern:
^UC[A-Za-z0-9_-]{22}$How fresh a stored page may be: 0 or minutes, hours or days up to 1d; default 1h
Pattern:
^(0|[1-9][0-9]{0,5}[mhd])$Response
The account as it was observed
Allowed value:
"account"Pattern:
^(youtube|tiktok|instagram|meta_ad_library):[A-Za-z0-9._-]{1,128}$Available options:
youtube, tiktok, instagram, meta_ad_library Required string length:
1 - 256Maximum string length:
500Maximum string length:
5000Required string length:
1 - 2048Maximum array length:
64Show child attributes
Show child attributes
Maximum array length:
64Show child attributes
Show child attributes
Show child attributes
Show child attributes
Maximum array length:
32Show child attributes
Show child attributes
Maximum string length:
100Pattern:
^\d{4}-\d{2}-\d{2}$Maximum array length:
13Available options:
handle, name, description, url, avatar, banner, verified, stats.followers, stats.following, stats.items, stats.views, country, joinedAt Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Pattern:
^\d{4}-(0[1-9]|1[0-2])-([0-2]\d|3[01])T([01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d{1,9})?(?:Z|[+-](?:[01]\d|2[0-3]):[0-5]\d)$Show child attributes
Show child attributes