The API aims to provide access to one of the largest business and people databases in Canada. The API, which currently provides access to local business and dealer data, is intuitively designed. To search for any local information, you need to specify the “What” and the “Where” in the request parameters. This is best illustrated by a diagram shown below from their official site. These two parameters can be combined in various ways to search for local listings.
The current methods exposed for local data are FindBusiness, GetBusinessDetails, FindDealer. The API is REST based over HTTP with response data formats provided in either XML or JSON.
An example call to find all Barbers in Canada is given below:
When you register an application to use with the API, you are given a Sandbox API key which can be used immediately. If you plan to launch your application, you can then request for a Production Key. The current Sandbox API rates are low i.e. 1 call per second up to a maximum of 100 calls per day only. The Production rate limits are much higher at 2 calls per second upto a maximum of 5000 calls per day.
Yellow API has provided a glimpse in future datasets that it plans to expose. These include person search, deals and coupons, ratings and reviews, and classifieds. The deals and coupons, if and when it is exposed, will provide developers a chance to create cool applications that would serve the local Canadian community.