Zomato.jl

The unofficial Julia wrapper around Zomato's API :fire:
Author rahulkp220
Popularity
6 Stars
Updated Last
3 Years Ago
Started In
September 2018

License: MIT Build Status GitHub contributors GitHub issues GitHub version

ForTheBadge built-with-love

Zomato.jl

An unofficial Julia wrapper for Zomato's API ๐Ÿ”ฅ However, the official documentation can be reached here

Installation

julia> ]
(v1.0) pkg> add Zomato

How it works?

As per Zomato's official guidelines, access to restaurant information and search on Zomato is limited to 1000 calls per day. Hence the limit should be kept in mind.

# Import package
julia> using Zomato

# authenticate
julia> auth = Zomato.authenticate("API-KEY")
Zomato(https://developers.zomato.com/api/v2.1/)

# get the categories
julia> Zomato.get(auth, CategoriesAPI)
[ Info: fetching categories...
Dict{String,Any} with 1 entry:
  "categories" => Any[Dict{String,Any}("categories"=>Dict{String,Any}("name"=>"Delivery","id"=>1)), Dict{String,Any}("categories"=>Dict{String,Any}("name"=>โ€ฆ

# get city wise details
julia> Zomato.get(auth, CitiesAPI, q="london")
[ Info: fetching city details...
Dict{String,Any} with 4 entries:
  "location_suggestions" => Any[Dict{String,Any}("is_state"=>0,"state_name"=>"England and Wales","name"=>"London","id"=>61,"state_code"=>"England and Wales"โ€ฆ
  "has_total"            => 0
  "status"               => "success"
  "has_more"             => 0

Documentation

Each function has an extensive API documentation, a sample of which is given below.

help?>Zomato.get(z::Zomato.Auth, ::Type{Zomato.CitiesAPI}; kwargs...)
  Get city details
  ==================

  Find the Zomato ID and other details for a city . 
  You can obtain the Zomato City ID in one of the following ways:

    โ€ข    City Name in the Search Query - 
    Returns list of cities matching the query

    โ€ข    Using coordinates - 
    Identifies the city details based on the coordinates of any location inside a city

  If you already know the Zomato City ID, this API can be used to get other details of the city.

  See https://developers.zomato.com/documentation#!/common/cities

  Arguments
  ===========

  Parameter Description                      Parameter Type Data Type
  โ€“โ€“โ€“โ€“โ€“โ€“โ€“โ€“โ€“ โ€“โ€“โ€“โ€“โ€“โ€“โ€“โ€“โ€“โ€“โ€“โ€“โ€“โ€“โ€“โ€“โ€“โ€“โ€“โ€“โ€“โ€“โ€“โ€“โ€“โ€“โ€“โ€“โ€“โ€“โ€“โ€“ โ€“โ€“โ€“โ€“โ€“โ€“โ€“โ€“โ€“โ€“โ€“โ€“โ€“โ€“ โ€“โ€“โ€“โ€“โ€“โ€“โ€“โ€“โ€“
  q         query by city name               query          String
  lat       latitude                         query          Float
  lon       longitude                        query          Float
  city_ids  comma separated city_id values   query          String
  count     number of max results to display query          Int

Facing issues? ๐Ÿ˜ฑ

  • Open a PR with the detailed expaination of the issue
  • Reach me out here