Subscription Usage API

Returns request quota usage counters, remaining quota values, reset timestamps, and related account usage details.

This API will return the current API usage summary for your API key subscription. See Pricing for plan limits, and details.

Additionally the same information can be found in the following HTTP Response Headers returned with every weather data request:

• X-RateLimit-Limit
• X-RateLimit-Remaining
• X-RateLimit-Reset

Request Parameters

Example Request

Default

HTTP Shell Ruby Node.js Python

Copy

https://api.weatherbit.io/v2.0/subscription/usage?key=API_KEY

curl -s "https://api.weatherbit.io/v2.0/subscription/usage?key=API_KEY"

require 'uri'
require 'net/http'
require 'json'

uri = URI("https://api.weatherbit.io/v2.0/subscription/usage?key=API_KEY")
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = (uri.scheme == "https")
request = Net::HTTP::Get.new(uri)
response = http.request(request)
json = JSON.parse(response.body)
puts JSON.pretty_generate(json)

const https = require("https");

https.get("https://api.weatherbit.io/v2.0/subscription/usage?key=API_KEY", (res) => {
  let raw = "";
  res.on("data", (chunk) => { raw += chunk; });
  res.on("end", () => {
    const json = JSON.parse(raw);
    console.log(JSON.stringify(json, null, 2));
  });
}).on("error", (err) => {
  console.error(err.message);
});

{
  "calls_count": "58697",
  "calls_remaining": 7941303,
  "calls_reset_ts": 1780358399,
  "historical_calls_count": "26681",
  "historical_calls_remaining": 373319,
  "historical_calls_reset_ts": 1780358399
}

HTTP Statuses

{
  "error": "Some relevant message"
}

{
  "error": "Some relevant message"
}

{
  "error": "Rate limit exceeded.",
  "status_code": 429,
  "status_message": "Rate limit exceeded. Try again later."
}

{
  "error": "Server Error"
}

Return Fields

Returns request usage counters for your API key subscription, including calls_count, calls_remaining, and reset timestamps.