Skip to content

User Live Status

GET/v1/instagram/user/live1 credit

Tells whether an account is broadcasting live right now and, if it is, the broadcast: its id, title, start time, current viewer count and watch URL.

01Query parameters

NameTypeDescription
user_idoptionalstringNumeric Instagram user id. Either `user_id` or `handle` is required. When both are given, `handle` is used.
handleoptionalstringInstagram username (a leading `@` or a profile URL also works). Either `user_id` or `handle` is required.

02Request

curl "https://api.scrapesocial.ai/v1/instagram/user/live?handle=alarabiya" \
  -H "x-api-key: $SCRAPESOCIAL_KEY"

03Responses

Real answers from the API. Lists are shortened to 2 items.

GET /v1/instagram/user/live?handle=alarabiya

{
  "success": true,
  "credits_remaining": 4980,
  "credits_charged": 1,
  "platform": "instagram",
  "is_live": false,
  "live_id": null,
  "title": null,
  "started_at": null,
  "viewer_count": null,
  "url": null,
  "owner": {
    "id": "971184598",
    "username": "alarabiya",
    "display_name": "العربية Al Arabiya"
  }
}

Common to every endpoint

Any route can answer these: a missing or wrong key, no credits left, the platform not answering, or a failure on our side. None of them costs credits.

GET /v1/cosmos/profile?handle=design

{
  "success": false,
  "message": "Invalid API key"
}

04Notes

Our own endpoint: ScrapeCreators has no Instagram live route. The answer is the same on every platform's live endpoint: `platform`, `is_live`, `live_id`, `title`, `started_at` (ISO 8601, UTC), `viewer_count`, `url` and `owner` (`id`, `username`, `display_name`). Live or not, the answer costs 1 credit; when the account is not live, `is_live` is `false`, `owner` is filled and the stream fields are `null`. A value Instagram does not give is `null`, never 0. A private account is a free 403, an unknown one a free 404.

05Errors & credits

Every error has success: false, a real HTTP status and costs no credits.

  • 400missing_parameter

    A required parameter is missing or invalid.

  • 403private_account

    The account is private or age-restricted.

  • 404not_found

    No such account.

  • 503upstream_error

    The platform did not answer; retry shortly.