Skip to main content
POST
Random Address Generator

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
ioCountry
enum<string>

Country

Available options:
random,
us,
uk,
ca,
au,
de
ioCount
number

Number of addresses

Required range: 1 <= x <= 50
ioFormat
enum<string>

Output Format

Available options:
full,
single,
json

Response

Tool output

tool
string
required
tool_version
string
required

Output-contract version for this tool. Currently "1" for all tools.

outputs
object
required
credits_used
integer
required

Credits this call consumed, after any settlement refund. 0 when metering is disabled.

request_id
string
credits_remaining
integer | null

Credits left in the current monthly allowance, or null when metering is disabled.