ExGdax (ExGdax v0.2.0) View Source

GDAX API client.

Link to this section Summary

Functions

cancel_order(order_id, config \\ nil)

Cancel a previously placed order.

cancel_orders(config \\ nil)

Cancel all open orders.

close_position(params, config \\ nil)

Close your position.

create_order(params, config \\ nil)

Place a new order.

create_report(params, config \\ nil)

Create a report.

deposit_from_coinbase(params, config \\ nil)

Deposit funds from a coinbase account.

deposit_from_payment_method(params, config \\ nil)

Deposit funds from a payment method.

get_account(account_id, config \\ nil)

Get an account.

get_order(order_id, config \\ nil)

Get an order.

get_order_book(product_id, params \\ %{})

Get a list of open orders for a product.

get_position(config \\ nil)

An overview of your profile.

get_report(report_id, config \\ nil)

Get report status.

get_stats(product_id)

Get 24 hr stats for a product.

get_ticker(product_id)

Snapshot information about the last trade (tick), best bid/ask and 24h volume.

get_time()

Get the API server time.

list_account_history(account_id, params \\ %{}, config \\ nil)

List activity for an account.

list_accounts(config \\ nil)

List accounts.

list_coinbase_accounts(config \\ nil)

List your coinbase accounts.

list_currencies()

List known currencies.

list_fills(params \\ %{}, config \\ nil)

Get a list of recent fills.

list_funding(params \\ %{}, config \\ nil)

List funding records.

list_historic_rates(product_id, params \\ %{})

Historic rates for a product.

list_holds(account_id, params \\ %{}, config \\ nil)

Lists holds on an account for active orders or withdraw requests.

list_orders(params \\ %{}, config \\ nil)

List open orders.

list_payment_methods(config \\ nil)

List your payment methods.

list_products()

Get a list of available currency pairs for trading.

list_trades(product_id, params \\ %{})

List the latest trades for a product.

list_trailing_volume(config \\ nil)

List your 30-day trailing volume for all products.

margin_transfer(params, config \\ nil)

Transfer funds between your standard/default profile and a margin profile.

repay_funding(params, config \\ nil)

Repay funding. Repays the older funding records first.

user_fee_rate(config \\ nil)

Get your current fee rate based on the 30-day trailing USD volume

withdraw_to_coinbase(params, config \\ nil)

Withdraw funds to a coinbase account.

withdraw_to_crypto(params, config \\ nil)

Withdraw funds to a crypto address.

withdraw_to_payment_method(params, config \\ nil)

Withdraw funds to a payment method.

Link to this section Functions

cancel_order(order_id, config \\ nil)

Cancel a previously placed order.

Examples

iex> ExGdax.cancel_order("XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX")
{:ok, ["XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX"]}

cancel_orders(config \\ nil)

Cancel all open orders.

Examples

iex> ExGdax.cancel_orders()
{:ok, ["XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX"]}

close_position(params, config \\ nil)

Close your position.

Parameters

Name	Description
`repay_only`	Either `true` or `false`

create_order(params, config \\ nil)

Place a new order.

Refer to params listed in GDAX API docs

Examples

iex> ExGdax.create_order(%{type: "limit", side: "buy", product_id: "ETH-USD", price: "0.50", size: "1.0"})
{:ok,
 %{"created_at" => "2017-08-20T23:29:17.752637Z",
   "executed_value" => "0.0000000000000000",
   "fill_fees" => "0.0000000000000000", "filled_size" => "0.00000000",
   "id" => "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "post_only" => false,
   "price" => "0.50000000", "product_id" => "ETH-USD",
   "settled" => false, "side" => "buy", "size" => "1.00000000",
   "status" => "pending", "stp" => "dc", "time_in_force" => "GTC",
   "type" => "limit"}}

create_report(params, config \\ nil)

Create a report.

Parameters

Name	Description
`type`	`fills` or `account`.
`start_date`	Starting date for the report (inclusive).
`end_date`	Ending date for the report (inclusive).
`product_id`	ID of the product to generate a fills report for. E.g. BTC-USD. Required if `type` is `fills`.
`account_id`	ID of the account to generate an account report for. Required if `type` is `account`.
`format`	`pdf` or `csv` (defualt is `pdf`).
`email`	Email address to send the report to (optional).

deposit_from_coinbase(params, config \\ nil)

