ex_bitmex

v0.5.0

ex_bitmex v0.5.0 ExBitmex.Rest.Position.Index

Link to this section Summary

Types

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

Functions

get(credentials, params \\ %{})

Link to this section Types

Link to this type

auth_error_response()

auth_error_response() :: ExBitmex.Rest.Request.auth_error_response()
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()} | auth_error_response()