spicrawl-com · Schema

UsageSummary

CompanyWeb ScrapingData ExtractionAutomationArtificial Intelligence

Properties

Name Type Description
period object
period_elapsed_days integer Whole days of the period elapsed, clamped to [0, period.days]. Use it to pace consumption.
plan object
credits object Metered usage against the plan's included credits, or, with no subscription, against the enforced monthly limit. Filled for every organization (the type stays nullable because older servers returned n
allowance object
metrics object Every billed metric for the period.
unattributed object Part of each metric that per-engine attribution does not explain. Usually equals `metrics` today.
usage_as_of stringnull Newest rollup row in the period, or null when none.
stale_seconds integernull Age of `usage_as_of` in seconds; null when no rows.
warnings array Caveats, e.g. that the allowance counter could not be read. Omitted when empty.
View JSON Schema on GitHub

JSON Schema

spicrawl-com-usage-summary-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/spicrawl-com/json-schema/spicrawl-com-usage-summary-schema.json",
  "title": "UsageSummary",
  "x-generated": "2026-11-10",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/spicrawl-com-usage-api-openapi.yml#/components/schemas/UsageSummary",
  "type": "object",
  "required": [
    "period",
    "period_elapsed_days",
    "plan",
    "credits",
    "metrics",
    "unattributed",
    "usage_as_of",
    "stale_seconds"
  ],
  "properties": {
    "period": {
      "$ref": "#/$defs/UsagePeriod"
    },
    "period_elapsed_days": {
      "type": "integer",
      "minimum": 0,
      "description": "Whole days of the period elapsed, clamped to [0, period.days]. Use it to pace consumption."
    },
    "plan": {
      "$ref": "#/$defs/UsagePlan"
    },
    "credits": {
      "oneOf": [
        {
          "$ref": "#/$defs/UsageCredits"
        },
        {
          "type": "null"
        }
      ],
      "description": "Metered usage against the plan's included credits, or, with no subscription, against the enforced monthly limit. Filled for every organization (the type stays nullable because older servers returned null when there was no subscription). Includes batch spend but not credits held for in-flight work; show `allowance` as \"credits left\"."
    },
    "allowance": {
      "$ref": "#/$defs/UsageAllowance"
    },
    "metrics": {
      "allOf": [
        {
          "$ref": "#/$defs/UsageMetricMap"
        }
      ],
      "description": "Every billed metric for the period."
    },
    "unattributed": {
      "allOf": [
        {
          "$ref": "#/$defs/UsageMetricMap"
        }
      ],
      "description": "Part of each metric that per-engine attribution does not explain. Usually equals `metrics` today."
    },
    "usage_as_of": {
      "type": [
        "string",
        "null"
      ],
      "format": "date-time",
      "description": "Newest rollup row in the period, or null when none."
    },
    "stale_seconds": {
      "type": [
        "integer",
        "null"
      ],
      "minimum": 0,
      "description": "Age of `usage_as_of` in seconds; null when no rows."
    },
    "warnings": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Caveats, e.g. that the allowance counter could not be read. Omitted when empty."
    }
  },
  "$defs": {
    "UsageAllowance": {
      "type": "object",
      "required": [
        "limit_micro",
        "limit_credits",
        "limit_source",
        "unlimited",
        "used_micro",
        "remaining_micro",
        "window_start",
        "resets_at"
      ],
      "description": "The monthly credit allowance as the API ENFORCES it, for the current allowance month. This is the number that decides whether the next request is refused with 402 `ERR::LIMIT::QUOTA_EXCEEDED`, and the one to show as \"credits left\". Present for every organization, subscribed or not; omitted only when the deployment has no allowance counter or it could not be read (a warning then says so).",
      "properties": {
        "limit_micro": {
          "type": "integer",
          "format": "int64",
          "minimum": 0,
          "description": "The enforced monthly limit in micro-credits. 0 means no limit (`unlimited`)."
        },
        "limit_credits": {
          "type": "integer",
          "minimum": 0,
          "description": "`limit_micro` in whole credits, rounded down."
        },
        "limit_source": {
          "type": "string",
          "enum": [
            "default",
            "override"
          ],
          "description": "`default`: the deployment's monthly allowance, which every organization gets. `override`: a limit an operator set for this organization."
        },
        "unlimited": {
          "type": "boolean",
          "description": "True when no limit is enforced (`limit_micro` is 0)."
        },
        "used_micro": {
          "type": "integer",
          "format": "int64",
          "minimum": 0,
          "description": "Micro-credits counted against the limit this allowance month. It includes credits currently HELD for in-flight work (an open browser session holds its whole `session_ttl` price until it closes; a batch job holds the price of its unfinished items) as well as credits spent, and cannot be split into the two. So it can exceed `credits.used_micro`."
        },
        "remaining_micro": {
          "type": "integer",
          "format": "int64",
          "minimum": 0,
          "description": "`limit_micro` minus `used_micro`, never negative. 0 when `unlimited`."
        },
        "window_start": {
          "type": "string",
          "format": "date-time",
          "description": "Start of the allowance month, 00:00 UTC on the day of the month the organization was created."
        },
        "resets_at": {
          "type": "string",
          "format": "date-time",
          "description": "When the allowance is next restored in full; the end of the allowance month."
        }
      }
    },
    "UsageCredits": {
      "type": "object",
      "required": [
        "included_micro",
        "used_micro",
        "remaining_micro",
        "overage_micro",
        "overage_micro_cents_per_credit",
        "used_basis_points"
      ],
      "description": "Allowance arithmetic over METERED usage, in micro-credits (1 credit = 1000000). No money amounts. Metered usage is credits spent, batch items included, and excludes credits held for in-flight work; the number the API enforces is `allowance` on the summary.",
      "properties": {
        "included_micro": {
          "type": "integer",
          "format": "int64",
          "minimum": 0,
          "description": "Credits included in the plan for the period. With no subscription, the enforced monthly limit (the same as `allowance.limit_micro`)."
        },
        "used_micro": {
          "type": "integer",
          "format": "int64",
          "minimum": 0,
          "description": "Credits spent so far in the period, from the usage rollup (`metrics.credits`). Includes batch spend."
        },
        "remaining_micro": {
          "type": "integer",
          "format": "int64",
          "minimum": 0,
          "description": "Included minus used, floored at 0."
        },
        "overage_micro": {
          "type": "integer",
          "format": "int64",
          "minimum": 0,
          "description": "Used beyond the allowance, floored at 0. Billed at invoicing. Always 0 with no subscription, where requests past the limit are refused instead."
        },
        "overage_micro_cents_per_credit": {
          "type": "integer",
          "format": "int64",
          "minimum": 0,
          "description": "Overage price per credit in micro-cents, from the plan."
        },
        "used_basis_points": {
          "type": [
            "integer",
            "null"
          ],
          "format": "int64",
          "minimum": 0,
          "description": "Used divided by included, in basis points (10000 = 100%). Can exceed 10000. Null when the plan includes no credits."
        }
      }
    },
    "UsageMetricMap": {
      "type": "object",
      "description": "Metric name to quantity. Keys are UsageMetric values.",
      "additionalProperties": {
        "type": "integer",
        "format": "int64"
      }
    },
    "UsagePeriod": {
      "type": "object",
      "required": [
        "start",
        "end",
        "days",
        "bounds"
      ],
      "description": "Half-open range of UTC days.",
      "properties": {
        "start": {
          "type": "string",
          "format": "date",
          "description": "First day, inclusive."
        },
        "end": {
          "type": "string",
          "format": "date",
          "description": "End day, EXCLUSIVE. The last included day is the day before this."
        },
        "days": {
          "type": "integer",
          "minimum": 0,
          "description": "Number of days in the period."
        },
        "bounds": {
          "type": "string",
          "const": "[start, end)",
          "description": "Always `[start, end)`, a reminder that `end` is exclusive."
        }
      }
    },
    "UsagePlan": {
      "type": "object",
      "required": [
        "code",
        "name",
        "version",
        "subscription_status",
        "period_source"
      ],
      "properties": {
        "code": {
          "type": "string",
          "description": "Plan code. With no subscription, the organization is on the free plan and this is `free`."
        },
        "name": {
          "type": "string",
          "description": "Plan display name. `Free` (the current free plan's name) when no subscription."
        },
        "version": {
          "type": "integer",
          "description": "Plan version. With no subscription, the current free plan's version (0 if the deployment has no free plan row)."
        },
        "subscription_status": {
          "type": "string",
          "description": "Subscription status, e.g. `active`, `trialing`. `none` when no subscription covers now."
        },
        "period_source": {
          "type": "string",
          "enum": [
            "subscription",
            "allowance_month"
          ],
          "description": "`subscription`: the period is the billing period. `allowance_month`: no subscription covers now, so the organization is on the free plan's monthly allowance, and the period is its allowance month: from 00:00 UTC on the day of the month the organization was created to the same day of the next month. That is the window the allowance is enforced over, not a billing period."
        }
      }
    }
  }
}

Work with this as data

Every JSON Schema here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for schemas

4 MCP tools reach this
  • find_json_schemasBrowse and filter every JSON Schema in the catalog.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This JSON Schema
curl "https://apis.io/api/v1/json-schemas/spicrawl-com-usage-summary"
All schemas
curl "https://apis.io/api/v1/json-schemas?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. By signing up you are subscribing to the APIs.io and API Evangelist newsletters — you can unsubscribe from any issue. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.