Options
All
  • Public
  • Public/Protected
  • All
Menu

Response body returned from a successful postcode lookup API request.

API Documentation for postcodes/:postcode: ideal-postcodes.co.uk/documentation/postcodes#postcode.

Example Request:

api.ideal-postcodes.co.uk/v1/postcodes/SW1A2AA

Hierarchy

  • ApiResponseWithResult<PostcodeResults>
  • PossiblePaginatedResponse
    • PostcodesResponse

Index

Properties

code

code: number

Custom response code returned by API.

The response codes first 3 digits, reflects the HTTP status. e.g. 2000 would accompany a 200 OK HTTP status.

We do not recommend performing > or < type comparison operations on code even though its type is number. This prohibits us from producing more than 10 response codes per HTTP status.

Optional limit

limit: undefined | number

Maximum number of results per page.

Exposed in the event a request can be paginated.

message

message: string

Human readable success or error message returned by API.

Optional page

page: undefined | number

Current page number.

Exposed in the event a request can be paginated.

result

Result or set of results

Optional total

total: undefined | number

Total number of results.

Exposed in the event a request can be paginated.