Skip to main content
POST
geo.addresses.extract

Authorizations

Authorization
string
header
required

API key: sk_live_…

Headers

Idempotency-Key
string

Optional. A retry with the same key returns the stored result.

Maximum string length: 255
Pramaan-Max-Price-Micro
string

Optional. The most this request may be priced at, in micro-USD (a whole number above 0). It replaces the capability's own price ceiling for this request, lower or higher. Sources that could cost more are left out; when none is left the answer is 400 with the lowest limit that would work.

Pattern: ^[1-9]\d{0,14}$

Body

application/json
text
string
required

Text or HTML containing US addresses; at most 65536 UTF-8 bytes and 100 lines.

Required string length: 1 - 65536
html
boolean

Whether the input is HTML; absent uses detection.

aggressive
boolean
default:false

Find addresses in messy text; may consume extra lookups.

allowLineBreaks
boolean
default:true

Addresses may cross input lines.

addressesPerLine
integer
default:1

Actual extraction limit sent upstream, 1 to 10 per line.

Required range: 1 <= x <= 10
match
enum<string>
default:strict

Address matching strategy; enhanced is an explicit costly option.

Available options:
strict,
invalid,
enhanced

Response

Job started; poll GET /v1/jobs/{id}

job_id
string
required
status
enum<string>
required
Available options:
running
held_micro
integer
required

The credit set aside for the job (its estimate), micro-USD; 0 when it takes none. Not a price: what the job is charged reads on GET /v1/jobs/{id} once it is settled.