Errors
This section defines the standard error codes returned by the Yelp API.
Error Response:
Response codes are defined as strings rather than numeric constants.
| ID | Text | Description |
|---|---|---|
| INTERNAL_ERROR | Internal error | Indicates an internal server error has occurred. |
| EXCEEDED_REQS | Exceeded max daily requests | Indicates that the number of requests executed for the given API key has exceeded its daily limit. |
| MISSING_PARAMETER | A parameter is missing from the request | Indicates that an input parameter is missing from the request. The error response will include the field that was missing. |
| INVALID_PARAMETER | Invalid parameter | Indicates that an input parameter value in the request is invalid. The error response will include the field that was invalid. |
| INVALID_SIGNATURE | Signature was invalid | Indicates that the oauth_signature for the request is invalid. |
| INVALID_CREDENTIALS | The email and password combination is invalid | Indicates that the email/password for Yelp account authorization is invalid. |
| INVALID_OAUTH_CREDENTIALS | The OAuth consumer key is invalid | Indicates that the OAuth consumer key for the request is invalid. |
| ACCOUNT_UNCONFIRMED | The associated account's email is not yet confirmed | Indicates that the Yelp account has not yet been activated. |
| PASSWORD_TOO_LONG | Please enter a password of 16 characters or less | Indicates that the password for the Yelp account is too long. |
| UNAVAILABLE_FOR_LOCATION | API unavailable in this location | Indicates that API requests are unavailable in the given location. |
| AREA_TOO_LARGE | Location specified an area that is too large to search in | Indicates that the geographical area is too large for this search request. Max search area is 2,500 square miles. |
| MULTIPLE_LOCATIONS | Multiple locations match query | Indicates that the given search location could not be disambiguated. |
| BUSINESS_UNAVAILABLE | Business information is unavailable | We may not be able to provide details for certain businesses, for example if they don't have any reviews yet. |
Sample Error Response:
{
'error': {
'text': 'Invalid parameter',
'id': 'INVALID_PARAMETER',
'field': 'location'
}
}