Responses

Every request returns a standard HTTP status code along with a JSON body.

Below are the possible responses you may encounter.

200 OK

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: {
		...
	}
}

400 Missing required parameters

{
	success: false,
	meta: {
		credits: 0
	},
	error: {
		message: "Missing required parameters",
		path: "/v1/weather/forecast",
		missingParameters: [
		   "lat",
		   "lon"
		]
	}
}

400 Missing API key

{
	success: false,
	meta: {
		credits: 0
	},
	error: {
		message: "Missing API key, please provide api_key=<your-api-key>",
		path: "/v1/weather/forecast"
	}
}

401 Invalid API key

{
	success: false,
	meta: {
		credits: 0
	},
	error: {
		message: "Invalid API key",
		path: "/v1/weather/forecast"
	}
}

404 Route not found

{
	success: false,
	meta: {
		credits: 0
	},
	error: {
		message: "Route not found",
		path: "/v1/weather/forecast/unknown"
	}
}

429 Rate limit

{
	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"
	}
}

429 No credits left

{
	success: false,
	meta: {
		credits: 0
	},
	error: {
		message: "No credits left. Please add more credits to your account."
	}
}

500 Internal Server Error

{
	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"
	}
}