Metadata-Version: 2.4
Name: aligate
Version: 2.1.0
Summary: AliExpress Parser API
Home-page: https://github.com/aligate-io/aliexpress-api
Author: OpenAPI Generator community
Author-email: OpenAPI Generator Community <team@openapitools.org>
Project-URL: Repository, https://github.com/GIT_USER_ID/GIT_REPO_ID
Keywords: OpenAPI,OpenAPI-Generator,AliExpress Parser API
Requires-Python: >=3.9
Description-Content-Type: text/markdown
Requires-Dist: urllib3<3.0.0,>=2.1.0
Requires-Dist: python-dateutil>=2.8.2
Requires-Dist: pydantic>=2.11
Requires-Dist: typing-extensions>=4.7.1
Dynamic: author
Dynamic: home-page

# aligate
Real-time AliExpress data parser covering products, product reviews, sellers, store
coupons, a seller's product catalog, and product search by text or image.
Products: pricing, stock status, shipping options, seller information, product
configurations (SKUs), and more - scoped to a specific country and currency.
Reviews: customer ratings and feedback for a product.
Sellers: full store profile with ratings, feedback, and categories.
Coupons: active seller coupon codes with discounts, thresholds, budgets, and expiry.
Seller products: a store's product catalog, paginated and best-selling first.
Search: find products by keyword or by uploading an image, returning paginated product
results with their categories.


This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:

- API version: 2.1
- Package version: 2.1.0
- Generator version: 7.23.0
- Build package: org.openapitools.codegen.languages.PythonClientCodegen

## Requirements.

Python 3.10+

## Installation & Usage
### pip install

If the python package is hosted on a repository, you can install directly using:

```sh
pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git
```
(you may need to run `pip` with root permission: `sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git`)

Then import the package:
```python
import aligate
```

### Setuptools

