Giter Site home page Giter Site logo

wazirx-api's Introduction

WazirX Public Rest API

Here’s our public API handed to you on a silver platter. You can use it to build tickers, price comparison apps, or anything that helps the crypto community. Use it responsibly. ❤️

General Information

  1. Base API Endpoint: https://api.wazirx.com
  2. All public api will return either JSON or Array object.

Public API Endpoints

  1. MARKET STATUS

    GET /api/v2/market-status Live link

    "Market Status" will give your an overview of markets and assets. This is helpful when you want to track the configuration of our markets, track fees or status of withdrawal deposit, market configuration and more. This response is not recommended for price polling because accurate realtime price is not guaranteed as there could be some delays. We recommend using price ticker API for all price tracking activity.

    Response object will have 2 keys markets(all market related configs will be in this key) and assets(all assets related configs will be here).

    Response:

    {
        "markets": [
            {
                "baseMarket": "btc",
                "quoteMarket": "inr",
                "minBuyAmount": 0.001,
                "minSellAmount": 0.001,
                "fee": {
                    "bid": {
                        "maker": 0.001,
                        "taker": 0.0025
                    },
                    "ask": {
                        "maker": 0.001,
                        "taker": 0.0025
                    }
                },
                "basePrecision": 4,
                "quotePrecision": 2,
                "low": "460001.01",
                "high": "505000.0",
                "last": "480102.0",
                "open": 505002,
                "volume": "0.2071",
                "sell": "490000.0",
                "buy": "485001.0",
                "type": "SPOT"
                "Status": "active"
            },
            ...
        ],
        "assets": [
            {
                "type": "inr",
                "name": "Rupee",
                "withdrawFee": 0,
                "minWithdrawAmount": 50,
                "maxWithdrawAmount": 50000,
                "minDepositAmount": 500,
                "confirmation": 5,
                "deposit": "enabled",
                "withdrawal": "enabled"
                
            },
            ...
        ]
    }
    
    1. markets key has multiple market related configuration, and description of every field in market is as below:

      1. baseMarket: ticker code of base asset
      2. quoteMarket: ticker code of quote asset
      3. minBuyAmount: Minimum buy amount of base asset
      4. minSellAmount: Minumum sell amount of base asset
      5. fee: JSON Object consists of bid and ask order's maker-taker fee percentage
      6. basePrecision: Maximum precision of base asset, this the decimal point.
      7. quotePrecision: Maximum precision of quote asset
      8. low: 24 hrs lowest price of base asset
      9. high: 24 hrs highest price of base asset
      10. last: Last traded price in current market
      11. open: Market Open price 24hrs ago
      12. volume: Last 24hrs traded volume
      13. sell: Top ask order price
      14. buy: Top bid order price
      15. type: This defines the type of market, currently we have SPOT and P2P
      16. status: This defines the current state of the market. This can be active or suspended
    2. assets key have multiple asset related configuration as described below:

      1. type: asset code
      2. name: Display name of asset
      3. withdrawFee: Withdrawal fee of asset
      4. minWithdrawAmount: Minimum withdrawal amount in a single transaction
      5. maxWithdrawAmount: Maximum withdrawal amount in a single transaction
      6. minDepositAmount: This is the min Deposit amount that will be accepted as deposit
      7. confirmations: Is the min number of block height needed to confirm a block chain deposit transaction.
      8. deposit: Denotes whether deposit is enabled or disabled
      9. withdrawal: Denotes whether withdrawal is enabled or disabled
  2. MARKET TICKER

    GET /api/v2/tickers Live link

    Get the latest market heart-beat for all the markets for the last 24hrs.

    Returns JSON response which has active market data with all ticker related values.

    Response:

    {
        "btcinr": {
            "base_unit": "btc",
            "quote_unit": "inr",
            "low": "472005.0",
            "high": "508102.0",
            "last": "508100.0",
            "open": 490000,
            "volume": "0.2709",
            "sell": "508100.0",
            "buy": "481000.0",
            "name": "BTC/INR",
            "at": 1536732262
        },
        ...
    }
    

    Response has multiple key which denotes market data, this is in JSON. Find all the fields below:

    1. base_unit: ticker code of base market
    2. quote_unit: ticker code of quote asset
    3. low: 24 hrs lowest price of base asset
    4. high: 24 hrs highest price of base asset
    5. last: Last traded price in current market
    6. open: Market Open price 24hrs ago
    7. volume: Last 24hrs traded volume
    8. sell: Top ask order price
    9. buy: Top bid order price
    10. name: Display text of market
    11. at: Timestamp when ticker information is fetched
  3. MARKET DEPTH

    GET /api/v2/depth Live link

    Get market orderbook of any market

    Returns JSON response which has order book of a perticular market

    Response:

    {
    "timestamp":1559561187,
    "asks":[
               ["8540.0","1.5"],
               ["8541.0","0.0042"]
           ],
    "bids":[
               ["8530.0","0.8814"],
               ["8524.0","1.4"]
           ]
    }
    
    1. ["8540.0","1.5"] : [ PRICE, VOLUME ]
    2. URL param market=btcusdt : Replace this with any market to get the desired order book.
  4. MARKET TRADE HISTORY

    GET /api/v2/trades Live link

    Get trade history of a market

    Returns JSON response which has trade history of a perticular market

    Response:

    [
      {
         "id":1302646,
         "price":"8530.0",
         "volume":"0.3207",
         "funds":"2735.571",
         "market":"btcusdt",
         "created_at":"2019-06-03T17:03:41+05:30",
         "side":null
       }  
    ...
    ]
    
    1. URL param market=btcusdt : Replace this with any market to get the desired order book.

If you have any questions regarding APIs, please reach out to us at http://support.wazirx.com

wazirx-api's People

Contributors

buddhasource avatar

Watchers

James Cloos avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.