Packages

ex_bovespa

0.8.0
0.8.0 0.7.0 0.6.0 0.5.0 0.4.1 0.4.0 0.3.0 0.2.0 0.1.1 0.1.0

A crawler for retrieving B3's stock list

HexDocs

Current section

Files

Jump to
Readme
10 Versions
5 Dependencies
Dependants
Files
Activity
ex_bovespa lib ex_bovespa_behaviour.ex
Raw

lib/ex_bovespa_behaviour.ex 

defmodule ExBovespa.Behaviour do

  @moduledoc false



  alias ExBovespa.Structs.{Broker, PriceRowHeader, PriceRowItem, Stock}



  @type success_price_return :: {:ok, [header: PriceRowHeader.t(), items: list(PriceRowItem.t())]}



  @callback stock_list() :: {:ok, list(Stock.t())} | {:error, :invalid_response}



  @callback broker_list() :: {:ok, list(Broker.t())} | {:error, :invalid_response}



  @callback historical_price(year :: String.t()) ::

              success_price_return() | {:error, :invalid_response}



  @callback historical_price(year :: String.t(), month :: String.t()) ::

              success_price_return() | {:error, :invalid_response}



  @callback historical_price(year :: String.t(), month :: String.t(), day :: String.t()) ::

              success_price_return() | {:error, :invalid_response}

end