{
  "openapi": "3.0.1",
  "info": {
    "title": "Carousell Marketplace Listing Search (Hong Kong)",
    "description": "Search Hong Kong Carousell listings by keyword or category, or fetch listing and seller pages: price, condition, photos, seller feedback, location and deal options. No account, user cookies or API key required.",
    "version": "2.0",
    "x-build-id": "lDzj3anWIiDl946uE"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/nimbryxo-studio~carousell-marketplace-listing-search-across-8/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-nimbryxo-studio-carousell-marketplace-listing-search-across-8",
        "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~carousell-marketplace-listing-search-across-8/runs": {
      "post": {
        "operationId": "runs-sync-nimbryxo-studio-carousell-marketplace-listing-search-across-8",
        "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~carousell-marketplace-listing-search-across-8/run-sync": {
      "post": {
        "operationId": "run-sync-nimbryxo-studio-carousell-marketplace-listing-search-across-8",
        "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": "Mode",
            "enum": [
              "search",
              "category",
              "listingDetails",
              "seller"
            ],
            "type": "string",
            "description": "Search listings, browse one category, fetch listing detail URLs, or pull a seller profile with its listings.",
            "default": "search"
          },
          "queries": {
            "title": "Search queries",
            "type": "array",
            "description": "One or more keywords (mode=search). Each query returns Carousell's first page of up to 48 listings per market.",
            "items": {
              "type": "string"
            },
            "default": [
              "iPhone"
            ]
          },
          "category": {
            "title": "Category (mode=category)",
            "enum": [
              "mobile-phones",
              "electronics",
              "cars",
              "property",
              "motorbikes",
              "womens-fashion",
              "mens-fashion",
              "luxury",
              "photography",
              "video-gaming",
              "toys-collectibles",
              "babies-kids",
              "pets",
              "tickets-vouchers",
              "everything-else",
              "food-drinks",
              "jobs",
              "services",
              "furniture-home",
              "sports",
              "health-beauty"
            ],
            "type": "string",
            "description": "Top-level category. The actor resolves the correct market-specific collection ID and URL."
          },
          "sellerUsernames": {
            "title": "Seller usernames (mode=seller)",
            "type": "array",
            "description": "Carousell usernames to fetch. Each seller returns profile fields plus the first page of their listings.",
            "items": {
              "type": "string"
            },
            "default": []
          },
          "listingUrls": {
            "title": "Listing URLs or IDs (mode=listingDetails)",
            "type": "array",
            "description": "Carousell /p/ listing URLs or bare listing IDs. Bare IDs use Hong Kong. URLs from unsupported markets are skipped.",
            "items": {
              "type": "object",
              "properties": {
                "url": {
                  "title": "Listing URL",
                  "type": "string",
                  "description": "Carousell /p/ listing URL or bare listing ID."
                }
              },
              "required": [
                "url"
              ]
            },
            "default": []
          },
          "sortBy": {
            "title": "Sort by",
            "enum": [
              "best_match",
              "recent",
              "price_low",
              "price_high"
            ],
            "type": "string",
            "description": "Server-side sort. Best match is Carousell's default and sends no sort parameter.",
            "default": "best_match"
          },
          "condition": {
            "title": "Condition",
            "enum": [
              "any",
              "brand_new",
              "like_new",
              "lightly_used",
              "well_used",
              "heavily_used"
            ],
            "type": "string",
            "description": "Server-side layered condition filter. Carousell uses codes 3, 4, 7, 5 and 6 for these labels.",
            "default": "any"
          },
          "priceMin": {
            "title": "Minimum price",
            "minimum": 0,
            "maximum": 1000000000,
            "type": "integer",
            "description": "Minimum price in the market's local currency (server-side)."
          },
          "priceMax": {
            "title": "Maximum price",
            "minimum": 0,
            "maximum": 1000000000,
            "type": "integer",
            "description": "Maximum price in the market's local currency (server-side)."
          },
          "dealOption": {
            "title": "Deal option",
            "enum": [
              "any",
              "mailing",
              "meetup"
            ],
            "type": "string",
            "description": "Server-side mailing/delivery or meet-up filter.",
            "default": "any"
          },
          "postedWithinDays": {
            "title": "Posted within (days)",
            "minimum": 1,
            "maximum": 365,
            "type": "integer",
            "description": "Client-side filter over the first page. Listings without a visible creation timestamp are excluded when this is set."
          },
          "maxItems": {
            "title": "Maximum records",
            "minimum": 1,
            "maximum": 500,
            "type": "integer",
            "description": "Overall record cap. Carousell returns at most 48 listings per query, so larger values cannot exceed that first-page limit.",
            "default": 20
          },
          "includeDetails": {
            "title": "Fetch detail pages",
            "type": "boolean",
            "description": "Fetch and merge full detail pages for search, category or seller results. Adds one request per listing.",
            "default": false
          },
          "maxDetailItems": {
            "title": "Maximum detail pages",
            "minimum": 1,
            "maximum": 50,
            "type": "integer",
            "description": "Cap on detail-page requests when includeDetails is enabled (or in listingDetails mode).",
            "default": 10
          },
          "country": {
            "title": "Market",
            "enum": [
              "hong_kong"
            ],
            "type": "string",
            "description": "Verified market: hong_kong only. Other Carousell markets are blocked or unreliable from Apify cloud and are not offered.",
            "default": "hong_kong"
          }
        }
      },
      "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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}