Address Parsing [application/json]

Request

Header Params

Authorization

string

required

Authorization token obtained in the Authentication/Authenticate method

Example:

Bearer {{bearer_token}}

Body Params application/json

country

string

required

Text containing the country code (ISO 3166-1 alpha-3) in which the address is formatted, using capital letters. Example: BRA.

address

string

required

Text containing the address to be processed, supporting newline '\n' characters.

Example

{
    "country": "",
    "address": ""
}

Request samples

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request POST 'https://mostqiapi.com/process-text/address-parsing' \
--header 'Authorization: Bearer ' \
--header 'Content-Type: application/json' \
--data-raw '{
    "country": "",
    "address": ""
}'

Responses

🟢200200 Ok Response

application/json

Body

result

object

required

match

object

required

requestId

string

required

elapsedMiliseconds

integer

required

status

object

required

code

integer

required

message

string

required

Example

{
    "result": {
        "match": {
            "language": "pt",
            "score": 1.0,
            "components": [
                {
                    "std_name": "country",
                    "name": "pais",
                    "score": null,
                    "value": null,
                    "std_value": "REPUBLICA FEDERATIVA DO BRASIL"
                },
                {
                    "std_name": "postcode",
                    "name": "cep",
                    "score": 1.0,
                    "value": "30494450",
                    "std_value": "30494450"
                },
                {
                    "std_name": "state",
                    "name": "estado",
                    "score": 1.0,
                    "value": "MG",
                    "std_value": "MINAS GERAIS"
                },
                {
                    "std_name": "city",
                    "name": "cidade",
                    "score": 1.0,
                    "value": "BELO HORIZONTE",
                    "std_value": "BELO HORIZONTE"
                },
                {
                    "std_name": "place",
                    "name": "logradouro",
                    "score": 1.0,
                    "value": "RUA DESEMBARGADOR EDESIO FERNANDES",
                    "std_value": "RUA DESEMBARGADOR EDESIO FERNANDES"
                },
                {
                    "std_name": "number",
                    "name": "numero",
                    "score": 1.0,
                    "value": "148",
                    "std_value": "148"
                },
                {
                    "std_name": "neighborhood",
                    "name": "bairro",
                    "score": 1.0,
                    "value": "ESTORIL",
                    "std_value": "ESTORIL"
                },
                {
                    "std_name": "conjunct",
                    "name": "conjunto",
                    "score": 1.0,
                    "value": "CONJ 208\n",
                    "std_value": "CONJUNTO 208"
                }
            ]
        }
    },
    "requestId": "kX03U8aV102Pve8pQ1Jar",
    "elapsedMiliseconds": 0,
    "status": {
        "code": 200,
        "message": "Ok"
    }
}

🔴500500 Error Response

🟠400400 Bad Request Response