Skip to main content
Bem-vindo à documentação oficial da API GmProxys — a interface programática para gerenciar proxies datacenter e residenciais, controlar saldo, consultar localizações e monitorar uso.

URL Base

Todas as requisições devem ser feitas para a seguinte URL base:
https://api.gmproxys.com/v1

Autenticação

A API do GmProxys utiliza API Keys para autenticar as requisições. Envie sua chave no header X-API-Key em todas as chamadas. Você pode obter sua chave no painel da GmProxys.

Headers obrigatórios

HeaderValor
X-API-Keygm_SUA_CHAVE
Content-Typeapplication/json

Exemplo

curl https://api.gmproxys.com/v1/proffile \
  -H "X-API-Key: gm_SUA_CHAVE" \
  -H "Content-Type: application/json"
const response = await fetch("https://api.gmproxys.com/v1/proffile", {
  headers: {
    "X-API-Key": "gm_SUA_CHAVE",
    "Content-Type": "application/json",
  },
});

const data = await response.json();
import requests

response = requests.get(
    "https://api.gmproxys.com/v1/proffile",
    headers={
        "X-API-Key": "gm_SUA_CHAVE",
        "Content-Type": "application/json",
    },
)

data = response.json()
Nunca compartilhe sua API Key publicamente. Trate-a como uma senha.

Fluxo básico

O uso mais comum da API segue esta sequência:
1

Verifique seu saldo

Use GET /proffile para consultar o saldo disponível na sua conta.
2

Escolha a localização

Consulte os países, estados e cidades disponíveis para o tipo de proxy desejado.
3

Crie um proxy

Use POST /proxy informando type, balance, threads e a localização.
4

Gerencie o proxy

Liste, obtenha, edite ou delete seus proxies conforme necessário.
5

Acompanhe uso e saldo

Consulte o histórico de uso, o saldo e o histórico de saldo de cada proxy.

Endpoints disponíveis

Usuário

Consulte informações da conta autenticada e o saldo disponível.

Proxy

Crie, liste, edite, delete e monitore o uso dos seus proxies.

Saldo

Consulte saldo, histórico e gerencie o saldo de cada proxy.

Locais

Descubra países, estados e cidades disponíveis para cada tipo de proxy.

Tipos de proxy

Residential

IPs residenciais reais, ideais para casos que exigem alta reputação e menor taxa de bloqueio.

Datacenter

IPs de datacenter, com maior velocidade e menor custo para operações de alto volume.

Limites e regras

  • Threads: ao criar um proxy, o valor de threads deve estar entre 1000 e 3000.
  • Saldo: informado em bytes. Ex.: 1000 = 10 GB.
  • Content-Type: sempre application/json.
  • Localização: ao editar (POST /update), envie apenas os campos que deseja alterar — todos exceto user_id são opcionais.

Erros

A API retorna erros no formato padrão JSON com os campos success e message.

401 — Token inválido

Retornado quando a X-API-Key está ausente, incorreta ou expirada.
{
  "success": false,
  "message": "Invalid API token."
}

402 — Saldo insuficiente

Retornado ao tentar criar um proxy sem saldo suficiente na conta (consulte o campo balance em GET /proffile).
{
  "success": false,
  "message": "Insufficient balance."
}

404 — Usuário da proxy inexistente

Retornado quando o user_id informado não existe ou foi digitado incorretamente. Aplica-se a: editar, histórico de uso, deletar, obter proxy, consultar saldo, histórico de saldo, adicionar saldo e remover saldo.
{
  "success": false,
  "message": "Proxy user not found."
}