Response format

Successful responses share one envelope. data holds the platform payload; meta covers credits and latency. Field shapes inside data are documented per endpoint in the API reference.

Core fields

Present on every successful lookup (200):

Field	Type	Description
ok	boolean	Always `true` on success.
platform	string	Platform id from the path (e.g. `instagram`).
resource	string	Resource id from the path (e.g. `user`).
params	object	Echo of the query parameters used for the lookup.
data	object \| array	Platform-specific payload. Shape depends on the endpoint.
meta	object	Billing and timing metadata for this request.
meta.credits_charged	number	Credits deducted for this call (usually 1+ per endpoint).
meta.latency_ms	number	Server-side lookup duration in milliseconds.
meta.path	string	Canonical API path (e.g. `/v1/instagram/user`).

Platform-specific fields

Everything under data is platform- and resource-specific. Socify strips upstream provider identifiers; you only see the public social payload. Example for Profile Info:

Field	Type	Description
pk / pk_id	string	Numeric user id.
username	string	Public handle without @.
full_name	string	Display name on the profile.
is_private / is_verified	boolean	Privacy and verification flags.
profile_pic_url	string	CDN URL of the profile picture.
has_highlight_reels	boolean	Whether the profile has story highlights.
live_broadcast_id	string \| null	Live broadcast id if the user is live; otherwise null.

Other platforms expose different fields under the same data key : always check the endpoint page for the authoritative list and sample.

Full example

Complete successful response for GET /api/v1/instagram/user?username=natgeo:

{
  "ok": true,
  "platform": "instagram",
  "resource": "user",
  "params": {
    "username": "natgeo"
  },
  "data": {
    "pk": "787132",
    "pk_id": "787132",
    "username": "natgeo",
    "full_name": "National Geographic",
    "is_private": false,
    "is_verified": true,
    "profile_pic_url": "https://scontent.cdninstagram.com/v/t51.2885-19/example.jpg",
    "profile_pic_id": "1234567890123456789_787132",
    "has_anonymous_profile_picture": false,
    "has_highlight_reels": true,
    "has_opt_eligible_shop": false,
    "account_badges": [],
    "latest_reel_media": 0,
    "live_broadcast_id": null,
    "should_show_category": false
  },
  "meta": {
    "credits_charged": 1,
    "latency_ms": 420,
    "platform": "instagram",
    "resource": "user",
    "path": "/v1/instagram/user"
  }
}

Response format

Successful responses share one envelope. data holds the platform payload; meta covers credits and latency. Field shapes inside data are documented per endpoint in the API reference.

Core fields

Present on every successful lookup (200):

Field	Type	Description
ok	boolean	Always `true` on success.
platform	string	Platform id from the path (e.g. `instagram`).
resource	string	Resource id from the path (e.g. `user`).
params	object	Echo of the query parameters used for the lookup.
data	object \| array	Platform-specific payload. Shape depends on the endpoint.
meta	object	Billing and timing metadata for this request.
meta.credits_charged	number	Credits deducted for this call (usually 1+ per endpoint).
meta.latency_ms	number	Server-side lookup duration in milliseconds.
meta.path	string	Canonical API path (e.g. `/v1/instagram/user`).

Platform-specific fields

Everything under data is platform- and resource-specific. Socify strips upstream provider identifiers; you only see the public social payload. Example for Profile Info:

Field	Type	Description
pk / pk_id	string	Numeric user id.
username	string	Public handle without @.
full_name	string	Display name on the profile.
is_private / is_verified	boolean	Privacy and verification flags.
profile_pic_url	string	CDN URL of the profile picture.
has_highlight_reels	boolean	Whether the profile has story highlights.
live_broadcast_id	string \| null	Live broadcast id if the user is live; otherwise null.

Other platforms expose different fields under the same data key : always check the endpoint page for the authoritative list and sample.

Full example

Complete successful response for GET /api/v1/instagram/user?username=natgeo:

{
  "ok": true,
  "platform": "instagram",
  "resource": "user",
  "params": {
    "username": "natgeo"
  },
  "data": {
    "pk": "787132",
    "pk_id": "787132",
    "username": "natgeo",
    "full_name": "National Geographic",
    "is_private": false,
    "is_verified": true,
    "profile_pic_url": "https://scontent.cdninstagram.com/v/t51.2885-19/example.jpg",
    "profile_pic_id": "1234567890123456789_787132",
    "has_anonymous_profile_picture": false,
    "has_highlight_reels": true,
    "has_opt_eligible_shop": false,
    "account_badges": [],
    "latest_reel_media": 0,
    "live_broadcast_id": null,
    "should_show_category": false
  },
  "meta": {
    "credits_charged": 1,
    "latency_ms": 420,
    "platform": "instagram",
    "resource": "user",
    "path": "/v1/instagram/user"
  }
}

Response format

Successful responses share one envelope. data holds the platform payload; meta covers credits and latency. Field shapes inside data are documented per endpoint in the API reference.

Core fields

Present on every successful lookup (200):

Field	Type	Description
ok	boolean	Always `true` on success.
platform	string	Platform id from the path (e.g. `instagram`).
resource	string	Resource id from the path (e.g. `user`).
params	object	Echo of the query parameters used for the lookup.
data	object \| array	Platform-specific payload. Shape depends on the endpoint.
meta	object	Billing and timing metadata for this request.
meta.credits_charged	number	Credits deducted for this call (usually 1+ per endpoint).
meta.latency_ms	number	Server-side lookup duration in milliseconds.
meta.path	string	Canonical API path (e.g. `/v1/instagram/user`).

Platform-specific fields

Everything under data is platform- and resource-specific. Socify strips upstream provider identifiers; you only see the public social payload. Example for Profile Info:

Field	Type	Description
pk / pk_id	string	Numeric user id.
username	string	Public handle without @.
full_name	string	Display name on the profile.
is_private / is_verified	boolean	Privacy and verification flags.
profile_pic_url	string	CDN URL of the profile picture.
has_highlight_reels	boolean	Whether the profile has story highlights.
live_broadcast_id	string \| null	Live broadcast id if the user is live; otherwise null.

Other platforms expose different fields under the same data key : always check the endpoint page for the authoritative list and sample.

Full example

Complete successful response for GET /api/v1/instagram/user?username=natgeo:

{
  "ok": true,
  "platform": "instagram",
  "resource": "user",
  "params": {
    "username": "natgeo"
  },
  "data": {
    "pk": "787132",
    "pk_id": "787132",
    "username": "natgeo",
    "full_name": "National Geographic",
    "is_private": false,
    "is_verified": true,
    "profile_pic_url": "https://scontent.cdninstagram.com/v/t51.2885-19/example.jpg",
    "profile_pic_id": "1234567890123456789_787132",
    "has_anonymous_profile_picture": false,
    "has_highlight_reels": true,
    "has_opt_eligible_shop": false,
    "account_badges": [],
    "latest_reel_media": 0,
    "live_broadcast_id": null,
    "should_show_category": false
  },
  "meta": {
    "credits_charged": 1,
    "latency_ms": 420,
    "platform": "instagram",
    "resource": "user",
    "path": "/v1/instagram/user"
  }
}