Usage

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/noun-project/refs/heads/main/json-schema/noun-project-usage-schema.json",
  "title": "Usage",
  "description": "API key usage and quota information.",
  "type": "object",
  "properties": {
    "hourly": {
      "type": "object",
      "description": "Usage statistics for a single time window.",
      "properties": {
        "service_calls_used": {
          "type": "integer",
          "description": "Non-icon API calls consumed in this window.",
          "example": 245
        },
        "service_calls_limit": {
          "type": "integer",
          "description": "Maximum non-icon API calls allowed in this window.",
          "example": 1000
        },
        "icon_calls_used": {
          "type": "integer",
          "description": "Icon-specific calls consumed in this window.",
          "example": 38
        },
        "icon_calls_limit": {
          "type": "integer",
          "description": "Maximum icon-specific calls allowed in this window.",
          "example": 150
        },
        "period_start": {
          "type": "string",
          "format": "date-time",
          "description": "ISO 8601 timestamp of when this window started.",
          "example": "2026-05-28T00:00:00Z"
        },
        "period_end": {
          "type": "string",
          "format": "date-time",
          "description": "ISO 8601 timestamp of when this window ends.",
          "example": "2026-05-29T00:00:00Z"
        }
      }
    },
    "daily": {
      "type": "object",
      "description": "Usage statistics for a single time window.",
      "properties": {
        "service_calls_used": {
          "type": "integer",
          "description": "Non-icon API calls consumed in this window.",
          "example": 245
        },
        "service_calls_limit": {
          "type": "integer",
          "description": "Maximum non-icon API calls allowed in this window.",
          "example": 1000
        },
        "icon_calls_used": {
          "type": "integer",
          "description": "Icon-specific calls consumed in this window.",
          "example": 38
        },
        "icon_calls_limit": {
          "type": "integer",
          "description": "Maximum icon-specific calls allowed in this window.",
          "example": 150
        },
        "period_start": {
          "type": "string",
          "format": "date-time",
          "description": "ISO 8601 timestamp of when this window started.",
          "example": "2026-05-28T00:00:00Z"
        },
        "period_end": {
          "type": "string",
          "format": "date-time",
          "description": "ISO 8601 timestamp of when this window ends.",
          "example": "2026-05-29T00:00:00Z"
        }
      }
    },
    "monthly": {
      "type": "object",
      "description": "Usage statistics for a single time window.",
      "properties": {
        "service_calls_used": {
          "type": "integer",
          "description": "Non-icon API calls consumed in this window.",
          "example": 245
        },
        "service_calls_limit": {
          "type": "integer",
          "description": "Maximum non-icon API calls allowed in this window.",
          "example": 1000
        },
        "icon_calls_used": {
          "type": "integer",
          "description": "Icon-specific calls consumed in this window.",
          "example": 38
        },
        "icon_calls_limit": {
          "type": "integer",
          "description": "Maximum icon-specific calls allowed in this window.",
          "example": 150
        },
        "period_start": {
          "type": "string",
          "format": "date-time",
          "description": "ISO 8601 timestamp of when this window started.",
          "example": "2026-05-28T00:00:00Z"
        },
        "period_end": {
          "type": "string",
          "format": "date-time",
          "description": "ISO 8601 timestamp of when this window ends.",
          "example": "2026-05-29T00:00:00Z"
        }
      }
    }
  }
}