Documentation

Everything you need to know to start using the Slpy API

Errors and Troubleshooting

Using your browsers developers console, or other tools, you can check the Api requests response headers for response status and the response header named "reject-reason".


Error Codes

Check the request response code for help diagnosing a bad request.

HTTP Error Code Meaning
401 Unauthorized - The API Key was missing, invalid, disabled, or not allowed for the service.
403 Forbidden - The server understands the request, but it refuses to authorize it.
404 Not Found - The requested was invalid or missing a required part.
405 Unauthorized Service - Service requires a Pro Subscription or was disabled in Key settings.
407 Unauthorized Referrer - Referrere or Orgin heading not allowed by your API Key settings.
429 Too Many Requests - The requesting IP was ratelimited, lack of credits, or service was throttled.
500 Internal Server Error - An error occurred on the server. Please contact support in the forums.

Error Responses

Check the request response header for "reject-reason" for help diagnosing a bad request.

Reject Reason Code Meaning
Must be .png format Raster and Aerial tiles currently support PNG format only.
Must be .pbf format Vector tiles currently support PBF format only.
URL must be lowercase Please use all lowercase letters in URL Path.
API Key Missing The request requires an API Key. Try adding "?key=your_api_key" to URL.
Missing Information Your request seems to be missing a part like language or style.
Unsupported Language Please check supported two character code languages.
Type code was not imagery or topo An incorrect aerial type was used. Please check supported formats for aerial tiles.
Must be .png or .pbf Request for tile was missing a file type
Bad ZXY Tile Bad latitude or longitude. Should be /latitude/longitude/zoom format.
Unsupported Data Zoom Level Must be 0-15 for vector, 0-19 for raster, and 0-16 for aerial.
CF:API Key Unauthorized API Key does not exist or request was not authorized.
Account Maximum Reached Please check you Slpy API account for more information.
Service Rate Limited You've exceeded the maximum rate allowed for the service.
Blocked Service Type Service not allowed with this API Key, check the Key's settings for allowed services.
Service Type Requires Pro Service not allowed with this API Key. Upgrade to Pro to use this product.
Empty Referrer Empty referrer or origin not allowed, check the Key's settings page.
Bad Referrer Referrer or Orgin does not match the key's whitelist, check the Key's settings page.
Too Many Requests The requesting IP has exceeded the key's ratelimits, check the Key's settings page.
Cache failed The cache returned an error. Please contact support in the community forums.
Account Locked Abuse was detected and your account was locked. Please contact support in the community forums.