Skip to main content

Buscar Produtividade por Cidade

Descrição: Busca dados de produtividade agrícola filtrados por código da cidade e cultura.

Endpoint

GET/api/v1/integration/productivity/city

Regras

AtributosDescriçãoTipoObrigatórioValidações
cityCodeCódigo IBGE da cidadeStringSim-
cultureTipo de cultura agrícolaString (Enum)SimValores permitidos: SOY, CORN, SUGAR_CANE, RICE, COTTON, COFFEE, CITRUS, PALM

Exemplo de Requisição

Exemplo de Requisição
curl -X GET\
-H "Authorization: [[apiKey]]"\
-H "Accept: application/json"\
"https://homolog.api.merx.tech/api/v1/integration/productivity/city?cityCode=5208707&culture=SOY"

Parâmetros

Parâmetros de Query:

NomeDescriçãoTipoObrigatório
cityCodeCódigo IBGE da cidadeStringSim
cultureTipo de cultura agrícola. Valores: SOY, CORN, SUGAR_CANE, RICE, COTTON, COFFEE, CITRUS, PALMString (Enum)Sim

Parâmetros de Cabeçalho

NomeDescriçãoTipoObrigatório
AuthorizationToken de autenticaçãoStringSim

Culturas Disponíveis

ValorDescrição
SOYSoja
CORNMilho
SUGAR_CANECana-de-açúcar
RICEArroz
COTTONAlgodão
COFFEECafé
CITRUSCitrus
PALMPalma

Respostas

  • 200 - Ok
[
{
"city_code": 5208707,
"culture": "SOY",
"year": 2023,
"productivity": 55.5,
"removed": false,
"created_at": "2023-01-15T10:30:00Z",
"updated_at": "2023-01-15T10:30:00Z"
}
]

Campos da Resposta

CampoTipoDescrição
city_codeIntegerCódigo IBGE da cidade
cultureStringTipo de cultura agrícola
yearIntegerAno de referência
productivityDoubleProdutividade em kg/ha ou ton/ha
removedBooleanIndica se o registro foi removido
created_atDateTimeData de criação do registro
updated_atDateTimeData da última atualização
  • 400 - Bad Request
{
"timestamp": "string (date-time)",
"status": 400,
"error": "string"
}
  • 401 - Unauthorized