Merge pull request #10 from PyDataBlog:stock_splits

Completed draft of reference API

Author: PyDataBlog

src/PolygonIO.jl

@@ -18,7 +18,9 @@ include("streaming_socket.jl")
 
 ######### Global export of user API  ################
 export PolyOpts, tickers, ticker_types, ticker_details, ticker_details_vX,
-       ticker_news, markets, locales
+       ticker_news, markets, locales, stock_splits, stock_dividends,
+       stock_financials, market_holidays, market_status, stock_exchanges,
+       condition_mappings, crypto_exchanges
 
 
 end

src/reference_api.jl

@@ -135,24 +135,109 @@ function locales(opts::PolyOpts)
 end
 
 ############ Stock Splits  ####################
+"""
+"""
+function stock_splits(opts::PolyOpts, stocksTicker::String)
+    stock_splits_base_url = "https://api.polygon.io/v2/reference/splits/$stocksTicker"
+    params = Dict("apiKey" => opts.api_key)
+    request_json = HTTP.get(stock_splits_base_url, query=params).body |> JSON3.read
 
+    return request_json.results
+end
 
 ############ Stock Dividends  ####################
+"""
+"""
+function stock_dividends(opts::PolyOpts, stocksTicker::String)
+    stock_dividends_base_url = "https://api.polygon.io/v2/reference/dividends/$stocksTicker"
+    params = Dict("apiKey" => opts.api_key)
 
+    request_json = HTTP.get(stock_dividends_base_url, query=params).body |> JSON3.read
+
+    if opts.sink === nothing
+        return request_json.results
+    else
+        return request_json.results |> opts.sink
+    end
+end
 
 ############ Stock Financials  ####################
+"""
+"""
+function stock_financials(opts::PolyOpts, stocksTicker::String; limit=5, kwargs...)
+    stock_financials_base_url = "https://api.polygon.io/v2/reference/financials/$stocksTicker"
+    params = Dict(
+        "apiKey" => opts.api_key,
+        "limit" => limit
+    )
+    # Extract kwargs and add to params
+    merge!(params, Dict(kwargs))
 
+    request_json = HTTP.get(stock_financials_base_url, query=params).body |> JSON3.read
+
+    if opts.sink === nothing
+        return request_json.results
+    else
+        return request_json.results |> opts.sink
+    end
+end
 
 ############ Market Holidays  ####################
+"""
+"""
+function market_holidays(opts::PolyOpts)
+    params = Dict("apiKey" => opts.api_key)
+    request_json = HTTP.get(market_holidays_base_url, query=params).body |> JSON3.read
 
+    if opts.sink === nothing
+        return request_json
+    else
+        return request_json |> opts.sink
+    end
+end
 
 ############ Market Status  ####################
+"""
+"""
+function market_status(opts::PolyOpts)
+    params = Dict("apiKey" => opts.api_key)
+    request_json = HTTP.get(market_status_base_url, query=params).body |> JSON3.read
 
+    return request_json
+end
 
 ############ Stock Exchanges  ####################
+"""
+"""
+function stock_exchanges(opts::PolyOpts)
+    params = Dict("apiKey" => opts.api_key)
+    request_json = HTTP.get(stock_exchanges_base_url, query=params).body |> JSON3.read
 
+    return request_json
+end
 
 ############ Condition Mappings  ####################
+"""
+"""
+function condition_mappings(opts::PolyOpts, tickertype="trades")
+    condition_mappings_base_url = "https://api.polygon.io/v1/meta/conditions/$tickertype"
+    params = Dict("apiKey" => opts.api_key)
+
+    request_json = HTTP.get(condition_mappings_base_url, query=params).body |> JSON3.read
+
+    return request_json
+end
 
+############ Crypto Exchanges ####################
+"""
+"""
+function crypto_exchanges(opts::PolyOpts)
+    params = Dict("apiKey" => opts.api_key)
+    request_json = HTTP.get(crypto_exchanges_base_url, query=params).body |> JSON3.read
 
-############ Crypto Exchanges ####################
+    if opts.sink === nothing
+        return request_json
+    else
+        return request_json |> opts.sink
+    end
+end

