YellowAPI I/O Docs

Interact with the Yellow API -- discover, test, debug live calls all in one place. See the Documentation Portal for API characteristics, method details, error codes and more.

• What/Where API

  • List Methods
  • Expand Methods

  • GETFindBusiness/FindBusiness/
    This request returns local Canadian businesses that are most relevant to the search criteria.

    Parameter	Value	Type	Description
    pg		string	The requested page
    what		string	Keyword search term. This may be keywords, business name, or a phone number.
    lang	enfr	enumerated	Suggestion language
    where		string	The location to search. This may be a location name or a specific coordinate specification in the format: cZ{longitude},{latitude}.
    pgLen		string	Number of results to return per page
    fmt	XMLJSON	enumerated	The format of the output.
    sflag		string	Flags to modify or filter the search result. These may be combined as logically "AND" filters. To combine more than one filter, use the "dash" to separate each value.
    UID		string	A string of characters which uniquely identifies a user of the application (such as their IP address, session ID, or phone ID)

  • GETGetBusinessDetails/GetBusinessDetails/
    Gets Business Details.

    Parameter	Value	Type	Description
    prov		string	The province location of business. If not available, "Canada" is used.
    city		string	The city location of the business. If not present, no parameter will be generated.
    bus-name		string	Business name
    listingId		string	The unique listing id identifying the business.
    lang	enfr	enumerated	Suggestion language
    fmt	XMLJSON	enumerated	The format of the output.
    UID		string	A string of characters which uniquely identifies a user of the application (such as their IP address, session ID, or phone ID)

  • GETFindDealer/FindDealer/
    When applicable, this request returns a list of all dealers/franchises/branches for that business. A business with several locations may have a "parent" listing (primary) and one or more "children" listings.

    Parameter	Value	Type	Description
    pid		string	The listingId of a parent business. A parent business can be identified by the 'isParent' flag in the Listing object returned by FindBusinesses.
    pg		string	The requested page
    pgLen		string	Number of results to return per page
    lang	enfr	enumerated	Suggestion language
    fmt	XMLJSON	enumerated	The format of the output.
    UID		string	A string of characters which uniquely identifies a user of the application (such as their IP address, session ID, or phone ID)

  • GETGetTypeAhead/GetTypeAhead/
    The type ahead call returns search suggestions based on the characters a user has entered. The user can select the suggested term, saving them from having to enter all the characters for their search term. The suggestions for the "what" and the "where" terms are similar but distinct.

    Parameter	Value	Type	Description
    text		string	Characters typed by user
    lang	enfr	enumerated	Suggestion language
    field	WHATWHERE	enumerated	Which field to suggest, what or where
    UID		string	A string of characters which uniquely identifies a user of the application (such as their IP address, session ID, or phone ID)

• What/Where API

  • List Methods
  • Expand Methods

  • GETFindBusiness/FindBusiness/
    This request returns local Canadian businesses that are most relevant to the search criteria.

    Parameter	Value	Type	Description
    pg		string	The requested page
    what		string	Keyword search term. This may be keywords, business name, or a phone number.
    lang	enfr	enumerated	Suggestion language
    where		string	The location to search. This may be a location name or a specific coordinate specification in the format: cZ{longitude},{latitude}.
    pgLen		string	Number of results to return per page
    fmt	XMLJSON	enumerated	The format of the output.
    sflag		string	Flags to modify or filter the search result. These may be combined as logically "AND" filters. To combine more than one filter, use the "dash" to separate each value.
    UID		string	A string of characters which uniquely identifies a user of the application (such as their IP address, session ID, or phone ID)

  • GETGetBusinessDetails/GetBusinessDetails/
    Gets Business Details.

    Parameter	Value	Type	Description
    prov		string	The province location of business. If not available, "Canada" is used.
    city		string	The city location of the business. If not present, no parameter will be generated.
    bus-name		string	Business name
    listingId		string	The unique listing id identifying the business.
    lang	enfr	enumerated	Suggestion language
    fmt	XMLJSON	enumerated	The format of the output.
    UID		string	A string of characters which uniquely identifies a user of the application (such as their IP address, session ID, or phone ID)

  • GETFindDealer/FindDealer/
    When applicable, this request returns a list of all dealers/franchises/branches for that business. A business with several locations may have a "parent" listing (primary) and one or more "children" listings.

    Parameter	Value	Type	Description
    pid		string	The listingId of a parent business. A parent business can be identified by the 'isParent' flag in the Listing object returned by FindBusinesses.
    pg		string	The requested page
    pgLen		string	Number of results to return per page
    lang	enfr	enumerated	Suggestion language
    fmt	XMLJSON	enumerated	The format of the output.
    UID		string	A string of characters which uniquely identifies a user of the application (such as their IP address, session ID, or phone ID)

  • GETGetTypeAhead/GetTypeAhead/
    The type ahead call returns search suggestions based on the characters a user has entered. The user can select the suggested term, saving them from having to enter all the characters for their search term. The suggestions for the "what" and the "where" terms are similar but distinct.

    Parameter	Value	Type	Description
    text		string	Characters typed by user
    lang	enfr	enumerated	Suggestion language
    field	WHATWHERE	enumerated	Which field to suggest, what or where
    UID		string	A string of characters which uniquely identifies a user of the application (such as their IP address, session ID, or phone ID)