{
  "openapi": "3.0.1",
  "info": {
    "title": "Reclame Aqui Scraper: Reputation & Complaints",
    "description": "Reputation and complaints from Reclame Aqui (Brazil) in one flat dataset: score, solution rate, would do business again, response time, RA1000, plus complaint title, text, status, date, category, city/UF. Compare many companies or a category ranking. No consumer identification.",
    "version": "0.1",
    "x-build-id": "XpvIfJmZQJwd8Xlac"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/allanmxr~reclame-aqui-scraper/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-allanmxr-reclame-aqui-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/allanmxr~reclame-aqui-scraper/runs": {
      "post": {
        "operationId": "runs-sync-allanmxr-reclame-aqui-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/allanmxr~reclame-aqui-scraper/run-sync": {
      "post": {
        "operationId": "run-sync-allanmxr-reclame-aqui-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": {
          "sources": {
            "title": "Sources",
            "minItems": 1,
            "uniqueItems": true,
            "type": "array",
            "description": "Companies: the companies you list below. Category ranking: the best or worst companies of a Reclame Aqui category. The record budget (Max items) is shared between them.",
            "items": {
              "type": "string",
              "enum": [
                "companies",
                "categoryRanking"
              ],
              "enumTitles": [
                "Companies (by name or URL)",
                "Category ranking"
              ]
            },
            "default": [
              "companies"
            ]
          },
          "companies": {
            "title": "Companies",
            "type": "array",
            "description": "One per line: company name (Nubank), Reclame Aqui shortname (nubank) or page URL (https://www.reclameaqui.com.br/empresa/nubank/). A name takes the first match of the Reclame Aqui search; paste the URL to be sure.",
            "items": {
              "type": "string"
            }
          },
          "rankingCategories": {
            "title": "Ranking categories",
            "type": "array",
            "description": "One per line: category slugs main/secondary (varejo/marketplaces) or the category URL (https://www.reclameaqui.com.br/segmentos/varejo/marketplaces/). Browse them at reclameaqui.com.br/segmentos/.",
            "items": {
              "type": "string"
            }
          },
          "rankingType": {
            "title": "Ranking type",
            "enum": [
              "best",
              "worst",
              "both"
            ],
            "type": "string",
            "description": "Best rated, worst rated or both lists of each category.",
            "default": "best"
          },
          "rankingMaxCompanies": {
            "title": "Companies per ranking",
            "minimum": 1,
            "maximum": 100,
            "type": "integer",
            "description": "How many companies to take from the top of each ranking list.",
            "default": 10
          },
          "includeReputation": {
            "title": "Include company reputation",
            "type": "boolean",
            "description": "One record per company and period with score, solution rate, would do business again, response rate, average response time and RA1000 status.",
            "default": true
          },
          "reputationPeriods": {
            "title": "Reputation periods",
            "uniqueItems": true,
            "type": "array",
            "description": "Periods of the reputation panel shown on Reclame Aqui. Each period is one record per company.",
            "items": {
              "type": "string",
              "enum": [
                "sixMonths",
                "twelveMonths",
                "lastYear",
                "yearBeforeLast",
                "overall"
              ],
              "enumTitles": [
                "Last 6 months",
                "Last 12 months",
                "Last calendar year",
                "Year before last",
                "Overall (last 3 years)"
              ]
            },
            "default": [
              "sixMonths"
            ]
          },
          "maxComplaintsPerCompany": {
            "title": "Max complaints per company",
            "minimum": 0,
            "maximum": 50000,
            "type": "integer",
            "description": "Complaints to collect per company, 0 for reputation only. Up to 500 they are the newest overall. Reclame Aqui serves only 500 per query, so past 500 the Actor splits the search by status, consumer state and problem/product/category on the site itself; very large companies reach tens of thousands, not every complaint.",
            "default": 50
          },
          "complaintStatus": {
            "title": "Complaint status",
            "uniqueItems": true,
            "type": "array",
            "description": "Leave empty for every status. The quota per company is split equally between the chosen statuses.",
            "items": {
              "type": "string",
              "enum": [
                "not_answered",
                "answered",
                "resolved",
                "not_resolved"
              ],
              "enumTitles": [
                "Not answered",
                "Answered (not evaluated yet)",
                "Resolved",
                "Not resolved"
              ]
            },
            "default": []
          },
          "dateFrom": {
            "title": "Complaints from",
            "type": "string",
            "description": "Only complaints created on or after this date (YYYY-MM-DD)."
          },
          "dateTo": {
            "title": "Complaints until",
            "type": "string",
            "description": "Only complaints created on or before this date (YYYY-MM-DD)."
          },
          "consumerStates": {
            "title": "Consumer states (UF)",
            "uniqueItems": true,
            "type": "array",
            "description": "Only complaints from consumers in these states, filtered on Reclame Aqui itself. Leave empty for all.",
            "items": {
              "type": "string",
              "enum": [
                "AC",
                "AL",
                "AP",
                "AM",
                "BA",
                "CE",
                "DF",
                "ES",
                "GO",
                "MA",
                "MT",
                "MS",
                "MG",
                "PA",
                "PB",
                "PR",
                "PE",
                "PI",
                "RJ",
                "RN",
                "RS",
                "RO",
                "RR",
                "SC",
                "SP",
                "SE",
                "TO"
              ]
            },
            "default": []
          },
          "includeComplaintText": {
            "title": "Include complaint text",
            "type": "boolean",
            "description": "Full complaint text and the consumer's final evaluation. Identification fields are never collected; the free text is the public text already masked by Reclame Aqui, plus best-effort masking of CPF, RG, e-mail, phone, self-introductions and signatures. Turn off to keep titles only.",
            "default": true
          },
          "maxItems": {
            "title": "Max items",
            "minimum": 1,
            "type": "integer",
            "description": "Maximum records in total (company and complaint records together). Each record is one charged result.",
            "default": 1000
          },
          "proxyConfiguration": {
            "title": "Proxy configuration",
            "type": "object",
            "description": "Optional. Leave empty and the Actor connects directly, falling back to Apify Proxy (datacenter, then residential Brazil) only when Reclame Aqui blocks it. A proxy chosen here is used from the first request."
          }
        }
      },
      "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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}