{
  "openapi": "3.0.1",
  "info": {
    "title": "Jumia Products Scraper",
    "description": "The whole Jumia catalogue of a country through its sitemaps: hundreds of thousands of products with price, discount, stock, brand, seller and specs. Incremental mode reopens only what changed, so a daily refresh takes minutes not hours. Example: Morocco, 1,000 products, then schedule it.",
    "version": "1.1",
    "x-build-id": "UfNBQT0paa5jvtR85"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/badr_xba~jumia-products-scraper/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-badr_xba-jumia-products-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-products-scraper/runs": {
      "post": {
        "operationId": "runs-sync-badr_xba-jumia-products-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-products-scraper/run-sync": {
      "post": {
        "operationId": "run-sync-badr_xba-jumia-products-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 to collect — every category is walked for you, no URL needed. Via the API, codes (\"ma\"), names (\"Nigeria\") or domains (\"jumia.co.ke\") are all accepted. Approximate catalogue sizes: Morocco ~310,000 products, Côte d'Ivoire ~440,000, Senegal ~100,000, Nigeria ~390,000, Kenya ~1,100,000, Egypt ~590,000, Ghana ~100,000, Uganda ~260,000.",
            "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"
            ]
          },
          "maxItems": {
            "title": "💯 Maximum products per country",
            "minimum": 0,
            "type": "integer",
            "description": "Exact cap on saved products for each country — you never pay for more. Try 50 first (a few cents); 500 products take under a minute in the default mode. Set 0 to collect the WHOLE catalogue (a long run: give it more timeout and 1 GB of memory).",
            "default": 500
          },
          "readFrom": {
            "title": "Where to read the products",
            "enum": [
              "listings",
              "productPages"
            ],
            "type": "string",
            "description": "Jumia allows a bot fewer than 200 requests per minute, so speed comes from asking for less, not faster. A catalogue page hands over 40 products in one request; a product page hands over one, with its description, specifications, seller and every image. Pick what your work actually needs.",
            "default": "listings"
          },
          "maxPagesPerCategory": {
            "title": "Maximum pages per category",
            "minimum": 1,
            "maximum": 50,
            "type": "integer",
            "description": "Catalogue pages only. Jumia serves at most 50 pages per category, which is 2,000 products.",
            "default": 50
          },
          "onlyUpdatedSinceLastRun": {
            "title": "Incremental resume",
            "type": "boolean",
            "description": "Jumia dates every product. On, the Actor only reopens products modified since the previous complete run: a daily refresh takes minutes instead of hours. The first run reads everything and remembers the reference date.",
            "default": false
          },
          "updatedSince": {
            "title": "Modified since",
            "type": "string",
            "description": "A date such as 2026-09-01 (2026/09/01 or 01/09/2026 also work) to reread only what Jumia touched since then. Takes precedence over the incremental resume."
          },
          "listUrlsOnly": {
            "title": "List URLs without opening pages",
            "type": "boolean",
            "description": "Produces a catalogue index — URL, product ID, modification date, country — without loading a single product page. The cheapest way to size a catalogue or watch for new products. Each URL is one result.",
            "default": false
          },
          "sampleEveryNth": {
            "title": "Sample one product in N",
            "minimum": 1,
            "maximum": 1000,
            "type": "integer",
            "description": "Product pages mode. 10 means one product out of ten — to study a catalogue of hundreds of thousands of items without reading it all.",
            "default": 1
          },
          "brandKeywords": {
            "title": "Brand contains",
            "type": "array",
            "description": "Keep only products whose brand contains one of these words, e.g. samsung, apple. One per line, or a comma-separated list in one line. Accents and case are ignored.",
            "items": {
              "type": "string"
            }
          },
          "prefilterByUrl": {
            "title": "Search keywords in the URL first",
            "type": "boolean",
            "description": "Product pages mode. A Jumia product URL contains its name, so usually its brand. On, the Actor only opens pages whose address carries one of your brand or name keywords, which makes a brand search a hundred times faster. Off to open every page at the cost of a very long run.",
            "default": true
          },
          "sellerKeywords": {
            "title": "Seller contains",
            "type": "array",
            "description": "Keep only products sold by a seller whose name contains one of these words. The seller name exists on product pages only: use it with Product pages mode.",
            "items": {
              "type": "string"
            }
          },
          "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, e.g. phones, televisions.",
            "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 catalogue.",
            "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, all countries together. 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 and asks bots not to spread over many IP addresses. 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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}