NeXTSTEP Programming Mastermind

    @marketprotocol/mpx-api-client

    1.0.0 • Public • Published

    MPX API Client

    Build Status

    This is the javascript client for interacting with MPX-API

    Table of Content

    Installation

    To install run

    npm install @marketprotocol/mpx-api-client
    

    Getting Started

    First, you would need to set the host for the mpxAPI client.

    import { mpxAPI, Path } from '@marketprotocol/mpx-api-client'
    
    mpxAPI.setHost('https://api.mpexchange.io');

    This ensures that the client always makes a request to the set api environment (kovan/mainnet).

    The mpxAPI namespace object provides HTTP methods (get, post, patch etc) to make requests to the corresponding resource on MPX API. Each of these methods return a promise that resolves to the response of the data of the api request else if rejects with an Array of MPXAPIError.

    For example, to get the list of tokenPair listed on the exchange, you do:

     // fetch all token pairs
    mpxAPI.get(Path.TokenPairs)
      .then(tokenPairs, () => {
        // do what you want tokenPairs
      });

    To get a list of all available resources and possible actions you can check the API documentation here or make a request via mpxAPI.get(Path.Root) and inspect its response.

    Documentation

    See the full API documentation for the client at docs/api.md.

    Contributing

    • Clone the repository.
    • Ensure everythign is working by running the test with npm run test.
    • After making your changes. Open a PR.

    License

    This project is under the Apache 2.0 license.

    Keywords

    Install

    npm i @marketprotocol/mpx-api-client

    DownloadsWeekly Downloads

    0

    Version

    1.0.0

    License

    Apache 2.0

    Unpacked Size

    61.5 kB

    Total Files

    18

    Last publish

    Collaborators

    • dmvt
    • nitinrgupta
    • pelsasser
    • perfectmak
    • rojosnow
    • tmathis
    • valentinaa