docs.md

Typedefs

Stash : Class

Credentials : Object

User credentials required for most API calls

Stash : Class

Kind: global typedef

• Stash : Class
  • .authenticate(credentials)
  • .all()
  • .cards(credentials)
  • .cardDetails(credentials)
  • .userDetails(credentials)
  • .investorApplication(credentials)
  • .bankAccounts(credentials)
  • .autoStash(credentials)
  • .taxDocuments(credentials)
  • .tradeConfirms(credentials)
  • .accountHistory(credentials, filters)
  • .portfolio(credentials)
  • .buy(credentials, params)
  • .approveBankAccount(credentials, amount_1, amount_2)

Stash.authenticate(credentials)

Authenticate user

Kind: static method of Stash

Param	Type	Description
credentials	Object	Account credentials
credentials.email	string	User's email address
credentials.password	string	User's account password

Stash.all()

Get all cards available

Kind: static method of Stash

Stash.cards(credentials)

Get available cards

Kind: static method of Stash

Param	Type	Description
credentials	Credentials	User's account credentials

Stash.cardDetails(credentials)

Kind: static method of Stash

Param	Type	Description
credentials	Credentials	User's account credentials

Stash.userDetails(credentials)

Get user account details

Kind: static method of Stash

Param	Type	Description
credentials	Credentials	User's account credentials

Stash.investorApplication(credentials)

Get user's investor application

Kind: static method of Stash

Param	Type	Description
credentials	Credentials	User's account credentials

Stash.bankAccounts(credentials)

Get user's bank accounts

Kind: static method of Stash

Param	Type	Description
credentials	Credentials	User's account credentials

Stash.autoStash(credentials)

Get user auto stash details

Kind: static method of Stash

Param	Type	Description
credentials	Credentials	User's account credentials

Stash.taxDocuments(credentials)

Get user's tax documents

Kind: static method of Stash

Param	Type	Description
credentials	Credentials	User's account credentials

Stash.tradeConfirms(credentials)

Get user's trade confirms

Kind: static method of Stash

Param	Type	Description
credentials	Credentials	User's account credentials

Stash.accountHistory(credentials, filters)

Get user's Account History

Kind: static method of Stash

Param	Type	Description
credentials	Credentials	User's account credentials
filters	Object	Filter paramenters
filters.before	string	Unix datetime
filters.after	string	Unix datetime

Stash.portfolio(credentials)

Get an account portfolio

Kind: static method of Stash

Param	Type	Description
credentials	Credentials	User's account credentials
account_id	string	The ID of the account you are trying to get the porfolio for (can be found under accounts from userDetails)

Stash.buy(credentials, params)

Place a buy order

Kind: static method of Stash

Param	Type	Description
credentials	Credentials	User's account credentials
params	Object	Parameters for the purchase
params.value	number	The dollar amount you wish to purchase. Minimum is 5.
params.card_id	number	The ID of the card you wish to purchase with.

Stash.approveBankAccount(credentials, amount_1, amount_2)

Approve a bank account by providing two dollar amounts

Kind: static method of Stash

Param	Type	Description
credentials	Credentials	User's account credentials
amount_1	number	Dollar amount 1
amount_2	number	Dollar amount 2

Credentials : Object

User credentials required for most API calls

Kind: global typedef
Properties

Name	Type	Description
access_token	string	User's Access Token
user_id	string	User's ID
uuid	string	User's UUID