The GlobalWineScore API is designed as a RESTful API, providing several resources and methods depending on your usage plan. For further information please refer to our plans. # Authentication The API uses token-based authentication. In order to authenticate your requests, you need to include a specific header in each of your requests: ``` Authorization: Token {YOUR-API-TOKEN} ``` The word Token must be written. Your requests must also use the HTTPS protocol. If you don't have a token yet, you need to apply for one [here](https://www.globalwinescore.com/api/). Your personal token can be found under the My account > API section of the GlobalWineScore website # Format The API provides several rendering formats which you can control using the `Accept` header or `format` query parameter. - JSON (default): no header or `Accept: application/json` - XML: `Accept: application/xml` # Rate limiting For API requests, the rate limit allows for up to 10 requests per minute. # Error handling Whether a request succeeded is indicated by the HTTP status code. A 2xx status code indicates success, whereas a 4xx status code indicates failure. When a request fails, the response body is still JSON, but always contains a `detail` field with a description of the error, which you can inspect for debugging. For example, trying to access the API without proper authentication will return code 403 along with the message: `{"detail": "Authentication credentials were not provided."}` Found a bug ? send us an email at api@globalwinescore.com # Ordering At the moment, GlobalWineScores may be sorted by `date` and `score`. Use "-" to sort in descending order. # Continuous synchronization If you need to synchronize your database with our API, you can query our API using `?ordering=-date` to get the newest scores first, which means you won't have to crawl the whole catalog every time :-) # Quick search interface If you need to search our catalog (e.g. to align it with yours), we're providing you with a handy interface accessible here: https://api.globalwinescore.com/search/ You need to be logged in (email/password) to access this page, but other than that you can share it with anyone in your team and start searching right away ! # Resources The details about available endpoints can be found below. You can click on each endpoint to find information about their parameters.
# Intoduction This is the OpenAPI V3 documentation for https://api.goog.io An API to perform Google Searches. Extremely fast and accurate. Zero proxies. Clean USA IPs. Simple to use API, but advance enough to support special parameters such as languages, country and geographic locality. Googio is the ultimate search API for Google Searches, Google News, and Google SERP. # Docs > An Unofficial Google Search API An API to perform Google Searches. Extremely fast and accurate. Zero proxies. Clean USA IPs. Simple to use API, but advance enough to support special parameters such as languages, country and geographic locality. # Example Code Check out [Github repo](https://github.com/googio/googio_examples) for example code for calling the API with various languages. # Authentication ### API Key Optional API key for authenticated access. Note that we use "API key" interchangably in these docs. Authenticated requests must include an `apikey` header containing your subscription's API Key. | Security Schema Type | Header Name | Example Token | | --- | --- | --- | | API Key | `apikey` | c5bfb018-ab46-4e61-9271-4ec7e9c04a6e | In the following example, `YOU_APIKEY` represents the auth token for your account. ``` curl --header 'apikey: YOU_APIKEY' ``` You can view and manage your API keys in the [Dashboard](/dashboard). Be sure to keep your API keys secure. Do not share them in publicly accessible areas such as GitHub, client-side code, and so forth. Also note that all API requests must be made over **HTTPS**. Calls made over plain HTTP will attempt to be automatically upgraded to HTTPS, though this use cases is discouraged. ## Rate Limits API requests may be rate limited depending on your subscription plan and traffic patterns. The following response headers will be present in these cases: | Header | Description | | ------ | ----------- | | `X-RateLimit-Limit` | The maximum number of requests that the consumer is permitted to make. | | `X-RateLimit-Remaining` | The number of requests remaining in the current rate limit window. | | `X-RateLimit-Reset` | The time at which the current rate limit window resets in UTC epoch seconds. | When the rate limit is **exceeded**, an error is returned with the status "**429 Too Many Requests**": ```json { "error": { "code": "too_many_requests", "message": "Rate limit exceeded" } } ``` ## Errors This API uses conventional HTTP response codes to indicate the success or failure of API requests. In general: Codes in the `2xx` range indicate success. Codes in the `4xx` range indicate an error that failed given the information provided (e.g., a required parameter was omitted, endpoint not found, etc.). Codes in the `5xx` range indicate an error with our API (these are rare).