vlayervlayer docs
Using the API

Usage and billing

What counts as a billable unit, what is free, and how to read your usage by token, route and day.

What is billed

Every successful data lookup is one billable unit; a batch counts one per distinct post that succeeded. Volumes and pricing are agreed when you get access.

RequestUnits
A successful data lookup1
A page of comments1 per page, however many comments it holds
POST /v1/stats/batch1 per distinct post that succeeded before the batch deadline
Any request answered with an error (4xx or 5xx), including 4290

In a batch, two URLs with the same cleaned-up postUrl are read once and counted once (a /p/ and a /reel/ link to one Instagram post count as two), and failed or timed-out URLs cost nothing, so a batch in which every URL failed is not billed. Reading every page of a post's comments costs one unit per page.

Usage on staging is counted separately from production.

Read your usage

GET/auth/usage?from={from}&to={to}&tokenId={tokenId}

Reports what your tokens have done over a window, 30 days by default: requests, billable units and errors, in total and broken down by token, by route and by UTC day.

curl "{API_BASE_URL}/auth/usage?from=2026-09-01&to=2026-10-01" \
  -H "Authorization: Bearer <API_TOKEN>"
{
  "data": {
    "from": "2026-09-01T00:00:00.000Z",
    "to": "2026-10-01T00:00:00.000Z",
    "totals": { "requests": 1240, "billableUnits": 1180, "errors": 60 },
    "byToken": [{ "tokenId": 1, "name": "Production Token", "requests": 1240, "billableUnits": 1180, "errors": 60 }],
    "byRoute": [{ "method": "GET", "route": "/v1/stats", "requests": 900, "billableUnits": 880, "errors": 20 }],
    "byDay": [{ "day": "2026-09-16", "requests": 41, "billableUnits": 40, "errors": 1 }]
  }
}
QueryNotes
fromStart of the window, inclusive. Defaults to 30 days before to
toEnd of the window, exclusive. Defaults to now
tokenIdReport on one token only

The window may not exceed 400 days; a longer or inverted window returns 400. A revoked token keeps its rows, its tokenId and its name.

Last updated on