Skip to content

Latest commit

 

History

History
76 lines (56 loc) · 1.38 KB

README.md

File metadata and controls

76 lines (56 loc) · 1.38 KB

OmniTrade API Dart Client

OmniTrade API Dart Client is an open-source Dart that integrates the OmniTrade API. You can read the API documentation by visiting this link

Getting Started

You can use in your project adding the dependency on pubspec.yml

dependencies:
  ...
  omnitrade_client:
    git: https://github.com/OmniTrade/client-dart

Usage example

  1. Import package to use it
import 'package:omnitrade_client/omnitrade_client.dart';
  1. Create new instance of OmniTrade Client
final client = OmniTradeClient();

If you need to call private methods you'll be supposed to pass credentials

final client = OmniTradeClient(
  accessKey: 'xxx',
  privateKey: 'yyy'
);

You can got the credentials here

  1. Call Api method that you need
Future<void> yourFunction() async {
  final response = await client.fetchMarkets();
}

Public methods (not required credentials)

  • fetchMarkets
  • fetchTickets
  • fetchTicketsFromMarket
  • fetchDepth
  • fetchTrades
  • fetchK
  • fetchKWithPendingTrades
  • fetchTimestamp
  • generateTrezorChallenge

Private methods (requires credentials)

  • fetchMe
  • fetchDeposits
  • fetchDeposit
  • fetchDepositAddress
  • fetchOrders
  • cancelOrders
  • fetchOrder
  • cancelOrder

Todo

  • createManyOrders
  • cancelOrdersBottom