KOMI API
Komi page
Retrieve komi page from Komi with a single API request.
GET
/api/data/v1/komi1credit base costZero-credit cache supported
Request parameters
Up to 1 creditURL to Komi page
If we have a response in the cache that is this many days old or newer, return the cached response (0 credits, with "cached": true and a "cached_at" timestamp). Otherwise, scrape a live result (1 credit). [See the Caching page for details.]
Live requests use your prepaid balance. Cached responses cost zero where supported.
curl --request GET \
--url 'https://fetchgoblin.com/api/data/v1/komi?url=https%3A%2F%2Fkimkardashian.komi.io%2F' \
--header 'x-api-key: YOUR_FETCHGOBLIN_API_KEY'Response
Example{
"success": true,
"id": "64d82830-59aa-4488-bfb0-93426971d139",
"username": "kimkardashian",
"avatar": "https://komi-production-assets.s3.amazonaws.com/photos/4Nd69ODJHs61_iNYPlqos.jpg",
"bio": "",
"firstName": "Kim",
"lastName": "Kardashian",
"displayName": "Kim Kardashian",
"displayNameImage": null,
"instagram": "https://www.instagram.com/kimkardashian/",
"tiktok": "https://www.tiktok.com/@kimkardashian",
"youtube": "https://www.youtube.com/@KUWTK",
"twitter": "https://twitter.com/KimKardashian",
"facebook": "https://www.facebook.com/KimKardashian",
"snapchat": "https://www.snapchat.com/add/kimkardashian?locale=en-GB",
"website": null,
"links": [
{
"id": "6d7086df-ede4-4f8a-85e5-0fa410e60bc2",
"url": "https://skims.social/shop-skims",
"order": 0,
"title": "Visit SKIMS",
"visible": true,
"moduleId": "e6ce39d2-e3df-4040-a5cc-ce016cacbc34",
"thumbnail": "https://komi-production-assets.s3-accelerate.amazonaws.com/photos/x_LQCBYzoWiel0-yrAnrF.jpg",
"versionId": "944094bf-f124-4b13-866a-3498c492736d",
"type": "LINK"
}
],
"credits_charged": 1,
"credits_remaining": 1000,
"request_id": "00000000-0000-4000-8000-000000000000"
}Example data from the API specification. Run a request to retrieve current data.
Response shape
This schema describes the documented data shape. Some platform fields may be absent or null. The response also includes your FetchGoblin request ID and current credit balance.
View JSON Schema +
{
"type": "object",
"properties": {
"success": {
"type": "boolean"
},
"id": {
"type": "string"
},
"username": {
"type": "string"
},
"avatar": {
"type": "string"
},
"bio": {
"type": "string"
},
"firstName": {
"type": "string"
},
"lastName": {
"type": "string"
},
"displayName": {
"type": "string"
},
"displayNameImage": {
"type": [
"string",
"object",
"array",
"number",
"boolean",
"null"
]
},
"instagram": {
"type": "string"
},
"tiktok": {
"type": "string"
},
"youtube": {
"type": "string"
},
"twitter": {
"type": "string"
},
"facebook": {
"type": "string"
},
"snapchat": {
"type": "string"
},
"website": {
"type": [
"string",
"object",
"array",
"number",
"boolean",
"null"
]
},
"links": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"url": {
"type": "string"
},
"order": {
"type": "integer"
},
"title": {
"type": "string"
},
"visible": {
"type": "boolean"
},
"moduleId": {
"type": "string"
},
"thumbnail": {
"type": "string"
},
"versionId": {
"type": "string"
},
"type": {
"type": "string"
}
}
}
},
"credits_charged": {
"type": "integer",
"minimum": 0,
"description": "FetchGoblin credits charged for this request."
},
"credits_remaining": {
"type": "integer",
"description": "Your FetchGoblin credit balance after this request."
},
"request_id": {
"type": "string",
"format": "uuid",
"description": "FetchGoblin request identifier."
}
}
}