Every request returns a standard HTTP status code along with a JSON body.
Below are the possible responses you may encounter.
The request was successful.
{
success: true,
meta: {
rate: 1,
rate_limit: 100,
call: 1,
call_limit: 10000,
credits: 1,
path: "/v1/weather/forecast",
parameters: {
lat: 52.02,
lon: 5.16,
radius: 1000,
language: "en"
}
},
data: {
...
}
}
{
success: false,
meta: {
credits: 0
},
error: {
message: "Missing required parameters",
path: "/v1/weather/forecast",
missingParameters: [
"lat",
"lon"
]
}
}
{
success: false,
meta: {
credits: 0
},
error: {
message: "Missing API key, please provide api_key=<your-api-key>",
path: "/v1/weather/forecast"
}
}
{
success: false,
meta: {
credits: 0
},
error: {
message: "Invalid API key",
path: "/v1/weather/forecast"
}
}
{
success: false,
meta: {
credits: 0
},
error: {
message: "Route not found",
path: "/v1/weather/forecast/unknown"
}
}
{
success: false,
meta: {
rate_limit: 100,
call_limit: 10000,
credits: 0
},
error: {
message: "Rate limit 100 requests/minute reached. Slow down and try again later.",
path: "/v1/weather/forecast"
}
}
{
success: false,
meta: {
credits: 0
},
error: {
message: "No credits left. Please add more credits to your account."
}
}
{
success: false,
meta: {
rate: 1,
rate_limit: 100,
call: 1,
call_limit: 10000,
credits: 0
},
error: {
message: "Error executing route",
description: "Custom error message",
path: "/test/error_custom"
}
}