Deposit funds from a coinbase account.

Parameters

Name	Description
`amount`	The amount to deposit.
`currency`	The type of currency.
`coinbase_account_id`	ID of the coinbase account.

Examples

iex> ExGdax.deposit_from_coinbase(%{amount: "0.1", currency: "ETH", coinbase_account_id: "XXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX"})
{:ok,
 %{"amount" => "0.10000000", "currency" => "ETH",
   "id" => "XXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX"}}

deposit_from_payment_method(params, config \\ nil)

Deposit funds from a payment method.

Parameters

Name	Description
`amount`	The amount to deposit.
`currency`	The type of currency.
`payment_method_id`	ID of the payment method.

get_account(account_id, config \\ nil)

Get an account.

Examples

iex> ExGdax.get_account(account["id"])
{:ok,
 %{"available" => "0.0000000000000000", "balance" => "0.0000000000000000",
    "currency" => "USD", "hold" => "0.0000000000000000",
    "id" => "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
    "profile_id" => "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX"}}

get_order(order_id, config \\ nil)

Get an order.

Examples

iex> ExGdax.get_order(order["id"])
{:ok,
 %{"created_at" => "2017-08-20T23:31:49.235409Z",
   "executed_value" => "0.0000000000000000",
   "fill_fees" => "0.0000000000000000", "filled_size" => "0.00000000",
   "id" => "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "post_only" => true,
   "price" => "0.75000000", "product_id" => "ETH-USD",
   "settled" => false, "side" => "buy", "size" => "1.00000000",
   "status" => "open", "stp" => "dc", "time_in_force" => "GTC",
   "type" => "limit"}}

get_order_book(product_id, params \\ %{})

Get a list of open orders for a product.

Parameters

Name	Description
`level`	Response detail. Valid options are 1, 2, or 3.

Examples

iex> ExGdax.get_order_book("ETH-USD")
{:ok,
 %{"asks" => [["200.42", "28.447359", 4]],
   "bids" => [["200.41", "11.35615248", 3]], "sequence" => 873754533}}

