The unofficial Julia API for Hackernews 🔥
See Hacker News API
Since HackerNews is registered in official Julia Registry, you can directly install it.
julia> ]
(v1.0) pkg> add HackerNewsThe API is fairly simple to use and there isn't much required to get up and running.
The package provides a HackerNews.HNApiRoute which represents all the routes that the Hackernews API can handle. You can get a list of all available routes by typing,
julia> subtypes(HackerNews.HNApiRoute)
8-element Array{Union{DataType, UnionAll},1}:
HackerNews.AskStories
HackerNews.BestStories
HackerNews.JobStories
HackerNews.MaxItem
HackerNews.NewStories
HackerNews.ShowStories
HackerNews.TopStories
HackerNews.Updates julia> using HackerNews
julia> maxitem = HackerNews.HN(HackerNews.MaxItem)
julia> HackerNews.getinfo(maxitem)
INFO: fetching maxitem..
INFO: generating post data...
1-element Array{HackerNews.HNPost,1}:
HackerNews.HNPost(Dict{String,Any}(Pair{String,Any}("by", ...)
julia> topstories = HackerNews.HN(HackerNews.TopStories, 2)
HackerNews.HN(HackerNews.TopStories, 2, false)
julia> result = HackerNews.getinfo(topstories)
INFO: fetching HackerNews.TopStories...
INFO: generating post data...
2-element Array{HackerNews.HNPost,1}:
HackerNews.HNPost(Dict{String,Any}(Pair{String,Any}("by", ....)
HackerNews.HNPost(Dict{String,Any}(Pair{String,Any}("by", ...)
# getting the type of result
julia> typeof(result)
Array{HackerNews.HNPost,1}
# data field respresnt the raw Hackernews API response
julia> result[1].data
Dict{String,Any} with 8 entries:
"by" => "KKKKkkkk1"
"descendants" => 0
"score" => 7
"time" => 1520836426
"id" => 16566536
"title" => "Intel Fights for Its Future"
"type" => "story"
"url" => "https://mondaynote.com/intel-fights-for-its-future-6498f886992b"
# accessing data using fields, AWESOME!
julia> result[1].id
16566536
julia> result[1].by
"KKKKkkkk1"
julia> result[1].title
"Intel Fights for Its Future"Updates can be related to profiles as well as posts,
- for User updates, set
user_related=truewhile instantiating theHNtype object - for Item updates,
HNfollows default settings which isuser_related=false
# posts related updates
julia> item_updates = HackerNews.HN(HackerNews.Updates, 1, false)
HackerNews.HN(HackerNews.Updates, 1, false)
julia> HackerNews.getinfo(item_updates)
INFO: fetching updates..
INFO: generating post data...
1-element Array{HackerNews.HNPost,1}:
HackerNews.HNPost(Dict{String,Any}(Pair{String,Any}("by", ...)
# user related updates
julia> user_updates = HackerNews.HN(HackerNews.Updates, 1, true)
HackerNews.HN(HackerNews.Updates, 1, true)
julia> HackerNews.getinfo(user_updates)
INFO: fetching updates..
INFO: generating user data...
1-element Array{HackerNews.HNUser,1}:
HackerNews.HNUser(Dict{String,Any}(Pair{String,Any}("submitted", Any[...])julia> HackerNews.getuser("pg")
HackerNews.HNUser(Dict{String,Any}(Pair{String,Any}("submitted", ...)
# get the raw Hackernews api result inside data field
julia> HackerNews.getuser("pg").data
Dict{String,Any} with 5 entries:
"submitted" => Any[10484520, 10071788, 10071052, 10071018, 10070939, 10070787, 10070703, 10070527, 10070299, 10070175 … 36, 34, 31, 22, …
"karma" => 155111
"about" => "Bug fixer."
"id" => "pg"
"created" => 1160418092
# Again, awesome!
julia> HackerNews.getuser("pg").id
"pg"
julia> HackerNews.getuser("pg").karma
155111- Open a PR with the detailed expaination of the issue.
- Reach me out here