Metadata Transaction

Description

The Metadata transaction is used to retrieve information about the structure and definitions of the data available through the MLS® IDX API. Metadata allows clients to properly format listing data for display and to organize it efficiently for future retrieval and storage.

End Point

https://sample.mlsidxapi.com/Metadata.svc/GetMetadata
ArgumentTypeDescriptionDefaultRequiredSupported Values
TypeStringSelects the type of metadata to be returned RETS
1.7.2		METADATA-SYSTEM
METADATA-RESOURCE
METADATA-CLASS
METADATA-LOOKUP
METADATA-LOOKUP_TYPE
FormatStringSelects the supported data return format for the query responseSTANDARD-XML STANDARD-XML COMPACT
IDStringList of the names of the parent elements for the desired element, separated by colons

Resource:Lookup
Eg;
Property:MesureUnit		0 – request for all Type metadata contained within that level
*. – request is for all Type metadata contained within that level and within the requested Type (i.e. all metadata)
Resource:Class
CultureStringSelect the language of the resultsen-CAen-CA
fr-CA

Note: The metadata ID for METADATA-SYSTEM and METADATA-RESOURCE must be 0 or *.

Note: METADATA-LOOKUP and METADATA-LOOKUP_TYPE requests only support STANDARD-XML format

Metadata Examples

ActionSyntax
Retrieve all Resource metadata, all levels Type=METADATA RESOURCE&Format=COMPACT&ID=*
Retrieve all Class metadata, class level onlyType=METADATA CLASS&Format=COMPACT&ID=*
Retrieve Class metadata for a specific resourceType=METADATA CLASS&Format=COMPACT&ID=Property
Retrieve Table metadata for a specific resource and classType=METADATA TABLE&Format=COMPACT&ID=Property:Property
Retrieve Lookup metadata for a specific resourceType=METADATA-LOOKUP&Format=STANDARD-
XML&ID=Property
Retrieve Lookup metadata for a specific
resource and lookup type		Type=METADATA LOOKUP_TYPE&Format=STANDARD XML&ID=Property:Crop

Server Response Header Fields

Request ArgumentTypeDescriptionDefaultRequiredSupported Values
Content-typeStringMedia type of the underlying dataRETS 1.7.2text/xml

SHARE POST:

Facebook
Reddit
LinkedIn

AgentDetails Payload

29 September 2025

Parent Cardinality Name Type Description Lookup AgentDetails 1 Name String The name of the Agent AgentDetails 1 ID Integer (Attribute) Unique ID assigned to the

Read More »

Agent Payload

29 September 2025

Parent Cardinality Name Type Description Lookup Agent 1 ID Integer (Attribute) Unique ID assigned to the Agent Agent 1 LastUpdated DateTime (Attribute) The date agent

Read More »

OfficeDetails Payload

29 September 2025

Parent Cardinality Name Type Description Lookup OfficeDetails 1 Name String The name of the Office OfficeDetails 1 ID Integer Unique ID assigned to the Office

Read More »

Office Payload

29 September 2025

Parent Cardinality Name Type Description Lookup Office 1 ID Integer Unique ID assigned to the office Office 1 Last Updated DateTime The date the office

Read More »