API Fogo Cruzado logo API Fogo Cruzado

Estados


Definições

Endpoint que retorna os dados dos Estados.

Endereço:

GET

/states

Definições

GET

/states/definitions

Retorno (Definições):

[
    "EstadoId",
    "Estado",
    "UF",
    "CodigoIBGE"
]


Retorno do endpoint:

[
    {
        "EstadoId": 19,
        "Estado": "Rio de Janeiro",
        "UF": "RJ",
        "CodigoIBGE": 33
    },
    {
        "EstadoId": 17,
        "Estado": "Pernambuco",
        "UF": "PE",
        "CodigoIBGE": 26
    }
]


Abaixo o que cada coluna representa

Coluna Valor
EstadoId Id do registro
Estado Nome do estado
UF Acrônimo do estado
CodigoIBGE Código do estado

Exemplos

Filtrando campos:

https://api.fogocruzado.org.br/api/v1/states?field[]=Estado&field[]=UF

Filtrando por nome:

https://api.fogocruzado.org.br/api/v1/states?Estado[lk]=Sao