README.md

Getting started

This API provides an aggregated, unified access point to many cryptocurrency exchanges and fiat-to-cryptocurrency onramps.

How to Build

This client library is a Ruby gem which can be compiled and used in your Ruby and Ruby on Rails project. This library requires a few gems from the RubyGems repository.

1. Open the command line interface or the terminal and navigate to the folder containing the source code.
2. Run gem build gem_api.gemspec to build the gem.
3. Once built, the gem can be installed on the current work environment using gem install gem_api-1.2.10.gem

How to Use

The following section explains how to use the GemApi Ruby Gem in a new Rails project using RubyMine™. The basic workflow presented here is also applicable if you prefer using a different editor or IDE.

1. Starting a new project

Close any existing projects in RubyMine™ by selecting File -> Close Project. Next, click on Create New Project to create a new project from scratch.

Next, provide TestApp as the project name, choose Rails Application as the project type, and click OK.

In the next dialog make sure that correct Ruby SDK is being used (minimum 2.0.0) and click OK.

This will create a new Rails Application project with an existing set of files and folder.

2. Add reference of the gem

In order to use the GemApi gem in the new project we must add a gem reference. Locate the Gemfile in the Project Explorer window under the TestApp project node. The file contains references to all gems being used in the project. Here, add the reference to the library gem by adding the following line: gem 'gem_api', '~> 1.2.10'

3. Adding a new Rails Controller

Once the TestApp project is created, a folder named controllers will be visible in the Project Explorer under the following path: TestApp > app > controllers. Right click on this folder and select New -> Run Rails Generator....

Selecting the said option will popup a small window where the generator names are displayed. Here, select the controller template.

Next, a popup window will ask you for a Controller name and included Actions. For controller name provide Hello and include an action named Index and click OK.

A new controller class anmed HelloController will be created in a file named hello_controller.rb containing a method named Index. In this method, add code for initialization and a sample for its usage.

How to Test

You can test the generated SDK and the server with automatically generated test cases as follows:

1. From terminal/cmd navigate to the root directory of the SDK.
2. Invoke: bundle exec rake

Initialization

Authentication

In order to setup authentication and initialization of the API client, you need the following information.

Parameter	Description
x_gem_api_key	Accepts an API Key generated for your Application. If you don't have an API Key yet, go to https://gem.co to sign up and generate your key.
x_gem_access_timestamp	Accepts current timestamp as used in the request signature.
x_gem_signature	Accepts a valid signature for your request. You must generate this signature using your Gem API Secret, and following the procedure outlined at <http://developers.gem.co/reference#authentication-1.

API client can be initialized as following.

# Configuration parameters and credentials
x_gem_api_key = 'x_gem_api_key' # Accepts an API Key generated for your Application. If you don't have an API Key yet, go to <https://gem.co> to sign up and generate your key.
x_gem_access_timestamp = 'x_gem_access_timestamp' # Accepts current timestamp as used in the request signature.
x_gem_signature = 'x_gem_signature' # Accepts a valid signature for your request. You must generate this signature using your Gem API Secret, and following the procedure outlined at <http://developers.gem.co/reference#authentication-1.

client = GemApi::GemApiClient.new(
  x_gem_api_key: x_gem_api_key,
  x_gem_access_timestamp: x_gem_access_timestamp,
  x_gem_signature: x_gem_signature
)

The added initlization code can be debugged by putting a breakpoint in the Index method and running the project in debug mode by selecting Run -> Debug 'Development: TestApp'.

Class Reference

List of Controllers

• ConnectionsController
• ProfilesController
• UserManagementController
• InstitutionsController
• AccountsController
• TransactionsController
• AssetsController

ConnectionsController

Get singleton instance

The singleton instance of the ConnectionsController class can be accessed from the API Client.

connections_controller = client.connections

get_connections

Get a list of Connections.

def get_connections(user_id = nil); end

Parameters

Parameter	Tags	Description
user_id	Optional	TODO: Add a parameter description

Example Usage

user_id = 3fa85f64-5717-4562-b3fc-2c963f66afa6

result = connections_controller.get_connections(user_id)

