{
  "openapi": "3.0.1",
  "info": {
    "title": "Jumia Africa Catalog & Flash Deals Extractor",
    "description": "Search, browse categories, or pull today's flash deals from Jumia across Nigeria, Kenya, Ghana, Egypt, South Africa, Morocco, Senegal, Cameroon, Tanzania, and Uganda, with price, discount, rating, and seller per product.",
    "version": "1.0",
    "x-build-id": "Vgahsz2izw1JoWvRD"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/nimbryxo-studio~jumia-africa-catalog-and-flash-deals-extractor/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-nimbryxo-studio-jumia-africa-catalog-and-flash-deals-extractor",
        "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/nimbryxo-studio~jumia-africa-catalog-and-flash-deals-extractor/runs": {
      "post": {
        "operationId": "runs-sync-nimbryxo-studio-jumia-africa-catalog-and-flash-deals-extractor",
        "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/nimbryxo-studio~jumia-africa-catalog-and-flash-deals-extractor/run-sync": {
      "post": {
        "operationId": "run-sync-nimbryxo-studio-jumia-africa-catalog-and-flash-deals-extractor",
        "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",
        "required": [
          "mode"
        ],
        "properties": {
          "mode": {
            "title": "Collection mode",
            "enum": [
              "search",
              "categoryBrowse",
              "flashSales",
              "productDetails",
              "sellerProducts",
              "brandProducts"
            ],
            "type": "string",
            "description": "How to find products. Search uses a keyword, category browses a catalog section, flashSales reads today's deals, productDetails opens specific URLs, sellerProducts reads a seller storefront, and brandProducts reads a brand page.",
            "default": "search"
          },
          "country": {
            "title": "Jumia storefront",
            "enum": [
              "nigeria",
              "kenya",
              "ghana",
              "egypt",
              "morocco",
              "senegal",
              "uganda",
              "cote_divoire",
              "south_africa",
              "cameroon",
              "tanzania"
            ],
            "type": "string",
            "description": "The active Jumia country storefront to use. Prices are returned in that market's local currency.",
            "default": "nigeria"
          },
          "keyword": {
            "title": "Keyword",
            "type": "string",
            "description": "Product words to search for. Also narrows brand listings when set.",
            "default": ""
          },
          "categorySlug": {
            "title": "Category",
            "type": "string",
            "description": "A category path or a friendly key. Examples: phones-tablets, electronics, fashion, home-office. The actor translates the key to the selected market's own URL (for example telephone-tablette on jumia.ma). A full Jumia category URL also works."
          },
          "productUrls": {
            "title": "Product URLs",
            "type": "array",
            "description": "Jumia product page URLs for the specific product mode. The market is detected from each URL.",
            "default": [],
            "items": {
              "type": "string"
            }
          },
          "sellerUrls": {
            "title": "Seller URLs or slugs",
            "type": "array",
            "description": "Seller storefront URLs (or slugs like 'jckm-cod') for the seller mode. A full seller profile URL is accepted too.",
            "default": [],
            "items": {
              "type": "string"
            }
          },
          "brand": {
            "title": "Brand",
            "type": "string",
            "description": "Brand name, slug or brand URL. Used by the brand mode and to narrow search/category results. Examples: samsung, apple, tecno, or https://www.jumia.com.ng/brands/apple/."
          },
          "sort": {
            "title": "Sort order",
            "enum": [
              "popularity",
              "newest",
              "lowest-price",
              "highest-price",
              "rating"
            ],
            "type": "string",
            "description": "Order of listing results, using the sort options Jumia itself offers.",
            "default": "popularity"
          },
          "minPrice": {
            "title": "Minimum price",
            "minimum": 0,
            "type": "number",
            "description": "Lowest price to keep, in the selected market's local currency."
          },
          "maxPrice": {
            "title": "Maximum price",
            "minimum": 0,
            "type": "number",
            "description": "Highest price to keep, in the selected market's local currency."
          },
          "minRating": {
            "title": "Minimum rating",
            "minimum": 0,
            "maximum": 5,
            "type": "number",
            "description": "Keep products rated at least this many stars (0-5)."
          },
          "minDiscount": {
            "title": "Minimum discount",
            "enum": [
              "0",
              "10",
              "20",
              "30",
              "40",
              "50"
            ],
            "type": "string",
            "description": "Keep products discounted by at least this percentage.",
            "default": "0"
          },
          "minSellerScore": {
            "title": "Minimum seller score",
            "enum": [
              "0",
              "1",
              "2",
              "3",
              "4"
            ],
            "type": "string",
            "description": "Keep products from sellers above a Jumia seller-score band.",
            "default": "0"
          },
          "officialStoreOnly": {
            "title": "Official stores only",
            "type": "boolean",
            "description": "Keep products sold by brand-authorised official stores.",
            "default": false
          },
          "expressOnly": {
            "title": "Jumia Express only",
            "type": "boolean",
            "description": "Keep products fulfilled through Jumia Express.",
            "default": false
          },
          "condition": {
            "title": "Condition",
            "enum": [
              "any",
              "new",
              "refurbished",
              "packaging_damaged"
            ],
            "type": "string",
            "description": "Filter by product condition. Jumia exposes new items, refurbished items and packaging-damaged items through different filters.",
            "default": "any"
          },
          "enrichDetails": {
            "title": "Add full product details",
            "type": "boolean",
            "description": "Open each product page found in a listing to add description, specifications, seller score, warranty, return policy and the image gallery. Slower and more request-heavy.",
            "default": false
          },
          "partitionByPrice": {
            "title": "Partition large runs by price",
            "type": "boolean",
            "description": "Split a large request into price bands and merge them by product SKU. Use this to go past one listing's 2,000-product / 50-page slice.",
            "default": false
          },
          "includeReviews": {
            "title": "Include full reviews",
            "type": "boolean",
            "description": "For product detail and enriched listings, read the product's review pages and add them to the record.",
            "default": false
          },
          "maxReviews": {
            "title": "Maximum reviews",
            "minimum": 1,
            "maximum": 100,
            "type": "integer",
            "description": "How many customer reviews to include per product when full reviews are enabled.",
            "default": 20
          },
          "maxItems": {
            "title": "Maximum products",
            "minimum": 1,
            "maximum": 10000,
            "type": "integer",
            "description": "Stop after this many product records. Jumia caps one listing at 2,000 products (50 pages); enable price partitioning to combine bands.",
            "default": 40
          },
          "maxPages": {
            "title": "Maximum listing pages",
            "minimum": 1,
            "maximum": 50,
            "type": "integer",
            "description": "How many listing pages to read, about 40 products per page. Jumia shows at most 50 pages for one listing.",
            "default": 5
          }
        }
      },
      "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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}