com.metaco.api

Interface MetacoClient

All Known Implementing Classes:

MetacoClientImpl

public interface MetacoClient

Method Summary

Modifier and Type	Method and Description
TransactionBroadcastResult	broadcastTransaction(RawTransaction rawTransaction) Requires Authentication Submit a signed transaction You have to sign each of your inputs of the selected transaction (you will get those details when creating the transaction through Metaco) Then encode the transaction in hexadecimal and send it here
void	cancelOrder(String id) Requires Authentication Cancel the specified order
void	confirmPhoneNumber(ValidateAccountRequest request) Requires Authentication Validate the authenticated account, throws an exception if there is an error
Order	createOrder(NewOrder createOrder) Requires Authentication Create an order using the provided parameters This order will be processed in our system It will require your signature later when the trade state will be Signing
TransactionToSign	createTransaction(NewTransaction newTransaction) Requires Authentication Create a Transaction using the provided parameters
AccountStatus	getAccountStatus() Requires Authentication Return the details of an account (API Id, KYC Status and remaining trading amount)
Asset	getAsset(String ticker) Returns the selected Asset if it exists and its details
Asset[]	getAssets() Returns all the available Assets and their details
AssetsHistoryResult	getAssetsHistory(HistoryCriteria criteria) Returns the history for all the available assets according to the given criteria
AssetsHistoryResult	getAssetsHistory(HistoryCriteria criteria, List<String> tickers) Returns the history for the provided assets according to the given criteria Assets must be given using this format : USD,XAU,etc..
String	getLatestDebugData() For testing purposes only On some requests, when you use the TestingMode of the client, you will get a DebugData, which will simplify the testing of the API and the client As an example, a debugData could be the fake validationCode when your register an account.
Order	getOrder(String id) Requires Authentication Returns the specified user's order
OrderResultPage	getOrders() Requires Authentication Returns the user's orders, you will get the 500 first results
OrderResultPage	getOrders(PageCriteria pageCriteria) Requires Authentication Returns the user's orders, according to the pageCriteria settings (the page size is limited to 500)
WalletDetails	getWalletDetails(String address) Requires Authentication Returns the current wallet state The transaction history is paginated, you will get the 500 first results Contains the current balances, the values and the transaction history
WalletDetails	getWalletDetails(String address, PageCriteria pageCriteria) Requires Authentication Returns the current wallet state The transaction history is paginated, you can choose your page using the pageCriteria parameter (the page size is limited to 500) Contains the current balances, the values and the transaction history
AccountRegistrationResult	registerAccount(RegisterAccountRequest request) Register an account on Metaco Sends an SMS to the provided phone number If you are a wallet registering accounts for your clients, don't forget to set the provider_id with your Name/ID.
Order	submitSignedOrder(String id, RawTransaction rawTransaction) Requires Authentication Submit a signed order You have to sign each of your inputs of the selected order (you will get those details by fetching the orders) Then encode the transaction in hexadecimal and send it here

Method Detail

registerAccount

AccountRegistrationResult registerAccount(RegisterAccountRequest request)
                                   throws MetacoClientException

Register an account on Metaco Sends an SMS to the provided phone number If you are a wallet registering accounts for your clients, don't forget to set the provider_id with your Name/ID. If you are in debug mode, this request will return a HTTP header X-Metaco-DebugData with the validation code, it won't be send by SMS

Returns:

The initial account settings

Throws:

MetacoClientException

See Also:

Online Documentation

getAccountStatus

AccountStatus getAccountStatus()
                        throws MetacoClientException

Requires Authentication Return the details of an account (API Id, KYC Status and remaining trading amount)

Returns:

The account details

Throws:

MetacoClientException

See Also:

Online Documentation

confirmPhoneNumber

void confirmPhoneNumber(ValidateAccountRequest request)
                 throws MetacoClientException

Requires Authentication Validate the authenticated account, throws an exception if there is an error

Throws:

MetacoClientException

See Also:

Online Documentation

getAssets

Asset[] getAssets()
           throws MetacoClientException

