Get Lookup Info

address_verification.get_lookup_info() -> AddressVerificationGetLookupInfoResponse

GET/v1/addver/

Returns your organization’s current lookup usage and plan information. Useful for checking how many lookups you have consumed and whether you are on a paid plan.

ReturnsExpand Collapse

class AddressVerificationGetLookupInfoResponse: …

data: Data

free_limit: Optional[int]

The maximum number of lookups allowed in the current billing period. null indicates an unlimited plan.

used: int

The number of lookups consumed in the current billing period.

message: str

status: Literal["success", "error"]

One of the following:

"success"

"error"

Get Lookup Info

import os
from postgrid import PostGrid

client = PostGrid(
    address_verification_api_key=os.environ.get("POSTGRID_ADDRESS_VERIFICATION_API_KEY"),  # This is the default and can be omitted
)
response = client.address_verification.get_lookup_info()
print(response.data)

{
  "data": {
    "freeLimit": 0,
    "used": 0
  },
  "message": "message",
  "status": "success"
}

Returns Examples

{
  "data": {
    "freeLimit": 0,
    "used": 0
  },
  "message": "message",
  "status": "success"
}