profile: Overview of User's System Profile

In JARVIS001011/account: Wrapper for 'GDAX' Cryptocurrency Exchange

Description

This is an auth based function. User must have valid api keys generated by GDAX which must be passed as mandatory arguments. This function takes no additional arguments and returns system identifiable information for the user and the status of the profile. If active, the profile can be used for trading. If pending, the profile is currently being created. If locked, the profile is undergoing a rebalance. If default, you were not able repay funding after a margin call or expired funding and now have a default. The complete profile response gets a lot of information which can be more easily fetched by accounts. This functions trims down the complete response only to the information that cannot be sought by other methods.

Usage

profile(api.key, secret, passphrase)

Arguments

api.key	Mandatory character value. This is the API key as generated by GDAX. Typically a 32 character value.
secret	Mandatory character value. This is the API secret as generated by GDAX. Typically a 88 character value.
passphrase	Mandatory character value. This is the passphrase as generated by GDAX. Typically a 11 character value.

Value

A dataframe with current status, system generated user id and profile id.

Examples

## Not run: 
profile(api.key = your_key, secret = your_api_secret, passphrase = your_api_pass)

## End(Not run)

JARVIS001011/account documentation built on May 6, 2019, 12:06 p.m.