API Documentation

Welcome to the Silaar API documentation. Our API is optimized for reliability and speed, providing 1:1 compatibility with legacy PHP endpoints while running on a modern Node.js architecture.

Base URL: https://api.silaar.com/api

Authentication

Access to the API requires a private API key. This key must be sent in every request header.

Header Required Value
X-Silaar-Key YOUR_PRIVATE_API_KEY 
curl -X GET "https://api.silaar.com/api/textsearch.php?keyWord=iphone" \
     -H "X-Silaar-Key: YOUR_API_KEY"

Rate Limits & Quota

Monitor your consumption via standard response headers. Each request deducts from your daily and monthly quota based on your plan.

Header Description
X-RateLimit-Daily-Limit Max requests allowed per 24 hours.
X-RateLimit-Daily-Remaining Requests remaining for today.
X-RateLimit-Daily-Used Total requests consumed today.
X-RateLimit-Requests-Reset Seconds remaining until quota reset.

Usage Tips & Pacing

To avoid hitting limits prematurely, distribute your traffic evenly throughout the day.

💡 Mathematical Pacing Strategy

Formula: Daily Quota / 24 Hours / 60 Minutes

Example for 1,000 requests/day: 1 request every 87 seconds.

Text Search API

Search global marketplace products using keywords. Supports advanced sorting and localization.

GET /textsearch.php

Parameters

Parameter Type Default Description
keyWordRequired string - The keyword to search for.
country string FR ISO Country Code.
currency string USD Currency code.
lang string en Language code (en, fr, ar, etc.).
categoryId string - Filter by specific Category ID.
pageSize number 20 Number of results per page.
pageIndex number 1 Page number.
filter string orders Sort by: orders, price, total_sales.
sortBy string asc Sort direction: asc, desc.

Image Search API

Search products by providing a hosted image URL. The system processes the image to find exact or similar matches.

GET /imageurl_search.php

Parameters

Parameter Type Default Description
imgUrlRequired string - Direct URL to the image.
country string FR Target shipping country.
targetCurrency string USD Result currency.
sort string orders Sort by: orders, min_price.

Product Details

Get comprehensive data for a single marketplace product.

GET /getproduct.php

Parameters

Parameter Type Default Description
productIdRequired string - Global Marketplace Product ID.
country string US Ship-to country code.
currency string USD Target currency.
lang string en Target language.

Product Reviews

Fetch real-time product reviews and ratings directly from source servers.

GET /getreviews.php

Parameters

Parameter Type Default Description
productIdRequired string - Global Marketplace Product ID.
page number 1 Page number of reviews.
pageSize number 20 Number of reviews per page.
filter string all Filter: all, image, additional, local.
sort string complex_default Sort: complex_default, date_desc.
lang string ar_DZ Display language.
country string DZ Target country context.

Response Structure

{
  "status": {
    "code": 200,
    "data": "success"
  },
  "data": {
    "productId": "100500...",
    "total": 803,
    "totalPages": 41,
    "statistics": {
      "averageStar": 4.6,
      "positiveRate": 88.4,
      "stars": {
        "5": { "count": 671, "rate": 83.4 },
        "4": { "count": 41, "rate": 5.1 },
        "3": { "count": 24, "rate": 3.0 },
        "2": { "count": 15, "rate": 1.9 },
        "1": { "count": 54, "rate": 6.6 }
      }
    },
    "reviews": [
      {
        "id": "30098533145793583",
        "buyer": {
          "name": "A***o",
          "country": "UA",
          "avatar": "https://...",
          "anonymous": false
        },
        "rating": 5,
        "date": "06 Jan 2026",
        "content": "Cool case...",
        "skuInfo": "Color:WHITE",
        "images": ["https://..."],
        "upVotes": 12
      }
    ]
  }
}

Similar Products

Fetches products similar to a target product ID using image-matching logic.

GET /getproduct/similar.php

Parameters

Parameter Type Description
productIdRequired string ID of the source product.

Hot Products

Get trending and high-conversion products.

GET /affiliate-hot-products.php

Shipping Information

Get precise shipping rates and delivery estimates for specific items and locations.

GET /getshipping.php

Parameters

Parameter Type Default Description
productIdRequired string - Global Marketplace Product ID.
selectedSkuIdsRequired string - Specific SKU variants (Color/Size).
quantity number 1 Number of items to ship.
lang string en_US Display language.
country string FR Destination country code.
currency string USD Target currency.
welcomedeal boolean false Apply welcome deal logic.

Order Management

Programmatically create orders on supported marketplaces. This endpoint allows for automated purchasing through your linked account.

POST /createorder.php

Request Body (JSON)

{
  "logistics_address": {
    "contact_person": "John Doe",
    "address_line1": "123 Street Name",
    "city": "Paris",
    "country": "FR",
    "zip": "75001",
    "mobile": "33612345678"
  },
  "product_items": [
    {
      "product_id": "100500123",
      "sku_id": "120000345",
      "quantity": 1
    }
  ]
}

Categories

Explore the global category tree. Useful for building navigation or mapping your local product categories.

GET /getcategory.php

Parameters

Parameter Type Default Description
categoryId string 0 Parent Category ID (0 for root).
lang string en Translation language.

Countries & Regions

Retrieve a full list of supported countries, their ISO codes, native currencies, and available languages. This is essential for configuring the shipTo and currency parameters in other endpoints.

GET /list_country&region.json

Response Structure

Returns a comprehensive JSON array containing:

[
  {
    "name": "Saudi Arabia",
    "code": "SA",
    "currency": "SAR",
    "languages": ["ar", "en"]
  },
  {
    "name": "United States",
    "code": "US",
    "currency": "USD",
    "languages": ["en"]
  }
]