Getting Started
API Access Key & Authentication
After signing up for an account, each user will be assigned a unique API access key. This key will be used to authenticate with the API via HTTP GET and access any of the available endpoints.
To authenticate with the API, simply append your API access key to the API's base URL using the access_key parameter.
Keep your key safe: To prevent unauthorized use of your account or API access, please keep your API key private and protected from third parties. You can reset your access key in your account dashboard with immediate effect.
256-bit HTTPS Encryption
Customers subscribed to any plan can connect to the API using an industry industry-standard HTTPS (SSL) by appending an " s " to the HTTP Protocol. Please find an example of an HTTPS API request below.
Example API Request:
Available on all plans
API Error Codes
If an API request fails, a JSON object containing details about the error will be returned by the API. Find below an example error that is returned if the maximum allowed API request limit has been reached or exceeded.
Example Error:
Common API Errors:
| Code | Type | Info |
|---|---|---|
404 | 404_not_found | User requested a resource which does not exist. |
101 | missing_access_key | User did not provide an access key. |
101 | invalid_access_key | User provided an invalid access key. |
102 | inactive_user | User account is inactive or blocked. |
103 | invalid_api_function | User requested a non-existent API function. |
104 | usage_limit_reached | User has reached his subscription's monthly request allowance. |
105 | function_access_restricted | The user's current subscription does not support this API function. |
210 | missing_location_query | User has not provided a valid location value inside the query parameter. For details, please refer to the Locations API section of this documentation. |
310 | missing_search_query | User has not provided a valid value inside the query parameter. |
311 | invalid_engine | User has provided an invalid value inside the query parameter. |
312 | invalid_output_type | User has provided an invalid value inside the output parameter. |
313 | empty_field_list | User has not provided a valid value inside the csv_list parameter. |
314 | invalid_search_type | User has not provided a valid value inside the type parameter. |
315 | invalid_google_domain | User has not provided a valid Google domain inside the google_domain parameter. |
316 | invalid_time_period | User has not provided a valid value inside the period parameter. |
317 | missing_start_date | User has not provided a valid date inside the period_start parameter. |
318 | missing_end_date | User has not provided a valid date inside the period_end parameter. |
319 | invalid_start_date | User has provided an invalid date inside the period_start parameter. |
320 | invalid_end_date | User has provided an invalid date inside the period_end parameter. |
321 | invalid_sort_type | User has provided an invalid value inside the sort parameter. |
322 | invalid_images_page | User has provided an invalid value inside the images_page parameter. |
323 | invalid_images_color | User has provided an invalid value inside the images_color parameter. |
324 | invalid_images_size | User has provided an invalid value inside the images_size parameter. |
325 | invalid_images_type | User has provided an invalid value inside the images_type parameter. |
326 | invalid_images_usage | User has provided an invalid value inside the images_usage parameter. |
327 | request_failed | API request failed due to an unknown error. Please contact customer support and report the error. |