{
  "openapi": "3.0.1",
  "info": {
    "title": "Jumia Scraper",
    "description": "Jumia products by keyword or category across 8 African markets: Morocco, Ivory Coast, Senegal, Nigeria, Kenya, Egypt, Ghana, Uganda. Price, discount, rating, stock, seller and specs, 40 products per request, compared between runs. Example: 'samsung', Morocco, 100 products in under a minute.",
    "version": "1.1",
    "x-build-id": "kryaxCjKC7PksAAfJ"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/badr_xba~jumia-scraper/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-badr_xba-jumia-scraper",
        "x-openai-isConsequential": false,
        "summary": "Executes an Actor, waits for its completion, and returns Actor's dataset items in response.",
        "tags": [
          "Run Actor"
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/inputSchema"
              }
            }
          }
        },
        "parameters": [
          {
            "name": "token",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            },
            "description": "Enter your Apify token here"
          }
        ],
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    },
    "/acts/badr_xba~jumia-scraper/runs": {
      "post": {
        "operationId": "runs-sync-badr_xba-jumia-scraper",
        "x-openai-isConsequential": false,
        "summary": "Executes an Actor and returns information about the initiated run in response.",
        "tags": [
          "Run Actor"
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/inputSchema"
              }
            }
          }
        },
        "parameters": [
          {
            "name": "token",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            },
            "description": "Enter your Apify token here"
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/runsResponseSchema"
                }
              }
            }
          }
        }
      }
    },
    "/acts/badr_xba~jumia-scraper/run-sync": {
      "post": {
        "operationId": "run-sync-badr_xba-jumia-scraper",
        "x-openai-isConsequential": false,
        "summary": "Executes an Actor, waits for completion, and returns the OUTPUT from Key-value store in response.",
        "tags": [
          "Run Actor"
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/inputSchema"
              }
            }
          }
        },
        "parameters": [
          {
            "name": "token",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            },
            "description": "Enter your Apify token here"
          }
        ],
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    }
  },
  "components": {
    "schemas": {
      "inputSchema": {
        "type": "object",
        "properties": {
          "countries": {
            "title": "🌍 Countries",
            "type": "array",
            "description": "Jumia sites where keyword searches run. Pick one, several or all. Start URLs always use their own domain, so you don't need to pick a country for them. Via the API, codes (\"ma\"), names (\"Nigeria\") or domains (\"jumia.co.ke\") are all accepted.",
            "items": {
              "type": "string",
              "enum": [
                "ma",
                "ci",
                "sn",
                "ng",
                "ke",
                "eg",
                "gh",
                "ug"
              ],
              "enumTitles": [
                "Morocco (jumia.ma)",
                "Côte d'Ivoire (jumia.ci)",
                "Senegal (jumia.sn)",
                "Nigeria (jumia.com.ng)",
                "Kenya (jumia.co.ke)",
                "Egypt (jumia.com.eg)",
                "Ghana (jumia.com.gh)",
                "Uganda (jumia.ug)"
              ]
            },
            "default": [
              "ma"
            ]
          },
          "searchQueries": {
            "title": "🔎 Keywords",
            "type": "array",
            "description": "Keywords such as <code>bluetooth headphones</code> or <code>iphone 15</code>. One per line — or paste a comma-separated list into one line, it is split for you. They go through Jumia's official keyword pages (/slp/…, allowed to robots): up to about 40 products per keyword and country. For more volume, use category URLs. Leave Keywords and Start URLs empty to run a small demo.",
            "items": {
              "type": "string"
            }
          },
          "matchKeyword": {
            "title": "Keep only products matching the keyword",
            "type": "boolean",
            "description": "Jumia serves a page even for a keyword it does not know, filled with unrelated products. On, the Actor drops them (you don't pay for them) and reports the keyword in FAILED_INPUTS. Off to take the whole page as it is.",
            "default": true
          },
          "startUrls": {
            "title": "🔗 Start URLs",
            "type": "array",
            "description": "Jumia category URLs (recommended, e.g. <code>https://www.jumia.ma/telephone-tablette/</code> — up to 50 pages of 40 products) or product page URLs (e.g. <code>https://www.jumia.com.ng/…-mpg11965909.html</code>), from any of the 8 countries. Copy them straight from your browser: tracking parameters (utm_…, fbclid), a missing https:// or several URLs pasted in one line are cleaned up for you. A Jumia search URL (/catalog/?q=…) is turned into the matching keyword; sort URLs are skipped because Jumia disallows them to robots. Anything unusable is listed in FAILED_INPUTS and never billed.",
            "items": {
              "type": "object",
              "required": [
                "url"
              ],
              "properties": {
                "url": {
                  "type": "string",
                  "title": "URL of a web page",
                  "format": "uri"
                }
              }
            }
          },
          "maxItems": {
            "title": "💯 Maximum products per country",
            "minimum": 1,
            "type": "integer",
            "description": "Hard cap on saved products for each country, across keywords and URLs — you never pay for more. With 3 countries and 100 products you get up to 300 rows. Start small (20) to try the Actor for a few cents.",
            "default": 100
          },
          "maxPagesPerQuery": {
            "title": "📄 Maximum pages per category",
            "minimum": 1,
            "maximum": 50,
            "type": "integer",
            "description": "Pages read for each category URL — about 40 products per page, 50 pages maximum on Jumia.",
            "default": 5
          },
          "scrapeProductDetails": {
            "title": "📝 Scrape product pages",
            "type": "boolean",
            "description": "Opens each product page for the description, every image, the seller and seller score, stock, condition, breadcrumbs and specifications. One extra request per product (slower).",
            "default": false
          },
          "minPrice": {
            "title": "Minimum price",
            "minimum": 0,
            "type": "integer",
            "description": "Keep only products at this price or above, in the site currency (MAD, NGN, KES, EGP…)."
          },
          "maxPrice": {
            "title": "Maximum price",
            "minimum": 0,
            "type": "integer",
            "description": "Keep only products at this price or below, in the site currency."
          },
          "minDiscountPercent": {
            "title": "Minimum discount (%)",
            "minimum": 0,
            "maximum": 100,
            "type": "integer",
            "description": "Keep only products discounted by at least this much, e.g. 30."
          },
          "onlyInStock": {
            "title": "In stock only",
            "type": "boolean",
            "description": "Drops products marked as out of stock.",
            "default": false
          },
          "categoryKeywords": {
            "title": "Category contains",
            "type": "array",
            "description": "Keep only products whose category contains one of these words. Accents and case are ignored.",
            "items": {
              "type": "string"
            }
          },
          "nameKeywords": {
            "title": "Name contains",
            "type": "array",
            "description": "Keep only products whose name contains one of these words.",
            "items": {
              "type": "string"
            }
          },
          "excludeKeywords": {
            "title": "Name excludes",
            "type": "array",
            "description": "Exclude products whose name contains one of these words, e.g. case, refurbished.",
            "items": {
              "type": "string"
            }
          },
          "trackPriceChanges": {
            "title": "Track prices between runs",
            "type": "boolean",
            "description": "Remembers each product's price and stock, so the next run fills previousPrice, priceChange, priceChangePercent, isNewProduct and stockChanged.",
            "default": true
          },
          "onlyChangedProducts": {
            "title": "Only changed products",
            "type": "boolean",
            "description": "Saves only new products and products whose price or stock moved since the last run. Ideal for a daily watch: you pay for the changes, not the whole list.",
            "default": false
          },
          "sendEmailAlerts": {
            "title": "Send e-mail alerts",
            "type": "boolean",
            "description": "Sends price drops and back-in-stock products to your Apify account e-mail. Requires full permissions — see the FAQ. Changes are always in the dataset anyway.",
            "default": false
          },
          "alertMinPriceDropPercent": {
            "title": "Minimum drop to alert (%)",
            "minimum": 1,
            "maximum": 100,
            "type": "integer",
            "description": "Only price drops of at least this size trigger an alert.",
            "default": 10
          },
          "alertBackInStock": {
            "title": "Alert on back in stock",
            "type": "boolean",
            "description": "Alerts when a product is available again.",
            "default": true
          },
          "alertNewProducts": {
            "title": "Alert on new products",
            "type": "boolean",
            "description": "Alerts when a product appears for the first time. On the very first run every product is new.",
            "default": false
          },
          "includeReviews": {
            "title": "Get customer reviews",
            "type": "boolean",
            "description": "Adds rating, title, text, date and verified-purchase flag. Reviewer names are never collected. One extra request per 10 reviews.",
            "default": false
          },
          "maxReviewsPerProduct": {
            "title": "Maximum reviews per product",
            "minimum": 1,
            "maximum": 500,
            "type": "integer",
            "description": "How many reviews to read per product, most recent first.",
            "default": 20
          },
          "botContact": {
            "title": "Bot contact",
            "type": "string",
            "description": "A URL or e-mail put in the User-Agent so Jumia can identify the crawler, as its robots.txt asks. Left empty, the Actor's own page is used."
          },
          "maxRequestsPerMinute": {
            "title": "Requests per minute",
            "minimum": 1,
            "maximum": 190,
            "type": "integer",
            "description": "Crawling speed. Jumia's robots.txt allows an identified bot fewer than 200 requests per minute, so this is capped at 190.",
            "default": 180
          },
          "proxyConfiguration": {
            "title": "Proxy",
            "type": "object",
            "description": "No proxy by default: Jumia allows identified crawlers. If you ever get blocked, Apify datacenter proxy is enough — no need for residential.",
            "default": {
              "useApifyProxy": false
            }
          }
        }
      },
      "runsResponseSchema": {
        "type": "object",
        "properties": {
          "data": {
            "type": "object",
            "properties": {
              "id": {
                "type": "string"
              },
              "actId": {
                "type": "string"
              },
              "userId": {
                "type": "string"
              },
              "startedAt": {
                "type": "string",
                "format": "date-time",
                "example": "2025-01-08T00:00:00.000Z"
              },
              "finishedAt": {
                "type": "string",
                "format": "date-time",
                "example": "2025-01-08T00:00:00.000Z"
              },
              "status": {
                "type": "string",
                "example": "READY"
              },
              "meta": {
                "type": "object",
                "properties": {
                  "origin": {
                    "type": "string",
                    "example": "API"
                  },
                  "userAgent": {
                    "type": "string"
                  }
                }
              },
              "stats": {
                "type": "object",
                "properties": {
                  "inputBodyLen": {
                    "type": "integer",
                    "example": 2000
                  },
                  "rebootCount": {
                    "type": "integer",
                    "example": 0
                  },
                  "restartCount": {
                    "type": "integer",
                    "example": 0
                  },
                  "resurrectCount": {
                    "type": "integer",
                    "example": 0
                  },
                  "computeUnits": {
                    "type": "integer",
                    "example": 0
                  }
                }
              },
              "options": {
                "type": "object",
                "properties": {
                  "build": {
                    "type": "string",
                    "example": "latest"
                  },
                  "timeoutSecs": {
                    "type": "integer",
                    "example": 300
                  },
                  "memoryMbytes": {
                    "type": "integer",
                    "example": 1024
                  },
                  "diskMbytes": {
                    "type": "integer",
                    "example": 2048
                  }
                }
              },
              "buildId": {
                "type": "string"
              },
              "defaultKeyValueStoreId": {
                "type": "string"
              },
              "defaultDatasetId": {
                "type": "string"
              },
              "defaultRequestQueueId": {
                "type": "string"
              },
              "buildNumber": {
                "type": "string",
                "example": "1.0.0"
              },
              "containerUrl": {
                "type": "string"
              },
              "usage": {
                "type": "object",
                "properties": {
                  "ACTOR_COMPUTE_UNITS": {
                    "type": "integer",
                    "example": 0
                  },
                  "DATASET_READS": {
                    "type": "integer",
                    "example": 0
                  },
                  "DATASET_WRITES": {
                    "type": "integer",
                    "example": 0
                  },
                  "KEY_VALUE_STORE_READS": {
                    "type": "integer",
                    "example": 0
                  },
                  "KEY_VALUE_STORE_WRITES": {
                    "type": "integer",
                    "example": 1
                  },
                  "KEY_VALUE_STORE_LISTS": {
                    "type": "integer",
                    "example": 0
                  },
                  "REQUEST_QUEUE_READS": {
                    "type": "integer",
                    "example": 0
                  },
                  "REQUEST_QUEUE_WRITES": {
                    "type": "integer",
                    "example": 0
                  },
                  "DATA_TRANSFER_INTERNAL_GBYTES": {
                    "type": "integer",
                    "example": 0
                  },
                  "DATA_TRANSFER_EXTERNAL_GBYTES": {
                    "type": "integer",
                    "example": 0
                  },
                  "PROXY_RESIDENTIAL_TRANSFER_GBYTES": {
                    "type": "integer",
                    "example": 0
                  },
                  "PROXY_SERPS": {
                    "type": "integer",
                    "example": 0
                  },
                  "PROXY_UNBLOCKER_UNITS": {
                    "type": "integer",
                    "example": 0
                  }
                }
              },
              "usageTotalUsd": {
                "type": "number",
                "example": 0.00005
              },
              "usageUsd": {
                "type": "object",
                "properties": {
                  "ACTOR_COMPUTE_UNITS": {
                    "type": "integer",
                    "example": 0
                  },
                  "DATASET_READS": {
                    "type": "integer",
                    "example": 0
                  },
                  "DATASET_WRITES": {
                    "type": "integer",
                    "example": 0
                  },
                  "KEY_VALUE_STORE_READS": {
                    "type": "integer",
                    "example": 0
                  },
                  "KEY_VALUE_STORE_WRITES": {
                    "type": "number",
                    "example": 0.00005
                  },
                  "KEY_VALUE_STORE_LISTS": {
                    "type": "integer",
                    "example": 0
                  },
                  "REQUEST_QUEUE_READS": {
                    "type": "integer",
                    "example": 0
                  },
                  "REQUEST_QUEUE_WRITES": {
                    "type": "integer",
                    "example": 0
                  },
                  "DATA_TRANSFER_INTERNAL_GBYTES": {
                    "type": "integer",
                    "example": 0
                  },
                  "DATA_TRANSFER_EXTERNAL_GBYTES": {
                    "type": "integer",
                    "example": 0
                  },
                  "PROXY_RESIDENTIAL_TRANSFER_GBYTES": {
                    "type": "integer",
                    "example": 0
                  },
                  "PROXY_SERPS": {
                    "type": "integer",
                    "example": 0
                  },
                  "PROXY_UNBLOCKER_UNITS": {
                    "type": "integer",
                    "example": 0
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}