Tools

LiveSensitiveSpends credits

Measure an Instagram account's engagement

POST/data-api/v2/tools/instagram/engagement
Scope
tools:use
Freshness
live read
Group
Tools
Platforms
1 of 7

What this endpoint answers

Computes a true engagement rate from the roughly twelve most recent posts, with real per-post like and comment counts. Returns like and comment rates separately, size-adjusted benchmarks, the best and worst post, and the per-post breakdown.

This is a live read: it goes to the platform at request time, returns cache_age_s = 0, and is metered against a separate live-per-minute bucket on top of your tier. It needs the tools:use scope (Tools): Run the analysis tools: valuation, follower audit, scoring, and more.

Good to know

  • Costs money: exactly one ScrapeCreators credit per call. Metered as a live call.
  • Returns 503 not_configured when SCRAPECREATORS_API_KEY is unset, 404 not_found for an unknown or unreachable account, and 502 upstream_error when the upstream fails.
  • Ignores NEXT_PUBLIC_USE_MOCK_DATA: there is no mock path for this data.
  • A private account returns 404 not_found: the post metrics are not readable.
  • Only the posts the profile endpoint returns are analyzed, typically twelve. It is a recent-content rate, not a lifetime one.

Parameters

This endpoint takes no path or query parameters.

Request body

  • handlestringrequired

    Instagram username. Accepts @name or a profile URL. Also accepted as `username`.

Example request body
{
  "handle": "natgeo"
}

Call it

Authenticate with a bearer token or the x-api-key header. Keys are server-to-server credentials. Never embed one in front-end code - call the API from your own backend and forward the result.

curl
curl -X POST "https://crmsolid.com/data-api/v2/tools/instagram/engagement" \
  -H "Authorization: Bearer psk_live_..." \
  -H "Content-Type: application/json" \
  -d '{"handle":"natgeo"}'
JavaScript
const res = await fetch("https://crmsolid.com/data-api/v2/tools/instagram/engagement", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.CRM_SOLID_DATA_API_KEY}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "handle": "natgeo"
  }),
});

if (!res.ok) {
  const { error } = await res.json();
  throw new Error(`${error.code}: ${error.message} (${error.request_id})`);
}

const { data, meta } = await res.json();
Python
import json
import os

import requests

body = json.loads("""
{
  "handle": "natgeo"
}
""")

res = requests.post(
    "https://crmsolid.com/data-api/v2/tools/instagram/engagement",
    headers={"Authorization": f"Bearer {os.environ['CRM_SOLID_DATA_API_KEY']}"},
    json=body,
    timeout=30,
)
res.raise_for_status()

payload = res.json()
data, meta = payload["data"], payload["meta"]

Keys look like psk_live_... for production keys, psk_test_... for test keys and are minted in the panel.

What comes back

Success is { data, meta }. Failure is { error: { code, message, request_id } }. The body below is the spec's own example: the values in it are illustrative readings, not live numbers.

Profile handle
natgeo
Profile name
National Geographic
Profile avatar url
https://scontent.cdninstagram.com/v/t51.2885-19/natgeo.jpg
Profile verified
yes
Profile private
no
Profile business
yes
Profile category
Media/News Company
Profile bio
Experience the world through the eyes of National Geographic photographers.
Profile external url
https://on.natgeo.com/instagram
Profile followers
279,400,000
Profile following
148
Profile posts count
29,841
Profile follower following ratio
1,887,837.84
Engagement engagement rate
0.08
Engagement like rate
0.079
Engagement comment rate
0.001
Engagement avg likes
221,400
Engagement avg comments
1,840
Engagement avg views
1,284,000
Engagement best post engagement
0.21
Engagement worst post engagement
0.03
Rating
average
Rating score
52
Benchmarks below
0.6
Benchmarks average
1.2
Benchmarks good
2
Benchmarks excellent
3.5
Posts analyzed
12
200 POST /tools/instagram/engagement
{
  "data": {
    "profile": {
      "handle": "natgeo",
      "name": "National Geographic",
      "avatar_url": "https://scontent.cdninstagram.com/v/t51.2885-19/natgeo.jpg",
      "verified": true,
      "private": false,
      "business": true,
      "category": "Media/News Company",
      "bio": "Experience the world through the eyes of National Geographic photographers.",
      "external_url": "https://on.natgeo.com/instagram",
      "followers": 279400000,
      "following": 148,
      "posts_count": 29841,
      "follower_following_ratio": 1887837.84
    },
    "engagement": {
      "engagement_rate": 0.08,
      "like_rate": 0.079,
      "comment_rate": 0.001,
      "avg_likes": 221400,
      "avg_comments": 1840,
      "avg_views": 1284000,
      "best_post_engagement": 0.21,
      "worst_post_engagement": 0.03
    },
    "rating": "average",
    "rating_score": 52,
    "benchmarks": {
      "below": 0.6,
      "average": 1.2,
      "good": 2,
      "excellent": 3.5
    },
    "posts_analyzed": 12,
    "recent_posts": [
      {
        "likes": 284100,
        "comments": 2140,
        "views": 0,
        "is_video": false,
        "engagement_rate": 0.1
      }
    ],
    "summary": {
      "size_category": "1M+ followers · Mega Influencer"
    }
  },
  "meta": {
    "request_id": "req_9f2c41a8b3d5",
    "generated_at": "2026-08-23T09:14:02.317Z",
    "took_ms": 42,
    "cache_age_s": 0
  }
}