iex> ExGdax.order_book("ETH-USD", %{level: 2})
{:ok,
 %{"asks" => [["200.49", "73.898254", 6], ["200.5", "1.017412", 2],
    ["200.51", "0.017366", 1], ["200.52", "0.017387", 1], ...],
   "bids" => [["200.48", "0.7", 2], ["200.47", "0.01", 1],
    ["200.42", "0.76212582", 1], ["200.32", "0.2", 1], ...]}

get_position(config \\ nil)

An overview of your profile.

Examples

iex> ExGdax.get_position()
{:ok,
 %{"accounts" => %{"BTC" => %{"balance" => "0.0000000000000000",
       "default_amount" => "0", "funded_amount" => "0",
       "hold" => "0.0000000000000000",
       "id" => "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX"},
     "ETH" => %{"balance" => "0.0000000000000000", "default_amount" => "0",
       "funded_amount" => "0", "hold" => "0.0000000000000000",
       "id" => "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX"},
     "LTC" => %{"balance" => "0.0000000000000000", "default_amount" => "0",
       "funded_amount" => "0", "hold" => "0.0000000000000000",
       "id" => "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX"},
     "USD" => %{"balance" => "0.0000000000000000", "default_amount" => "0",
       "funded_amount" => "0", "hold" => "0.0000000000000000",
       "id" => "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX"}},
   "profile_id" => "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "status" => "active",
   "user_id" => "XXXXXXXXXXXXXXXXXXXXXXXX"}}

get_report(report_id, config \\ nil)

Get report status.

get_stats(product_id)

Get 24 hr stats for a product.

Examples

iex> ExGdax.get_stats("ETH-USD")
{:ok,
 %{"high" => "205.80000000", "last" => "201.68000000", "low" => "194.42000000",
   "open" => "197.97000000", "volume" => "143965.79255890",
   "volume_30day" => "9270459.77394214"}}

get_ticker(product_id)

Snapshot information about the last trade (tick), best bid/ask and 24h volume.

Examples

iex> ExGdax.get_ticker("ETH-USD")
{:ok,
 %{"ask" => "200.47", "bid" => "200.46", "price" => "200.47000000",
   "size" => "2.65064800", "time" => "2017-07-27T08:00:43.697000Z",
   "trade_id" => 8430635, "volume" => "144080.88916080"}}

get_time()

Get the API server time.

Examples

iex> EcGdax.get_time()
{:ok, %{"epoch" => 1501141821.835, "iso" => "2017-07-27T07:50:21.835Z"}}

list_account_history(account_id, params \\ %{}, config \\ nil)

List activity for an account.

Parameters

Name	Description
`before`	Request page before (newer) this pagination id.
`after`	Request page after (older) this pagination id.
`limit`	Number of results per request. Maximum 100. (default 100)

Examples

iex> ExGdax.list_account_history(account["id"], %{limit: 5})
{:ok,
 [%{"amount" => "0.0000000000000000", "balance" => "0.0000000000000000",
    "created_at" => "2017-07-08T15:26:17.04917Z",
    "details" => %{"transfer_id" => "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
      "transfer_type" => "withdraw"}, "id" => XXXXXXXX, "type" => "transfer"}, ...]}

list_accounts(config \\ nil)

List accounts.

Examples

iex> ExGdax.list_accounts()
{:ok,
 [%{"available" => "0.0000000000000000", "balance" => "0.0000000000000000",
    "currency" => "USD", "hold" => "0.0000000000000000",
    "id" => "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
    "profile_id" => "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX"}, ...]}

list_coinbase_accounts(config \\ nil)

List your coinbase accounts.

Examples

iex> ExGdax.list_coinbase_accounts()
{:ok,
 [%{"active" => true, "balance" => "0.00000000", "currency" => "ETH",
    "id" => "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "name" => "ETH Wallet",
    "primary" => false, "type" => "wallet"}, ...]}

list_currencies()

List known currencies.

Examples

iex> ExGdax.list_currencies()
{:ok,
 [%{"id" => "BTC", "min_size" => "0.00000001", "name" => "Bitcoin"},
  %{"id" => "ETH", "min_size" => "0.00000001", "name" => "Ether"}, ...]}

list_fills(params \\ %{}, config \\ nil)

Get a list of recent fills.

Parameters

Name	Description
`order_id`	Limit list of fills to this order_id.
`product_id`	Limit list of fills to this product_id.
`before`	Request page before (newer) this pagination id.
`after`	Request page after (older) this pagination id.
`limit`	Number of results per request. Maximum 100. (default 100)

Examples

iex> ExGdax.list_fills(%{product_id: "ETH-USD", limit: 1})
{:ok,
 [%{"created_at" => "2017-08-12T21:25:43.453Z",
    "fee" => "0.0000000000000000", "liquidity" => "M",
    "order_id" => "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
    "price" => "305.00000000", "product_id" => "ETH-USD",
    "profile_id" => "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
    "settled" => true, "side" => "buy", "size" => "0.29000000",
    "trade_id" => XXXXXXX, "user_id" => "XXXXXXXXXXXXXXXXXXXXXXX"}]}

list_funding(params \\ %{}, config \\ nil)

List funding records.

Parameters

Name	Options	Description
`status`	outstanding, settled, or rejected	Limit list of funding records to these statuses.
`before`		Request page before (newer) this pagination id.
`after`		Request page after (older) this pagination id.
`limit`		Number of results per request. Maximum 100. (default 100)

list_historic_rates(product_id, params \\ %{})

Historic rates for a product.

Parameters

Name	Description
`start`	Start time in ISO 8601.
`end`	End time in ISO 8601.
`granularity`	Desired timeslice in seconds.

Examples

iex> ExGdax.list_historic_rates("ETH-USD")
{:ok,
 [[1501142880, 200.43, 200.43, 200.43, 200.43, 5.6956], ...]}

list_holds(account_id, params \\ %{}, config \\ nil)

Lists holds on an account for active orders or withdraw requests.

Parameters

Name	Description
`before`	Request page before (newer) this pagination id.
`after`	Request page after (older) this pagination id.
`limit`	Number of results per request. Maximum 100. (default 100)

Examples

iex> ExGdax.list_holds(account["id"])
{:ok, []}

list_orders(params \\ %{}, config \\ nil)

List open orders.

Parameters

Name	Default	Description
`status`	[open, pending, active]	Limit list of orders to these statuses.
`product_id`		Only list orders for a specific product.
`before`		Request page before (newer) this pagination id.
`after`		Request page after (older) this pagination id.
`limit`		Number of results per request. Maximum 100. (default 100)

Examples

iex> ExGdax.list_orders(%{status: "open"})
{:ok,
 [%{"created_at" => "2017-08-20T23:31:49.235409Z",
    "executed_value" => "0.0000000000000000",
    "fill_fees" => "0.0000000000000000", "filled_size" => "0.00000000",
    "id" => "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "post_only" => true,
    "price" => "0.75000000", "product_id" => "ETH-USD",
    "settled" => false, "side" => "buy", "size" => "1.00000000",
    "status" => "open", "stp" => "dc", "time_in_force" => "GTC",
    "type" => "limit"}]}

list_payment_methods(config \\ nil)

List your payment methods.

Examples

iex> ExGdax.list_payment_methods()
{:ok,
 [%{"allow_buy" => false, "allow_deposit" => true, "allow_sell" => true,
    "allow_withdraw" => false, "created_at" => "2015-11-03T00:32:02Z",
    "currency" => "USD",
    "fiat_account" => %{"id" => "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
      "resource" => "account",
      "resource_path" => "/v2/accounts/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX"}, ...]}

list_products()

Get a list of available currency pairs for trading.

Examples

iex> ExGdax.list_products()
{:ok,
 [%{"base_currency" => "ETH", "base_max_size" => "5000",
    "base_min_size" => "0.01", "display_name" => "ETH/USD", "id" => "ETH-USD",
    "margin_enabled" => false, "quote_currency" => "USD",
    "quote_increment" => "0.01"}, ...]}

list_trades(product_id, params \\ %{})

List the latest trades for a product.

Parameters

Name	Description
`before`	Request page before (newer) this pagination id.
`after`	Request page after (older) this pagination id.
`limit`	Number of results per request. Maximum 100. (default 100)

Examples

iex> ExGdax.list_trades("ETH-USD")
{:ok,
 [%{"price" => "200.65000000", "side" => "sell", "size" => "1.94831509",
    "time" => "2017-07-27T08:01:54.347Z", "trade_id" => 8430778}, ...]

list_trailing_volume(config \\ nil)

List your 30-day trailing volume for all products.

Examples

iex> ExGdax.list_trailing_volume()
{:ok,
 [%{"exchange_volume" => "8704829.60943332", "product_id" => "ETH-USD",
    "recorded_at" => "2017-07-31T00:17:16.331884Z", "volume" => "1.00000000"}]}

margin_transfer(params, config \\ nil)

Transfer funds between your standard/default profile and a margin profile.

Parameters

Name	Description
`margin_profile_id`	The id of the margin profile you’d like to deposit to or withdraw from.
`type`	`deposit` or `withdraw`.
`currency`	The currency to transfer, ex: `BTC` or `USD`.
`amount`	The amount to transfer between the default and margin profile.

repay_funding(params, config \\ nil)

Repay funding. Repays the older funding records first.

Parameters

Name	Description
`amount`	Amount of currency to repay.
`currency`	The currency, example `USD`.

user_fee_rate(config \\ nil)

Get your current fee rate based on the 30-day trailing USD volume

iex> ExGdax.user_fee_rate() {:ok, %{"fee" => "0.0030", "usd_volume" => nil, "fee_usd_total" => nil}}

withdraw_to_coinbase(params, config \\ nil)

Withdraw funds to a coinbase account.

Parameters

Name	Description
`amount`	The amount to withdraw.
`currency`	The type of currency.
`coinbase_account_id`	ID of the coinbase account.

withdraw_to_crypto(params, config \\ nil)

Withdraw funds to a crypto address.

Parameters

Name	Description
`amount`	The amount to withdraw.
`currency`	The type of currency.
`crypto_address`	A crypto address of the recipient.

Examples

iex> ExGdax.withdraw_to_crypto(%{amount: "0.01", currency: "ETH", crypto_address: "0x30a9f8b57e2dcb519a4e4982ed6379f9dd6a0bfc"})
{:ok,
 %{"amount" => "0.01000000", "currency" => "ETH",
   "id" => "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX"}}

withdraw_to_payment_method(params, config \\ nil)

Withdraw funds to a payment method.

Parameters

Name	Description
`amount`	The amount to withdraw.
`currency`	The type of currency.
`payment_method_id`	ID of the payment method.