create_connection

Create a new Connection object and receive an access token.

def create_connection(body,
                          user_id = nil); end

Parameters

Parameter	Tags	Description
body	Required	TODO: Add a parameter description
user_id	Optional	TODO: Add a parameter description

Example Usage

body = { 'key' => 'value' }
user_id = UUID.new

result = connections_controller.create_connection(body, user_id)

get_connection

Retrieves a Connection object by its identifier.

def get_connection(id); end

Parameters

Parameter	Tags	Description
id	Required	TODO: Add a parameter description

Example Usage

id = 3fa85f64-5717-4562-b3fc-2c963f66afa6

result = connections_controller.get_connection(id)

put_connection

Update Connection with new credentials.

def put_connection(id,
                       body); end

Parameters

Parameter	Tags	Description
id	Required	TODO: Add a parameter description
body	Required	TODO: Add a parameter description

Example Usage

id = UUID.new
body = { 'key' => 'value' }

result = connections_controller.put_connection(id, body)

delete_connection

Delete a Connection, permanently revoking access.

def delete_connection(id); end

Parameters

Parameter	Tags	Description
id	Required	TODO: Add a parameter description

Example Usage

id = 3fa85f64-5717-4562-b3fc-2c963f66afa6

result = connections_controller.delete_connection(id)

create_coinbase_oauth_complete

Coinbase OAuth Complete

def create_coinbase_oauth_complete(body); end

Parameters

Parameter	Tags	Description
body	Required	TODO: Add a parameter description

Example Usage

body = OauthRequestFormat.new

result = connections_controller.create_coinbase_oauth_complete(body)

Back to List of Controllers

ProfilesController

Get singleton instance

The singleton instance of the ProfilesController class can be accessed from the API Client.

profiles_controller = client.profiles

get_profiles

Get a list of Profiles.

def get_profiles(user_id = nil); end

Parameters

Parameter	Tags	Description
user_id	Optional	TODO: Add a parameter description

Example Usage

user_id = 3fa85f64-5717-4562-b3fc-2c963f66afa6

result = profiles_controller.get_profiles(user_id)

create_profile

Create a new Profile object and receive an access token.

def create_profile(body,
                       user_id = nil); end

Parameters

Parameter	Tags	Description
body	Required	TODO: Add a parameter description
user_id	Optional	TODO: Add a parameter description

Example Usage

body = NewProfile.new
user_id = UUID.new

result = profiles_controller.create_profile(body, user_id)

create_temporary_profile

Create a temporary Profile object that expires in 1 hour. Any data associated with an expired Profile is permanently deleted. This endpoint returns an access token.

def create_temporary_profile(body); end

Parameters

Parameter	Tags	Description
body	Required	TODO: Add a parameter description

Example Usage

body = NewProfile.new

result = profiles_controller.create_temporary_profile(body)

get_profile

Retrieves Profile objects for a User or an Application.

def get_profile(id); end

Parameters

Parameter	Tags	Description
id	Required	TODO: Add a parameter description

Example Usage

id = 3fa85f64-5717-4562-b3fc-2c963f66afa6

result = profiles_controller.get_profile(id)

put_profile

Update Profile with new or changed attributes.

def put_profile(id,
                    body); end

Parameters

Parameter	Tags	Description
id	Required	TODO: Add a parameter description
body	Required	TODO: Add a parameter description

Example Usage

id = UUID.new
body = NewProfile.new

result = profiles_controller.put_profile(id, body)

delete_profile

Delete a Profile, permanently revoking access.

def delete_profile(id); end

Parameters

Parameter	Tags	Description
id	Required	TODO: Add a parameter description

Example Usage

id = 3fa85f64-5717-4562-b3fc-2c963f66afa6

result = profiles_controller.delete_profile(id)

Back to List of Controllers

UserManagementController

Get singleton instance

The singleton instance of the UserManagementController class can be accessed from the API Client.

userManagement_controller = client.user_management

get_users

Get a list of Users associated with your Application.

def get_users; end

Example Usage

result = userManagement_controller.get_users()

create_user

