{
  "openapi": "3.0.1",
  "info": {
    "title": "Carousell Listings Scraper",
    "description": "Scrape Carousell listings by keyword or URL in Singapore, Malaysia, Philippines, Hong Kong, Taiwan and Indonesia. Filter by price and condition, sort by newest. Get prices, sellers, images, photos and seller ratings.",
    "version": "0.1",
    "x-build-id": "vdP97OmZqeXIw5VBz"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/automation-lab~carousell-listings-scraper/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-automation-lab-carousell-listings-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/automation-lab~carousell-listings-scraper/runs": {
      "post": {
        "operationId": "runs-sync-automation-lab-carousell-listings-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/automation-lab~carousell-listings-scraper/run-sync": {
      "post": {
        "operationId": "run-sync-automation-lab-carousell-listings-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": {
          "keywords": {
            "title": "Search keywords",
            "type": "array",
            "description": "Marketplace search phrases to scrape on Carousell, for example iphone, bicycle, sofa, or camera lens.",
            "items": {
              "type": "string"
            }
          },
          "startUrls": {
            "title": "Carousell search, category or listing URLs",
            "type": "array",
            "description": "Optional Carousell search, category or single-listing (/p/...) URLs. Filters you already applied on Carousell are kept. Other sites are rejected before the run does any work.",
            "items": {
              "type": "object",
              "required": [
                "url"
              ],
              "properties": {
                "url": {
                  "type": "string",
                  "title": "URL of a web page",
                  "format": "uri"
                }
              }
            }
          },
          "maxItems": {
            "title": "Maximum listings",
            "minimum": 1,
            "maximum": 500,
            "type": "integer",
            "description": "Maximum number of unique listings to save across all keywords and URLs. The Actor loads additional result batches as needed and may stop below this limit when the source is exhausted.",
            "default": 20
          },
          "maxItemsPerSearch": {
            "title": "Maximum listings per keyword or URL",
            "minimum": 1,
            "maximum": 500,
            "type": "integer",
            "description": "Optional cap for each keyword or URL, so one search cannot use up the whole Maximum listings. Leave empty to fill Maximum listings from the first sources."
          },
          "market": {
            "title": "Carousell market",
            "enum": [
              "sg",
              "my",
              "ph",
              "tw",
              "hk",
              "id",
              "com"
            ],
            "type": "string",
            "description": "Carousell country site used for keyword searches.",
            "default": "sg"
          },
          "sortBy": {
            "title": "Sort order",
            "enum": [
              "best_match",
              "recent",
              "price_low_to_high",
              "price_high_to_low"
            ],
            "type": "string",
            "description": "Result order for keyword searches, and for URLs that do not set their own.",
            "default": "best_match"
          },
          "listingType": {
            "title": "Listing type",
            "enum": [
              "marketplace",
              "certified"
            ],
            "type": "string",
            "description": "Individual sellers' marketplace listings, or Carousell Certified refurbished phone offers.",
            "default": "marketplace"
          },
          "minPrice": {
            "title": "Minimum price",
            "minimum": 0,
            "type": "integer",
            "description": "Lowest price, in the market's currency. Carousell applies it. Marketplace listings only."
          },
          "maxPrice": {
            "title": "Maximum price",
            "minimum": 0,
            "type": "integer",
            "description": "Highest price, in the market's currency. Carousell applies it. Marketplace listings only."
          },
          "conditions": {
            "title": "Conditions",
            "type": "array",
            "description": "Keep only these conditions. Leave empty for all. Carousell applies it. Marketplace listings only.",
            "items": {
              "type": "string",
              "enum": [
                "brand_new",
                "like_new",
                "lightly_used",
                "well_used",
                "heavily_used"
              ],
              "enumTitles": [
                "Brand new",
                "Like new",
                "Lightly used",
                "Well used",
                "Heavily used"
              ]
            }
          },
          "includeDetails": {
            "title": "Include listing details",
            "type": "boolean",
            "description": "Visit detail pages for a bounded number of first-seen listings and add the description, all photos, availability, location, category, seller rating, review count and account age. Disabled by default.",
            "default": false
          },
          "maxDetailItems": {
            "title": "Maximum detail pages",
            "minimum": 1,
            "maximum": 100,
            "type": "integer",
            "description": "Maximum number of first-seen listings to enrich when Include listing details is enabled. This setting is ignored otherwise.",
            "default": 20
          },
          "proxyType": {
            "title": "Proxy type",
            "enum": [
              "residential",
              "datacenter",
              "none"
            ],
            "type": "string",
            "description": "Residential proxy is recommended. Carousell consistently returns Cloudflare challenges to direct and datacenter traffic.",
            "default": "residential"
          },
          "timeoutSecs": {
            "title": "Page timeout (seconds)",
            "minimum": 30,
            "maximum": 180,
            "type": "integer",
            "description": "Maximum time for each Carousell page load.",
            "default": 75
          }
        }
      },
      "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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}