Introspect the calling API key
curl --request GET \
--url https://api.fomoscan.sh/v2/me \
--header 'Authorization: Bearer <token>'const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.fomoscan.sh/v2/me', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.fomoscan.sh/v2/me"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text){
"key": {
"prefix": "<string>",
"name": "<string>",
"environment": "live"
},
"plan": "<string>",
"scopes": [
"<string>"
],
"entitlement": {
"monthlyUnits": 1,
"ratePerMinute": 1,
"monthlyReveals": 1,
"unmetered": true
},
"usage": {
"period": "<string>",
"unitsUsed": 1,
"unitsRemaining": 1,
"additionalUnits": 1,
"revealsUsed": 1,
"revealsRemaining": 1
}
}{
"error": {
"code": "BAD_REQUEST",
"message": "<string>",
"retryAfter": 123,
"addUrl": "<string>"
}
}{
"error": {
"code": "BAD_REQUEST",
"message": "<string>",
"retryAfter": 123,
"addUrl": "<string>"
}
}{
"error": {
"code": "BAD_REQUEST",
"message": "<string>",
"retryAfter": 123,
"addUrl": "<string>"
}
}Account
Introspect the calling API key
Returns the account, plan, scopes, entitlement and current usage for the presented API key.
- Requires any valid API key (no specific scope).
- Not metered.
usage.periodis the current UTC month,YYYY-MM.usage.unitsRemainingnever goes below 0.usage.additionalUnitsnever expires and is spent only once the month’s grant cannot cover a call.usage.revealsUsedcounts the responses that returned a wallet this period, forward lookups included.entitlement.unmeteredis true on a key that is never refused for quota. Calls are still counted, sousage.unitsUsedclimbs as always, andmonthlyUnitsstill reports the plan’s grant without acting as a limit.usage.unitsRemainingandusage.revealsRemainingarenull, not0, on a key with no cap to count down.
GET
/
v2
/
me
Introspect the calling API key
curl --request GET \
--url https://api.fomoscan.sh/v2/me \
--header 'Authorization: Bearer <token>'const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.fomoscan.sh/v2/me', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.fomoscan.sh/v2/me"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text){
"key": {
"prefix": "<string>",
"name": "<string>",
"environment": "live"
},
"plan": "<string>",
"scopes": [
"<string>"
],
"entitlement": {
"monthlyUnits": 1,
"ratePerMinute": 1,
"monthlyReveals": 1,
"unmetered": true
},
"usage": {
"period": "<string>",
"unitsUsed": 1,
"unitsRemaining": 1,
"additionalUnits": 1,
"revealsUsed": 1,
"revealsRemaining": 1
}
}{
"error": {
"code": "BAD_REQUEST",
"message": "<string>",
"retryAfter": 123,
"addUrl": "<string>"
}
}{
"error": {
"code": "BAD_REQUEST",
"message": "<string>",
"retryAfter": 123,
"addUrl": "<string>"
}
}{
"error": {
"code": "BAD_REQUEST",
"message": "<string>",
"retryAfter": 123,
"addUrl": "<string>"
}
}Authorizations
B2B API key (fsk_live_… / fsk_test_…), issued by FomoScan. Also accepted via X-Api-Key.
