aligate 2.1.1

AliExpress Parser API

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 project:

• API version: 2.1.1
• Package version: 2.1.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)
    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	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	health_check	GET /api/v2/health	Health check
DefaultApi	search_by_image	POST /api/v2/search/image	Search By Image
DefaultApi	search_by_text	GET /api/v2/search/text	Search By Text

Documentation For Models

• ConfigurationPrice
• ConfigurationProperty
• Coupon
• CouponMeta
• CouponSettings
• CouponsParseResponse
• 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
• StoreCategory

Documentation For Authorization

Endpoints do not require authorization.

Author