ex_bitmex

v0.4.0

ex_bitmex v0.4.0 ExBitmex.Rest.Position.Index

Link to this section Summary

Types

credentials()
params()
position()
rate_limit()

Functions

get(credentials, params \\ %{})

Link to this section Types

Link to this type

credentials()

credentials() :: ExBitmex.Credentials.t()
Link to this type

params()

params() :: map()
Link to this type

position()

position() :: ExBitmex.Position.t()
Link to this type

rate_limit()

rate_limit() :: ExBitmex.RateLimit.t()

Link to this section Functions

Link to this function

get(credentials, params \\ %{})

get(credentials(), params()) ::
  {:ok, [position()], rate_limit()}
  | ExBitmex.Rest.HTTPClient.auth_error_response()