Addressy API
GET /random/address

Get a random address

Query parameters

  • state string

    Specify the state for the random address.

  • zip string

    Specify the zip code for the random address.

Responses

  • 429

    Rate Limited. Too many requests.

  • 500

    Unexpected error

  • 200

    Success!

    Hide response attributes Show response attributes object
    • line string
    • state string
    • stateCode string
    • countryCode string
    • city string
    • postalCode string
  • 404

    Not Found. The requested resource does not exist.

  • 400

    Input Error. Check the request payload for issues.

  • 401

    Unauthorized (no API key provided or not valid).

GET /random/address 
curl \
 -X GET https://api.minimus.tech/api:IeehoD8J/random/address \
 -H "X-API-Key: $API_KEY"
Response examples (200) 
{
  "line": "string",
  "state": "string",
  "stateCode": "string",
  "countryCode": "string",
  "city": "string",
  "postalCode": "string"
}
Response examples (200) 
{
  "line": "string",
  "state": "string",
  "stateCode": "string",
  "countryCode": "string",
  "city": "string",
  "postalCode": "string"
}