src/utils.jl

@@ -6,4 +6,12 @@ ticker_new_base_url = "https://api.polygon.io/v2/reference/news"
 
 markets_base_url = "https://api.polygon.io/v2/reference/markets"
 
-locales_base_url = "https://api.polygon.io/v2/reference/locales"
+locales_base_url = "https://api.polygon.io/v2/reference/locales"
+
+market_holidays_base_url = "https://api.polygon.io/v1/marketstatus/upcoming"
+
+market_status_base_url = "https://api.polygon.io/v1/marketstatus/now"
+
+stock_exchanges_base_url = "https://api.polygon.io/v1/meta/exchanges"
+
+crypto_exchanges_base_url = "https://api.polygon.io/v1/meta/crypto-exchanges"

test/runtests.jl

@@ -13,30 +13,62 @@ const regular_opts = PolyOpts(API_KEY, nothing)
 
 @testset "PolygonIO.jl" begin
     # tickets test
-    @test tickers(tabular_opts, "bitcoin") |> size == (10, )
-    @test tickers(regular_opts, "bitcoin") |> size == (10, )
+    @test tickers(tabular_opts, "bitcoin") |> length == 10
+    @test tickers(regular_opts, "bitcoin") |> length == 10
 
     # ticker_types test
     @test ticker_types(tabular_opts) |> length == 2
     @test ticker_types(regular_opts) |> length == 2
 
     # ticker_details test
-    @test ticker_details(tabular_opts, "AAPL") |> size == (1, )
-    @test ticker_details(regular_opts, "AAPL") |> length == 28
+    @test ticker_details(tabular_opts, "AAPL") |> length == 1
+    @test ticker_details(regular_opts, "AAPL") |> length >= 28
 
     # ticker_details_vX next version test
-    @test ticker_details_vX(tabular_opts, "AAPL", "2019-07-31") |> size == (1, )
+    @test ticker_details_vX(tabular_opts, "AAPL", "2019-07-31") |> length == 1
     @test ticker_details_vX(regular_opts, "AAPL", "2019-07-31") |> length == 19
 
     # ticker_news test
     @test ticker_news(tabular_opts, "AAPL") |> length == 10
     @test ticker_news(regular_opts, "AAPL") |> length == 10
 
     # markets test
-    @test markets(regular_opts) |> length == 7
-    @test markets(tabular_opts) |> size == (7,)
+    @test markets(regular_opts) |> length >= 7
+    @test markets(tabular_opts) |> length >= 7
 
     # locales test
-    @test locales(regular_opts) |> size == (19,)
-    @test locales(tabular_opts) |> size == (19,)
+    @test locales(regular_opts) |> length >= 19
+    @test locales(tabular_opts) |> length >= 19
+
+    # stock_splits test
+    @test stock_splits(regular_opts, "AAPL") |> length >= 4
+    @test stock_splits(tabular_opts, "AAPL") |> length >= 4
+
+    # stock_dividends test
+    @test stock_dividends(regular_opts, "AAPL") |> length >= 65
+    @test stock_dividends(tabular_opts, "AAPL") |> length >= 65
+
+    # stock_financials test
+    @test stock_financials(regular_opts, "AAPL") |> length == 5
+    @test stock_financials(tabular_opts, "AAPL") |> length == 5
+
+    # market_holidays test
+    @test market_holidays(regular_opts) |> length >= 1
+    @test market_holidays(tabular_opts) |> length >= 1
+
+    # market_status test
+    @test market_status(regular_opts) |> length >= 6
+    @test market_status(tabular_opts) |> length >= 6
+
+    # stock_exchanges test
+    @test stock_exchanges(regular_opts) |> length >= 30
+    @test stock_exchanges(tabular_opts) |> length >= 30
+
+    # condition_mappings test
+    @test condition_mappings(regular_opts, "trades") |> length >= 1
+    @test condition_mappings(tabular_opts, "quotes") |> length >= 1
+
+    # stock_exchanges test
+    @test crypto_exchanges(regular_opts) |> length >= 5
+    @test crypto_exchanges(tabular_opts) |> length >= 5
 end