Create a Gem User. A User may either be private (limited to your application) or public (passportable across the Gem network of partners).

def create_user(body = nil); end

Parameters

Parameter	Tags	Description
body	Optional	TODO: Add a parameter description

Example Usage

body = NewUser.new

result = userManagement_controller.create_user(body)

update_consent_user

Record user's consent to Gem's Terms of Service and Privacy Policy. This is used by our widgets.

def update_consent_user(id); end

Parameters

Parameter	Tags	Description
id	Required	TODO: Add a parameter description

Example Usage

id = 3fa85f64-5717-4562-b3fc-2c963f66afa6

result = userManagement_controller.update_consent_user(id)

get_user

Retrieves User and its linked Connections and Profiles.

def get_user(id); end

Parameters

Parameter	Tags	Description
id	Required	TODO: Add a parameter description

Example Usage

id = 3fa85f64-5717-4562-b3fc-2c963f66afa6

result = userManagement_controller.get_user(id)

delete_user

Delete a User. For private users, this permanently deletes the user. For public users, this revokes your access to the public user, but doesn't delete the user.

def delete_user(id); end

Parameters

Parameter	Tags	Description
id	Required	TODO: Add a parameter description

Example Usage

id = 3fa85f64-5717-4562-b3fc-2c963f66afa6

result = userManagement_controller.delete_user(id)

Back to List of Controllers

InstitutionsController

Get singleton instance

The singleton instance of the InstitutionsController class can be accessed from the API Client.

institutions_controller = client.institutions

get_institutions

Get a list of Institutions that Gem supports.

def get_institutions; end

Example Usage

result = institutions_controller.get_institutions()

get_institution

Get details about an Institution.

def get_institution(id); end

Parameters

Parameter	Tags	Description
id	Required	TODO: Add a parameter description

Example Usage

id = 3fa85f64-5717-4562-b3fc-2c963f66afa6

result = institutions_controller.get_institution(id)

create_institution_user

Open a new user account at an Institution. Typically a new user will be required to submit a KYC profile. You may attach an existing Profile object to this request. This endpoint is currently supported for Wyre and Coinify.

def create_institution_user(body); end

Parameters

Parameter	Tags	Description
body	Required	TODO: Add a parameter description

Example Usage

body = NewInstitutionUser.new

result = institutions_controller.create_institution_user(body)

get_institution_user

Returns data about a user's account at an Institution, including their current status of approvals on KYC and trading limits.

def get_institution_user(id); end

Parameters

Parameter	Tags	Description
id	Required	TODO: Add a parameter description

Example Usage

id = 3fa85f64-5717-4562-b3fc-2c963f66afa6

result = institutions_controller.get_institution_user(id)

Back to List of Controllers

AccountsController

Get singleton instance

The singleton instance of the AccountsController class can be accessed from the API Client.

accounts_controller = client.accounts

get_accounts

Get a list of wallets and payment methods attached to an InstitutionUser.

def get_accounts(user_id = nil,
                     connection_id = nil); end

Parameters

Parameter	Tags	Description
user_id	Optional	TODO: Add a parameter description
connection_id	Optional	TODO: Add a parameter description

Example Usage

user_id = 3fa85f64-5717-4562-b3fc-2c963f66afa6
connection_id = 3fa85f64-5717-4562-b3fc-2c963f66afa6

result = accounts_controller.get_accounts(user_id, connection_id)

create_account

Some Institutions support creating new payment methods and wallets via API. This endpoint gives you a simple way to create a new wallet or payment method at your user's Institution. Supported Institutions include: Wyre, Coinify, Coinbase (coming soon).

def create_account(body); end

Parameters

Parameter	Tags	Description
body	Required	TODO: Add a parameter description

Example Usage

body = Account.new

result = accounts_controller.create_account(body)

get_account

Get details about an account, including name, balance, base currency and other details that may be available.

def get_account(id); end

Parameters

Parameter	Tags	Description
id	Required	TODO: Add a parameter description

Example Usage

id = 3fa85f64-5717-4562-b3fc-2c963f66afa6

result = accounts_controller.get_account(id)

Back to List of Controllers

TransactionsController

