Status and error codes

Our API returns standard HTTP success or error status codes. For errors, we will also include extra information about what went wrong encoded in the response as JSON.
More detailed information about the API endpoints and errror and status codes can be found at the OpenAPI documentation for the Scorer API: https://api.scorer.gitcoin.co/docs

HTTP Status codes

Code
Title
Description
200
OK
The request was successful.
400
Bad request
Bad request
401
Unauthorized
Your API key is invalid.
404
Not found
The resource does not exist.
429
Too Many Requests
The rate limit was exceeded.
500
Internal Server Error
An error occurred with our API.

Error types

All errors are returned in the form of JSON with a detail explaining the error
Example error response.
{
"detail": "string"
}
Error Detail
Description
Invalid nonce
The nonce used in the submit passport API request could not be verified
Address does not match signature
The signer could not be verified
Invalid limit
The page limit of the Get Scores API request is greater than 1000
Unable to get score for provided scorer ID
Unable to validate that the scorer ID belongs to the account holding the API key
Unauthorized
X-API-Key was not specified in the header or an invalid X-API-Key was provided
Internal Server Error
Something went wrong on our end (this is rare)
More detailed information about the API endpoints and errror and status codes can be found at the OpenAPI documentation for the Scorer API: https://api.scorer.gitcoin.co/docs