Returns all the available Assets and their details

Returns:

The assets array

Throws:

MetacoClientException

See Also:

Online Documentation

getAsset

Asset getAsset(String ticker)
        throws MetacoClientException

Returns the selected Asset if it exists and its details

Returns:

The asset object

Throws:

MetacoClientException

See Also:

Online Documentation

getAssetsHistory

AssetsHistoryResult getAssetsHistory(HistoryCriteria criteria)
                              throws MetacoClientException

Returns the history for all the available assets according to the given criteria

Returns:

The history object

Throws:

MetacoClientException

See Also:

Online Documentation

getAssetsHistory

AssetsHistoryResult getAssetsHistory(HistoryCriteria criteria,
                                     List<String> tickers)
                              throws MetacoClientException

Returns the history for the provided assets according to the given criteria Assets must be given using this format : USD,XAU,etc..

Returns:

The history object

Throws:

MetacoClientException

See Also:

Online Documentation

createOrder

Order createOrder(NewOrder createOrder)
           throws MetacoClientException

Requires Authentication Create an order using the provided parameters This order will be processed in our system It will require your signature later when the trade state will be Signing

Throws:

MetacoClientException

See Also:

Online Documentation

getOrders

OrderResultPage getOrders()
                   throws MetacoClientException

Requires Authentication Returns the user's orders, you will get the 500 first results

Returns:

The orders array

Throws:

MetacoClientException

See Also:

Online Documentation

getOrders

OrderResultPage getOrders(PageCriteria pageCriteria)
                   throws MetacoClientException

Requires Authentication Returns the user's orders, according to the pageCriteria settings (the page size is limited to 500)

Returns:

The orders array

Throws:

MetacoClientException

See Also:

Online Documentation

getOrder

Order getOrder(String id)
        throws MetacoClientException

Requires Authentication Returns the specified user's order

Returns:

The order object

Throws:

MetacoClientException

See Also:

Online Documentation

submitSignedOrder

Order submitSignedOrder(String id,
                        RawTransaction rawTransaction)
                 throws MetacoClientException

Requires Authentication Submit a signed order You have to sign each of your inputs of the selected order (you will get those details by fetching the orders) Then encode the transaction in hexadecimal and send it here

Throws:

MetacoClientException

See Also:

Online Documentation

cancelOrder

void cancelOrder(String id)
          throws MetacoClientException

Requires Authentication Cancel the specified order

Throws:

MetacoClientException

See Also:

Online Documentation

createTransaction

TransactionToSign createTransaction(NewTransaction newTransaction)
                             throws MetacoClientException

Requires Authentication Create a Transaction using the provided parameters

Throws:

MetacoClientException

See Also:

Online Documentation

broadcastTransaction

TransactionBroadcastResult broadcastTransaction(RawTransaction rawTransaction)
                                         throws MetacoClientException

Requires Authentication Submit a signed transaction You have to sign each of your inputs of the selected transaction (you will get those details when creating the transaction through Metaco) Then encode the transaction in hexadecimal and send it here

Throws:

MetacoClientException

See Also:

Online Documentation

getWalletDetails

WalletDetails getWalletDetails(String address)
                        throws MetacoClientException

Requires Authentication Returns the current wallet state The transaction history is paginated, you will get the 500 first results Contains the current balances, the values and the transaction history

Throws:

MetacoClientException

See Also:

Online Documentation

getWalletDetails

WalletDetails getWalletDetails(String address,
                               PageCriteria pageCriteria)
                        throws MetacoClientException

Requires Authentication Returns the current wallet state The transaction history is paginated, you can choose your page using the pageCriteria parameter (the page size is limited to 500) Contains the current balances, the values and the transaction history

Throws:

MetacoClientException

See Also:

Online Documentation

getLatestDebugData

String getLatestDebugData()

For testing purposes only On some requests, when you use the TestingMode of the client, you will get a DebugData, which will simplify the testing of the API and the client As an example, a debugData could be the fake validationCode when your register an account.