Install via [Setuptools](http://pypi.python.org/pypi/setuptools).

```sh
python setup.py install --user
```
(or `sudo python setup.py install` to install the package for all users)

Then import the package:
```python
import aligate
```

### Tests

Execute `pytest` to run the tests.

## Getting Started

Please follow the [installation procedure](#installation--usage) and then run the following:

```python

import aligate
from aligate.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://aligate-aliexpress-data-api.p.rapidapi.com
# See configuration.py for a list of all supported configuration parameters.
configuration = aligate.Configuration(
    host = "https://aligate-aliexpress-data-api.p.rapidapi.com"
)



# Enter a context with an instance of the API client
with aligate.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = aligate.DefaultApi(api_client)
    product_id = 1005004530469845 # int | AliExpress product ID, taken from the product page URL.
    country = 'PL' # str | Country code (ISO 3166-1 alpha-2) used for pricing and shipping eligibility.
    currency = 'PLN' # str | Currency code (ISO 4217) for the returned prices.
    locale = en_US # str | Response language locale. (optional) (default to en_US)
    with_welcome_discount = False # bool | Apply the new-buyer welcome discount to the returned price. (optional) (default to False)
    with_description = False # bool | Fetch the full product description (formatted HTML, plain text, and image gallery), returned in the `description` field. Note: enabling this adds approximately 600-750 ms to the response time.  (optional) (default to False)

    try:
        # Get Product Info
        api_response = api_instance.get_product_info(product_id, country, currency, locale=locale, with_welcome_discount=with_welcome_discount, with_description=with_description)
        print("The response of DefaultApi->get_product_info:\n")
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling DefaultApi->get_product_info: %s\n" % e)

```

## Documentation for API Endpoints

All URIs are relative to *https://aligate-aliexpress-data-api.p.rapidapi.com*

Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*DefaultApi* | [**get_product_info**](docs/DefaultApi.md#get_product_info) | **GET** /api/v2/product | Get Product Info
*DefaultApi* | [**get_product_reviews**](docs/DefaultApi.md#get_product_reviews) | **GET** /api/v2/product/reviews | Get Product Reviews
*DefaultApi* | [**get_seller_coupons**](docs/DefaultApi.md#get_seller_coupons) | **GET** /api/v2/seller/coupons | Get Seller Coupons
*DefaultApi* | [**get_seller_info**](docs/DefaultApi.md#get_seller_info) | **GET** /api/v2/seller | Get Seller Info
*DefaultApi* | [**get_seller_products**](docs/DefaultApi.md#get_seller_products) | **GET** /api/v2/seller/products | Get Seller Products
*DefaultApi* | [**health_check**](docs/DefaultApi.md#health_check) | **GET** /api/v2/health | Health check
*DefaultApi* | [**search_by_image**](docs/DefaultApi.md#search_by_image) | **POST** /api/v2/search/image | Search By Image
*DefaultApi* | [**search_by_text**](docs/DefaultApi.md#search_by_text) | **GET** /api/v2/search/text | Search By Text


## Documentation For Models

 - [ConfigurationPrice](docs/ConfigurationPrice.md)
 - [ConfigurationProperty](docs/ConfigurationProperty.md)
 - [Coupon](docs/Coupon.md)
 - [CouponMeta](docs/CouponMeta.md)
 - [CouponSettings](docs/CouponSettings.md)
 - [CouponsParseResponse](docs/CouponsParseResponse.md)
 - [Error](docs/Error.md)
 - [HealthCheck200Response](docs/HealthCheck200Response.md)
 - [ImageSearchMeta](docs/ImageSearchMeta.md)
 - [ImageSearchParseResponse](docs/ImageSearchParseResponse.md)
 - [ImageSearchRequest](docs/ImageSearchRequest.md)
 - [ImageSearchSettings](docs/ImageSearchSettings.md)
 - [ParseMeta](docs/ParseMeta.md)
 - [ParseResponse](docs/ParseResponse.md)
 - [ParseSettings](docs/ParseSettings.md)
 - [Price](docs/Price.md)
 - [Product](docs/Product.md)
 - [ProductConfiguration](docs/ProductConfiguration.md)
 - [ProductDescription](docs/ProductDescription.md)
 - [ProductSeller](docs/ProductSeller.md)
 - [ProductVideo](docs/ProductVideo.md)
 - [RatingBreakdown](docs/RatingBreakdown.md)
 - [Review](docs/Review.md)
 - [ReviewBuyer](docs/ReviewBuyer.md)
 - [ReviewContent](docs/ReviewContent.md)
 - [ReviewFilterStat](docs/ReviewFilterStat.md)
 - [ReviewLabel](docs/ReviewLabel.md)
 - [ReviewsMeta](docs/ReviewsMeta.md)
 - [ReviewsParseResponse](docs/ReviewsParseResponse.md)
 - [ReviewsResult](docs/ReviewsResult.md)
 - [ReviewsSettings](docs/ReviewsSettings.md)
 - [SearchCategory](docs/SearchCategory.md)
 - [SearchMeta](docs/SearchMeta.md)
 - [SearchParseResponse](docs/SearchParseResponse.md)
 - [SearchResult](docs/SearchResult.md)
 - [SearchSettings](docs/SearchSettings.md)
 - [SellerItem](docs/SellerItem.md)
 - [SellerMeta](docs/SellerMeta.md)
 - [SellerParseResponse](docs/SellerParseResponse.md)
 - [SellerProductsMeta](docs/SellerProductsMeta.md)
 - [SellerProductsParseResponse](docs/SellerProductsParseResponse.md)
 - [SellerProductsResult](docs/SellerProductsResult.md)
 - [SellerProductsSettings](docs/SellerProductsSettings.md)
 - [SellerSettings](docs/SellerSettings.md)
 - [ShippingMethod](docs/ShippingMethod.md)
 - [StoreCategory](docs/StoreCategory.md)


<a id="documentation-for-authorization"></a>
## Documentation For Authorization

Endpoints do not require authorization.


## Author




