aligate
Real-time AliExpress data parser covering products, product reviews, sellers, store coupons, a seller's product catalog, product shipping, product descriptions, 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. Shipping: shipping methods for a product with cost, carrier, and delivery estimate. Description: a product's long-form description on its own - HTML, plain text, and the images extracted from the description gallery. 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 project:
- API version: 2.6.1
- Package version: 2.6.1
- 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:
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:
import aligate
Setuptools
Install via Setuptools.
python setup.py install --user
(or sudo python setup.py install to install the package for all users)
Then import the package:
import aligate
Tests
Execute pytest to run the tests.
Getting Started
Please follow the installation procedure and then run the following:
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)
try:
# Get Description
api_response = api_instance.get_description(product_id, country, currency, locale=locale)
print("The response of DefaultApi->get_description:\n")
pprint(api_response)
except ApiException as e:
print("Exception when calling DefaultApi->get_description: %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_description | GET /api/v2/product/description | Get Description |
| DefaultApi | get_product_info | GET /api/v2/product | Get Product Info |
| DefaultApi | get_product_reviews | GET /api/v2/product/reviews | Get Product Reviews |
| DefaultApi | get_seller_coupons | GET /api/v2/seller/coupons | Get Seller Coupons |
| DefaultApi | get_seller_info | GET /api/v2/seller | Get Seller Info |
| DefaultApi | get_seller_products | GET /api/v2/seller/products | Get Seller Products |
| DefaultApi | get_shipping_info | GET /api/v2/product/shipping-h5 | Get Shipping Info |
| DefaultApi | health_check | GET /api/v2/health | Health check |
| DefaultApi | search_by_image | POST /api/v2/search/image | Search By Image |
| DefaultApi | search_by_image_url | GET /api/v2/search/image | Search By Image URL |
| DefaultApi | search_by_text | GET /api/v2/search/text | Search By Text |
Documentation For Models
- ConfigurationPrice
- ConfigurationProperty
- Coupon
- CouponMeta
- CouponSettings
- CouponsParseResponse
- DescriptionParseResponse
- DescriptionSettings
- Error
- HealthCheck200Response
- ImageSearchMeta
- ImageSearchParseResponse
- ImageSearchRequest
- ImageSearchSettings
- ParseMeta
- ParseResponse
- ParseSettings
- Price
- Product
- ProductConfiguration
- ProductDescription
- ProductSeller
- ProductVideo
- RatingBreakdown
- Review
- ReviewBuyer
- ReviewContent
- ReviewFilterStat
- ReviewLabel
- ReviewsMeta
- ReviewsParseResponse
- ReviewsResult
- ReviewsSettings
- SearchCategory
- SearchMeta
- SearchParseResponse
- SearchResult
- SearchSettings
- SellerItem
- SellerMeta
- SellerParseResponse
- SellerProductsMeta
- SellerProductsParseResponse
- SellerProductsResult
- SellerProductsSettings
- SellerSettings
- ShippingMethod
- ShippingParseResponse
- ShippingSettings
- StoreCategory
Documentation For Authorization
Endpoints do not require authorization.
Author
Release files for aligate 2.6.1
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| aligate-2.6.1.tar.gz | 61.6 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| aligate-2.6.1-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 188.0 kB
Release files / aligate-2.6.1.tar.gz
| Download URL | aligate-2.6.1.tar.gz |
|---|---|
| Size | 61.6 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
16b424d157acc52a4e32ed015143599c744e07c1b36f41fe07e0f0cd60bc2172
|
|
BLAKE2b-256 checksum How to use checksums |
eec83941b84559cfaf438434efc1413242ffa74c4e2983204ef8d5386ec78236
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Aug 14, 2026.
Transparency logRelease files / aligate-2.6.1-py3-none-any.whl
| Download URL | aligate-2.6.1-py3-none-any.whl |
|---|---|
| Size | 126.4 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
2e442ddac250d3c9180ffb6340efee32bd55cc288328c720863fad1745c2f5f8
|
|
BLAKE2b-256 checksum How to use checksums |
6f2a071669df30338d6aec3528259b07ccb28e101547546fd78107a4064090b0
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Aug 14, 2026.
Transparency log