The meta block

  • request_idstringrequired

    Unique id for this request. Quote it in a support ticket.

  • generated_atstringrequired

    Server time the response was produced.

  • took_msintegerrequired

    Milliseconds spent server-side.

  • pagePageoptional
  • sourcestringoptional

    Which backend served the payload, for endpoints with more than one.

  • cache_age_sintegeroptional

    Age of the underlying data in seconds. 0 for live reads.

When it fails

POST /tools/instagram/engagement documents 7 failure statuses. Branch on error.code, which is stable and enumerated; message is prose and may change.

  • 401Unauthorizedunauthorized | invalid_key

    No key was presented, or the key is unknown, revoked or expired.

  • 402PaymentRequiredpayment_required | subscription_inactive

    The key is valid but the plan behind it cannot serve the call: the included requests are spent and overage is switched off, capped or unfunded (payment_required), or the billing period lapsed and was not renewed (subscription_inactive). Retrying does not help; paying does. The X-Plan-* headers on this response say how far past the line you are.

    Carries X-Plan, X-Plan-Limit, X-Plan-Overage, X-Plan-Period-End, X-Plan-Remaining.

  • 403Forbiddenforbidden_scope | forbidden_ip

    The key is valid but not allowed to make this call: it lacks the scope, or the request came from an address outside the key's allowlist.

  • 422InvalidRequestinvalid_request

    A parameter is malformed, out of range or mutually exclusive with another. `details` names the offending fields.

  • 429RateLimitedrate_limited | quota_exceeded

    Either the burst ceiling for the current minute or the daily quota is spent. Distinguish with the code: rate_limited clears within the minute, quota_exceeded does not clear until 00:00 UTC.

    Carries Retry-After, X-Quota-Limit, X-Quota-Remaining, X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset, X-Request-Id.

  • 500InternalErrorinternal_error

    Something failed on our side. Internals are never leaked; quote the request id.

  • 503Unavailableupstream_timeout | upstream_error | not_configured

    The request could not be served right now. BRANCH ON error.code, not on the status: 'upstream_timeout' means a source was too slow (this is what a catalog query hitting its 15-second statement timeout returns, so it is reachable from any endpoint that reads the corpus, not only the live-scrape ones) and the same call is worth retrying with backoff - narrowing it with a smaller limit, a filtered scope or a less popular account makes it far less likely; 'upstream_error' means a source was unreachable, so back off further; 'not_configured' means the capability has no backing service in this deployment, and retrying will never help.

Every response carries X-Request-Id and meta.request_id. Quote it in support requests.

Coverage and limits

This endpoint covers Instagram. Rate limits come from the tier on your key.

Instagram
TierRequests a minuteRequests a dayLive reads a minute
free301,0005
standard12025,00020
pro600250,00060
unlimited6,00010,000,000600

Live reads count against the live column as well as the ordinary one, so a burst of them runs out of the live bucket first. Every response reports where you stand in X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset and the X-Plan headers.

Start calling it

A key takes a minute to mint in the panel, no card. The reference covers authentication, the envelope, scopes, rate limits and every error code in one page.

Reference path: /data-api/reference/tools-instagram-engagement

We value your privacy

We use cookies to improve our site, analyze traffic, and personalize ads. You can accept all, reject non-essential, or customize your choices. Read our Cookie Policy.