Get singleton instance

The singleton instance of the TransactionsController class can be accessed from the API Client.

transactions_controller = client.transactions

get_transactions

View all transactions submitted through your Application.

def get_transactions(page = nil); end

Parameters

Parameter	Tags	Description
page	Optional	TODO: Add a parameter description

Example Usage

page = 183

result = transactions_controller.get_transactions(page)

create_transaction

Initiate a buy or transfer transaction for an existing Connection. Transactions take a source account, a destination account, an amount, and a currency. Successfully submitted transactions return a transaction_id to monitor the status of the transaction in future API calls or webhook notifications.

def create_transaction(body); end

Parameters

Parameter	Tags	Description
body	Required	TODO: Add a parameter description

Example Usage

body = NewTransaction.new

result = transactions_controller.create_transaction(body)

get_transaction

Get transaction details by transaction_id.

def get_transaction(id); end

Parameters

Parameter	Tags	Description
id	Required	TODO: Add a parameter description

Example Usage

id = 3fa85f64-5717-4562-b3fc-2c963f66afa6

result = transactions_controller.get_transaction(id)

delete_cancel_transaction

Cancel a pending transaction. This may not always be possible for all third-party services.

def delete_cancel_transaction(id); end

Parameters

Parameter	Tags	Description
id	Required	TODO: Add a parameter description

Example Usage

id = 3fa85f64-5717-4562-b3fc-2c963f66afa6

result = transactions_controller.delete_cancel_transaction(id)

create_transfer

Withdraw cryptocurrency from a source Account to a BlockchainAddress or an Account.

def create_transfer(body); end

Parameters

Parameter	Tags	Description
body	Required	TODO: Add a parameter description

Example Usage

body = Transaction.new

result = transactions_controller.create_transfer(body)

create_buy

Buy cryptocurrency from a source fiat Account. We currently support Wyre and Coinify.

def create_buy(body); end

Parameters

Parameter	Tags	Description
body	Required	TODO: Add a parameter description

Example Usage

body = Transaction.new

result = transactions_controller.create_buy(body)

Back to List of Controllers

AssetsController

Get singleton instance

The singleton instance of the AssetsController class can be accessed from the API Client.

assets_controller = client.assets

get_assets

Returns a full list of assets in the Gem ecosystem, with our normalized ticker symbols.

def get_assets(category = nil); end

Parameters

Parameter	Tags	Description
category	Optional	TODO: Add a parameter description

Example Usage

category = GemApi::AssetCategoriesEnum::CRYPTOCURRENCY

result = assets_controller.get_assets(category)

get_asset

Resolve to Institution-specific ticker symbol by specifying the Gem Asset ID.

def get_asset(id); end

Parameters

Parameter	Tags	Description
id	Required	TODO: Add a parameter description

Example Usage

id = 'bitcoin'

result = assets_controller.get_asset(id)

get_assets_prices

Returns current asset price quotes for an array of assets. Quotes may be filtered by source (e.g. Coinbase, CoinMarketCap, Wyre), and may be returned in the currency of your choice (e.g. USD, EUR, BTC).

def get_assets_prices(quote_asset_id = nil,
                          asset_ids = nil); end

Parameters

Parameter	Tags	Description
quote_asset_id	Optional	TODO: Add a parameter description
asset_ids	Optional Collection	TODO: Add a parameter description

Example Usage

quote_asset_id = 'bitcoin'
asset_ids = ['asset_ids']

result = assets_controller.get_assets_prices(quote_asset_id, asset_ids)

get_price

Returns current asset price quote for a single asset. Quotes may be filtered by source (e.g. Coinbase, CoinMarketCap, Wyre), and may be returned in the currency of your choice (e.g. USD, EUR, BTC).

def get_price(asset_id,
                  quote_asset_id); end

Parameters

Parameter	Tags	Description
asset_id	Required	TODO: Add a parameter description
quote_asset_id	Required	TODO: Add a parameter description

Example Usage

asset_id = 'bitcoin'
quote_asset_id = 'bitcoin'

result = assets_controller.get_price(asset_id, quote_asset_id)

Back to List of Controllers