> ## Documentation Index
> Fetch the complete documentation index at: https://docs.gmproxys.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Listar Estados

> Retorna os estados disponíveis para os países informados.

Retorna a lista de estados disponíveis para o tipo de proxy e os países informados, junto com a quantidade de IPs em cada um.

## Headers

<ParamField header="X-API-Key" type="string" required>
  Sua chave de API no formato `gm_SUA_CHAVE`.
</ParamField>

## Body

<ParamField body="type" type="string" required>
  Tipo do proxy. Valores aceitos: `datacenter` ou `residential`.
</ParamField>

<ParamField body="countries" type="string[]" required>
  Array de códigos de países (ex.: `["br"]`).
</ParamField>

## Resposta

Array de objetos com os estados disponíveis.

<ResponseField name="code" type="string">
  Código do estado.
</ResponseField>

<ResponseField name="name" type="string">
  Nome do estado.
</ResponseField>

<ResponseField name="count" type="integer">
  Quantidade de IPs disponíveis no estado.
</ResponseField>

<RequestExample>
  ```bash cURL theme={null}
  curl -X GET https://api.gmproxys.com/v1/states \
    -H "X-API-Key: gm_SUA_CHAVE" \
    -H "Content-Type: application/json" \
    -d '{
      "type": "residential",
      "countries": ["br"]
    }'
  ```

  ```javascript Node.js theme={null}
  const response = await fetch("https://api.gmproxys.com/v1/states", {
    method: "GET",
    headers: {
      "X-API-Key": "gm_SUA_CHAVE",
      "Content-Type": "application/json",
    },
    body: JSON.stringify({
      type: "residential",
      countries: ["br"],
    }),
  });

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.get(
      "https://api.gmproxys.com/v1/states",
      headers={
          "X-API-Key": "gm_SUA_CHAVE",
          "Content-Type": "application/json",
      },
      json={
          "type": "residential",
          "countries": ["br"],
      },
  )

  print(response.json())
  ```
</RequestExample>

<ResponseExample>
  ```json 200 theme={null}
  [
    {
      "code": "acre",
      "name": "Acre",
      "count": 48
    },
    {
      "code": "alagoas",
      "name": "Alagoas",
      "count": 396
    },
    {
      "code": "amapa",
      "name": "Amapá",
      "count": 90
    },
    {
      "code": "amazonas",
      "name": "Amazonas",
      "count": 245
    }
  ]
  ```

  ```json 401 Token inválido theme={null}
  {
    "success": false,
    "message": "Invalid API token."
  }
  ```
</ResponseExample>