Appendix G – Address Payload

Parent	Cardinality	Name	Type	Description
Address	0..1	StreetAddress	String	This field returns a formatted street address. It may contain a vertical bar (I) line delimiter if address contains multiple lines. It includes the following address fields if available: AdditionalStreetInfo, UnitNumber, StreetNumber, StreetDirectionPrefix, StreetName, StreetSuffix, StreetDirectionSuffix, BoxNumber, If the above fields do not yield a valid street Address, the following fields will be included instead (if available) AdditionalStreetInfo, UnitNumber, AddressLine1, AddressLine2
Address	0..1	AddressLine1	String	The first address line of the address
Address	0..1	AddressLine2	String	The second address line of the address
Address	0..1	StreetNumber	String	The building number in the address
Address	0..1	StreetDirectionPrefix	String	Directional indicator that precedes the street name
Address	0..1	StreetName	String	Official name of the street in the address
Address	0..1	StreetSuffix	String	The street type
Address	0..1	StreetDirectionSuffix	String	Directional indicator that follows a street name
Address	0..1	UnitNumber	String	Apartment, suite or office number portion of a postal address
Address	0..1	BoxNumber	String	Post office box if applicable
Address	0..1	City	String	City of the address
Address	0..1	Province	String	Province of the address
Address	0..1	PostalCode	String	Postal code of the address
Address	0..1	Country	String	Country of the address
Address	0..1	AdditionalStreetInfo	String	Additional information about the street
Address	0..1	CommunityName	String	Community name of the address
Address	0..1	Neighbourhood	String	Neighbourhood name of the address
Address	0..1	Subdivision	String	Subdivision name of the address
Address	0..1	Latitude	String	Latitude coordinates
Address	0..1	Longitude	String	Longitude coordinates

Parent

Cardinality

Name

Type

Description

Lookup

Address

0..1

StreetAddress

String

This field returns a formatted street address. It may contain a vertical bar (I) line delimiter if address contains multiple lines.
It includes the following address fields if available:
AdditionalStreetInfo, UnitNumber, StreetNumber, StreetDirectionPrefix, StreetName, StreetSuffix, StreetDirectionSuffix, BoxNumber,
If the above fields do not yield a valid street Address, the following fields will be included instead (if available)
AdditionalStreetInfo, UnitNumber, AddressLine1, AddressLine2

Address

0..1

AddressLine1

String

The first address line of the address

Address

0..1

AddressLine2

String

The second address line of the address

Address

0..1

StreetNumber

String

The building number in the address

Address

0..1

StreetDirectionPrefix

String

Directional indicator that precedes the street name

Address

0..1

StreetName

String

Official name of the street in the address

Address

0..1

StreetSuffix

String

The street type

Address

0..1

StreetDirectionSuffix

String

Directional indicator that follows a street name

Address

0..1

UnitNumber

String

Apartment, suite or office number portion of a postal address

Address

0..1

BoxNumber

String

Post office box if applicable

Address

0..1

City

String

City of the address

Address

0..1

Province

String

Province of the address

Address

0..1

PostalCode

String

Postal code of the address

Address

0..1

Country

String

Country of the address

Address

0..1

AdditionalStreetInfo

String

Additional information about the street

Address

0..1

CommunityName

String

Community name of the address

Address

0..1

Neighbourhood

String

Neighbourhood name of the address

Address

0..1

Subdivision

String

Subdivision name of the address

Address

0..1

Latitude

String

Latitude coordinates

Address

0..1

Longitude

String

Longitude coordinates

Appendix M – Complete List of Metadata Lookups Available

17 October 2025

Resource Metadata-Lookup Property Access Type Property Amenities Property AmenitiesNearby Property Amperage Property Appliances Property ArchitecturalStyle Property BasementDevelopment Property BasementFeatures Property BasementType Property Boards Property BuildingType

MLS IDX API

Getting Started

Documentation

Code Samples

Appendix G – Address Payload

SHARE POST:

Appendix M – Complete List of Metadata Lookups Available

Appendix L – Reply Codes

Digest Authentication Response Calculations

Appendix K – Digest Authentication

Appendix J- PropertyDetails Payload (Compact)

Appendix I – Website Payload

Appendix M – Complete List of Metadata Lookups Available

Appendix L – Reply Codes

Digest Authentication Response Calculations

Appendix K – Digest Authentication

Appendix J- PropertyDetails Payload (Compact)

Appendix I – Website Payload