bitkub


Namebitkub JSON
Version 2.0.0 PyPI version JSON
download
home_pagehttps://github.com/sang-sakarin/bitkub
SummaryA Python library for Bitkub API
upload_time2024-10-26 09:04:38
maintainerNone
docs_urlNone
authorsang_sakarin
requires_pythonNone
licensesang_sakarin
keywords bitkub bitkub-python bitkub-python-sdk
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # Bitkub Python


A Python library for [bitkub.com](https://github.com/bitkub/bitkub-official-api-docs) API

## Releases
  * ```2024-10-26``` version ```2.0.0```
    * support api ```v3```
  * ```2022-01-07``` version ```1.1.0```
    * add [Create buy order test](#createbuyordertest)
    * add [Create sell order test](#createsellordertest)
    * [Viewing tradingview history](#viewingtradingviewhistory) endpoint is now deprecated and will be updated with a new endpoint soon. The old endpoint will always return empty result.
    * include is_maker in [My order history](#myorderhistory)
    * removed address and instead include from_address and to_address in [Crypto deposit history](#cryptodeposithistory)
    * add [Crypto internal withdraw](#cryptinternalowithdraw)
    * include partial_filled and remaining in [Order info](#orderinfo)
  * ```2020-04-02``` version ```1.0.3``` add [generate-address](#cryptogenerateaddress) method

## Table of Contents

- [Installation](#installation)
- [Usage](#usage)
  - [Creating a Bitkub](#creating)
  - [Set API key & API secret](#api_key)
  - [Viewing status](#viewingstatus)
  - [Viewing servertime](#viewingservertime)
  - [Viewing symbols](#viewingsymbols)
  - [Viewing ticker](#viewingticker)
  - [Viewing trades](#viewingtrades)
  - [Viewing bids](#viewingbids)
  - [Viewing asks](#viewingasks)
  - [Viewing books](#viewingbooks)
  - [Viewing depth](#viewingdepth)
  - [Viewing tradingview history](#viewingtradingviewhistory)
  - [Viewing wallet](#viewingwallet)
  - [Viewing balances](#viewingbalances)
  - [Create buy order](#createbuyorder)
  - [Create sell order](#createsellorder)
  - [Cancel order](#cancelorder)
  - [My open orders](#myopenorders)
  - [My order history](#myorderhistory)
  - [Order info](#orderinfo)
  - [Crypto addresses](#cryptoaddressses)
  - [Crypto withdraw](#cryptowithdraw)
  - [Crypto internal withdraw](#cryptinternalowithdraw)
  - [Crypto deposit history](#cryptodeposithistory)
  - [Crypto withdraw history](#cryptowithdrawhistory)
  - [Crypto generate address](#cryptogenerateaddress)
  - [Fiat accounts](#fiataccounts)
  - [Fiat withdraw](#fiatwithdraw)
  - [Fiat deposit history](#fiatdeposithistory)
  - [Fiat withdraw history](#fiatwithdrawhistory)
  - [Market wstoken](#marketwstoken)
  - [User limits](#userlimits)
  - [User trading credits](#usertradingcredits)


## Installation <a name="installation"></a>

    pip install bitkub

## Usage <a name="usage"></a>

    from bitkub import Bitkub

### Creating a Bitkub Object <a name="creating"></a>

    API_KEY = 'YOUR API KEY'
    API_SECRET = 'YOUR API SECRET'

    # initial obj only non-secure
    bitkub = Bitkub()

    # initial obj non-secure and secure
    bitkub = Bitkub(api_key=API_KEY, api_secret=API_SECRET)

You can find API KEY and API SECRET from [here](https://www.bitkub.com/publicapi).

### Set API key and API secret <a name="api_key"></a>
  If you initial obj with only non-secure. You can set up API key and API secret on below.

    API_KEY = 'YOUR API KEY'
    API_SECRET = 'YOUR API SECRET'

    bitkub = Bitkub()
    bitkub.set_api_key(API_KEY)
    bitkub.set_api_secret(API_SECRET)

### Viewing status <a name="viewingstatus"></a>

Get endpoint status.

#### Function:
    bitkub.status()

#### Response:

    [
      {
        'name': 'Non-secure endpoints',
        'status': 'ok',
        'message': ''
      },
      {
        'name': 'Secure endpoints',
        'status': 'ok',
        'message': ''
      }
    ]

### Viewing servertime <a name="viewingservertime"></a>

Get server timestamp.

#### Function:
    bitkub.servertime()

#### Response:

    1583051817

### Viewing symbols <a name="viewingsymbols"></a>

List all available symbols.

#### Function:
    bitkub.symbols()

#### Response:

    {
      'error': 0,
      'result': [
        {
          'id': 1,
          'info': 'Thai Baht to Bitcoin',
          'symbol': 'THB_BTC'
        },
        {
          'id': 2,
          'info': 'Thai Baht to Ethereum',
          'symbol': 'THB_ETH'
        }
      ]
    }

### Viewing ticker <a name="viewingticker"></a>

Get ticker information.

#### Function:
    bitkub.ticker(sym='THB_BTC')

#### Parameter:

  * ```sym``` **string** The symbol (optional) ```default``` ""

#### Response:

    {
      'THB_BTC': {
        'id': 1,
        'last': 278000,
        'lowestAsk': 278869.41,
        'highestBid': 278000,
        'percentChange': -1.44,
        'baseVolume': 206.01549914,
        'quoteVolume': 57883319.04,
        'isFrozen': 0,
        'high24hr': 284000,
        'low24hr': 277579.62,
        'change': -4075.81,
        'prevClose': 281800,
        'prevOpen': 281800
      }
    }

### Viewing trades <a name="viewingtrades"></a>

List recent trades.

#### Function:
    bitkub.trades(sym="THB_BTC", lmt=2)

#### Parameter:

  * ```sym``` **string** The symbol
  * ```lmt``` **int** No. of limit to Parameter recent trades ```default``` 1

#### Response:

    {
      'error': 0,
      'result': [
        [
          1583246192, // timestamp
          278798.34, // rate
          0.00375672, // amount
          'BUY' // side
        ],
        [
          1583246159,
          278000,
          0.0001042,
          'SELL'
        ]
      ]
    }


### Viewing bids <a name="viewingbids"></a>

List open buy orders.

#### Function:
    bitkub.bids(sym="THB_BTC", lmt=2)

#### Parameter:

  * ```sym``` **string** The symbol
  * ```lmt``` **int** No. of limit to Parameter open buy orders ```default``` 1

#### Response:

    {
      'error': 0,
      'result': [
        [
          4632978, // order id
          1583245687, // timestamp
          73110.59, // volume
          278000, // rate
          0.26298773 // amount
        ],
        [
          4632732,
          1583245871,
          1312.68,
          278000,
          0.00472187
        ]
      ]
    }


### Viewing asks <a name="viewingasks"></a>

List open sell orders.

#### Function:
    bitkub.asks(sym="THB_BTC", lmt=2)
#### Parameter:

  * ```sym``` **string** The symbol
  * ```lmt``` **int** No. of limit to Parameter open sell orders ```default``` 1

#### Response:

    {
      'error': 0,
      'result': [
        [
          4761288, // order id
          1583246870, // timestamp
          163813.12, // volume
          278499.03, // rate
          0.5882 // amount
        ],
        [
          4761287,
          1583246870,
          379232.12,
          278499.03,
          1.3617
        ]
      ]
    }


### Viewing books <a name="viewingbooks"></a>

List all open orders.

#### Function:
    bitkub.books(sym="THB_BTC", lmt=1)
#### Parameter:

  * ```sym``` **string** The symbol
  * ```lmt``` **int** No. of imit to Parameter open orders ```default``` 1

#### Response:

    {
      'error': 0,
      'result': {
        'asks': [
          [
            4761425, // order id
            1583247105, // timestamp
            360885.74, // volume
            278300.17, // rate
            1.29675 // amount
          ]
        ],
        'bids': [
          [
            4633099, // order id
            1583247090, // timestamp
            622146.15, // volume
            277946.2, // rate
            2.23836897 // amount
          ]
        ]
      }
    }



### Viewing tradingview history <a name="viewingtradingviewhistory"></a>

Get historical data for TradingView chart.

#### Function:
    bitkub.tradingview(sym='THB_BTC', int=1, frm='', to='')
#### Parameter:

  * ```sym``` **string** The symbol
  * ```int``` **int** Chart resolution (1, 5, 15, 60, 240, 1D) ```default``` 1
  * ```frm``` **int** Timestamp of the starting time
  * ```to``` **int** Timestamp of the ending time

#### Response:
    
    {
      'c': [
        1685000,
        1680699.95,
        1688998.99,
        1692222.22
      ],
      'h': [
        1685000,
        1685000,
        1689000,
        1692222.22
      ],
      'l': [
        1680053.22,
        1671000,
        1680000,
        1684995.07
      ],
      'o': [
        1682500,
        1685000,
        1680100,
        1684995.07
      ],
      's': "ok",
      't': [
        1633424400,
        1633425300,
        1633426200,
        1633427100
      ],
      'v': [
        4.604352630000001,
        8.530631670000005,
        4.836581560000002,
        2.8510189200000022
      ]
    }

### Viewing depth <a name="viewingdepth"></a>

Get depth information.

#### Function:
    bitkub.depth(sym='THB_BTC', lmt=1)
#### Parameter:

  * ```sym``` **string** The symbol
  * ```lmt``` **int** Depth size  ```default``` 1

#### Response:

    {
      'asks': [
        [
          277946.16,
          1.29675
        ]
      ],
      'bids': [
        [
          277936.27,
          0.94071896
        ]
      ]
    }


### Viewing wallet <a name="viewingwallet"></a>

Get user available balances. ```Required initial secure obj```

#### Function:
    bitkub.wallet()

#### Response:

    {
      'error': 0,
      'result': {
        'THB': 0,
        'BTC': 0,
        'ETH': 0
      }
    }


### Viewing balances <a name="viewingbalances"></a>

Get balances info: this includes both available and reserved balances. ```Required initial secure obj```

#### Function:
    bitkub.balances()

#### Response:

    {
      'error': 0,
      'result': {
        'THB': {
          'available': 0,
          'reserved': 0
        },
        'BTC': {
          'available': 0,
          'reserved': 0
        }
      }
    }


### Create buy order <a name="createbuyorder"></a>

Create a buy order. ```Required initial secure obj```

#### Function:
    bitkub.place_bid(sym='THB_BTC', amt=1, rat=1, typ='limit', client_id='a7sjas7', post_only=false)

#### Parameter:
  * ```sym``` **string** The symbol
  * ```amt``` **float** Amount you want to spend with no trailing zero (e.g 1000.00 is invalid, 1000 is ok) ```default``` 1
  * ```rat``` **float** Rate you want for the order with no trailing zero (e.g 1000.00 is invalid, 1000 is ok) ```default``` 1
  * ```typ``` **string** Order type: limit or market ```default``` limit
  * ```client_id``` **string** your id for reference ( not required )
  * ```post_only``` **bool** Postonly flag: ```true``` or ```false``` ( not required )


#### Response:

    {
      'error': 0,
      'result': {
        'id': 1,
        'hash': 'fwQ6dnQWQPs4cbatF5Am2xCDP1J',
        'typ': 'limit',
        'amt': 1,
        'rat': 1,
        'fee': 2.5,
        'cre': 2.5,
        'rec': 0.06666666,
        'ts': 1533834547
      }
    }

### Create sell order <a name="createsellorder"></a>

Create a sell order. ```Required initial secure obj```

#### Function:
    bitkub.place_ask(sym='THB_BTC', amt=1, rat=1, typ='limit', client_id='a7sjas7', post_only=false)

#### Parameter:
  * ```sym``` **string** The symbol
  * ```amt``` **float** Amount you want to spend with no trailing zero (e.g 1000.00 is invalid, 1000 is ok) ```default``` 1
  * ```rat``` **float** Rate you want for the order with no trailing zero (e.g 1000.00 is invalid, 1000 is ok) ```default``` 1
  * ```typ``` **string** Order type: limit or market ```default``` limit'
  * ```client_id``` **string** your id for reference ( not required )
  * ```post_only``` **bool** Postonly flag: ```true``` or ```false``` ( not required )


#### Response:

    {
      'error': 0,
      'result': {
        'id': 1,
        'hash': 'fwQ6dnQWQPs4cbatF5Am2xCDP1J',
        'typ': 'limit',
        'amt': 1,
        'rat': 1,
        'fee': 2.5,
        'cre': 2.5,
        'rec': 0.06666666,
        'ts': 1533834547
      }
    }


### Cancel order<a name="cancelorder"></a>

Cancel an open order. ```Required initial secure obj```

#### Function:
    bitkub.cancel_order(sym='THB_BTC', id=1, sd=1, hash='XXXXXX')

#### Parameter:
  * ```sym``` **string** The symbol
  * ```id``` **int** Order id you wish to cancel
  * ```sd``` **string** Order side: buy or sell ```default``` buy
  * ```hash``` **string** Cancel an order with order hash (optional). You don't need to specify sym, id, and sd when you specify order hash.


#### Response:

    {
      'error': 0
    }


### My open orders<a name="myopenorders"></a>

List all open orders of the given symbol. ```Required initial secure obj```

#### Function:
    bitkub.my_open_orders(sym='THB_BTC')

#### Parameter:
  * ```sym``` **string** The symbol


#### Response:

    {
      'error': 0,
      'result': [
        {
          'id': 2,
          'hash': 'fwQ6dnQWQPs4cbatFSJpMCcKTFR',
          'side': 'SELL',
          'type': 'limit',
          'rate': 15000,
          'fee': 35.01,
          'credit': 35.01,
          'amount': 0.93333334,
          'receive': 14000,
          'parent_id': 1,
          'super_id': 1,
          'ts': 1533834844
        }
      ]
    }


### My order history<a name="myorderhistory"></a>

List all orders that have already matched. ```Required initial secure obj```

#### Function:
    bitkub.my_open_history(sym='THB_BTC', p=1, lmt=10)

#### Parameter:
  * ```sym``` **string** The symbol
  * ```p``` **string** Page (optional)
  * ```lmt``` **string** Limit (optional)
  * ```start``` **string** Start timestamp (optional)
  * ```end``` **string** End timestamp (optional)


#### Response:

    {
      'error': 0,
      'result': [
        {
          'txn_id': 'ETHBUY0000000197',
          'order_id': 240,
          'hash': 'fwQ6dnQWQPs4cbaujNyejinS43a',
          'parent_order_id': 0,
          'super_order_id': 0,
          'taken_by_me': true,
          'is_maker': true,
          'side': 'buy',
          'type': 'limit',
          'rate': 13335.57,
          'fee': 0.34,
          'credit': 0.34,
          'amount': 0.00999987,
          'ts': 1531513395
        }

    {
      'error': 0,
      'result': {
          'id': 289,
      ],
      'pagination': {
        'page': 2,
        'last': 3,
        'next': 3,
        'prev': 1
      }
    }


### Order info<a name="orderinfo"></a>

Get information regarding the specified order. ```Required initial secure obj```

#### Function:
    bitkub.order_info(sym='THB_BTC', id=1, sd='buy', hash='XXXXXX')

#### Parameter:
  * ```sym``` **string** The symbol
  * ```id``` **int** Order id
  * ```sd``` **string** Order side: buy or sell ```default```  buy
  * ```hash``` **string** Lookup an order with order hash (optional). You don't need to specify sym, id, and sd when you specify order hash.


#### Response:

    {
      'error': 0,
      'result': {
          'id': 289,
          'first': 289,
          'parent': 0,
          'last': 316,
          'amount': 4000,
          'rate': 291000,
          'fee': 10,
          'credit': 10,
          'filled': 3999.97,
          'total': 4000,
          'status': 'filled',
          'partial_filled': False,
          'remaining': 0,
          'history': [
            {
                'amount': 98.14848,
                'credit': 0.25,
                'fee': 0.25,
                'id': 289,
                'rate': 291000,
                'timestamp': 1525944169
            }
          ]
        }
      }


### Crypto addresses<a name="cryptoaddress"></a>

List all crypto addresses. ```Required initial secure obj```

#### Function:
    bitkub.crypto_address(p=1, lmt=1)

#### Parameter:
  * ```p``` **int** Page (optional) ```default``` 1
  * ```lmt``` **int** Limit (optional) ```default``` 10


#### Response:

    {
      'error': 0,
      'result': [
        {
           'currency': 'BTC',
           'address': '3BtxdKw6XSbneNvmJTLVHS9XfNYM7VAe8k',
           'tag': 0,
           'time': 1570893867
        }
      ],
      'pagination': {
        'page': 1,
        'last": 1
      }
    }


### Crypto withdraw<a name="cryptowithdraw"></a>

Make a withdrawal to a trusted address. ```Required initial secure obj```

#### Function:
    bitkub.crypto_withdraw(cur='BTC', amt=0.1, adr='4asyjKw6XScneNvhJTLVHS9XfNYM7VBf8x', mem='', net='')

#### Parameter:
  * ```cur``` **string** Currency for withdrawal (e.g. BTC, ETH)
  * ```amt``` **float** Amount you want to withdraw
  * ```adr``` **string** Address to which you want to withdraw
  * ```mem``` **string** (Optional) Memo or destination tag to which you want to withdraw
  * ```net``` **string** Cryptocurrency network to withdraw


#### Response:

    {
      'error': 0,
      'result': {
          'txn': 'BTCWD0000012345',
          'adr': '4asyjKw6XScneNvhJTLVHS9XfNYM7VBf8x'
          'mem': '',
          'cur': 'BTC',
          'amt': 0.1,
          'fee': 0.0002,
          'ts': 1569999999
      }
    }


### Crypto internal withdraw<a name="cryptointernalwithdraw"></a>

Make a withdrawal to a trusted address. ```Required initial secure obj```

The destination address is not required to be a trusted address. This API is not enabled by default, Only KYB users can request this feature by contacting us via support@bitkub.com

#### Function:
    bitkub.crypto_internal_withdraw(cur='BTC', amt=0.1, adr='4asyjKw6XScneNvhJTLVHS9XfNYM7VBf8x', mem='', net='')

#### Parameter:
  * ```cur``` **string** Currency for withdrawal (e.g. BTC, ETH)
  * ```amt``` **float** Amount you want to withdraw
  * ```adr``` **string** Address to which you want to withdraw
  * ```mem``` **string** (Optional) Memo or destination tag to which you want to withdraw
  * ```net``` **string** Cryptocurrency network to withdraw


#### Response:

    {
      'error': 0,
      'result': {
          'txn': 'BTCWD0000012345',
          'adr': '4asyjKw6XScneNvhJTLVHS9XfNYM7VBf8x'
          'mem': '',
          'cur': 'BTC',
          'amt': 0.1,
          'fee': 0.0002,
          'ts': 1569999999
      }
    }


### Crypto deposit history<a name="cryptodeposithistory"></a>

List crypto deposit history. ```Required initial secure obj```

#### Function:
    bitkub.crypto_deposit_history(p=1, lmt=1)

#### Parameter:
  * ```p``` **int** Page (optional) ```default``` 1
  * ```lmt``` **int** Limit (optional) ```default``` 10


#### Response:

    {
      'error': 0,
      'result': [
        {
           'hash': 'XRPWD0000100276',
           'currency': 'XRP',
           'amount': 5.75111474,
           'from_address': 'sender address',
           'to_address': 'receipent address',
           'confirmations': 1,
           'status': 'complete',
           'time': 1570893867
        }
      ],
      'pagination': {
        'page': 1,
        'last': 1
      }
    }


### Crypto withdraw history<a name="cryptowithdrawhistory"></a>
:
List crypto withdrawal history. ```Required initial secure obj```

#### Function:
    bitkub.crypto_withdraw_history(p=1, lmt=1)

#### Parameter:
  * ```p``` **int** Page (optional) ```default``` 1
  * ```lmt``` **int** Limit (optional) ```default``` 10


#### Response:

    {
      'error': 0,
      'result': [
        {
          'txn_id': 'XRPWD0000100276',
          'hash': 'send_internal',
          'currency': 'XRP',
          'amount': '5.75111474',
          'fee': 0.01,
          'address': 'rpXTzCuXtjiPDFysxq8uNmtZBe9Xo97JbW',
          'status': 'complete',
          'time': 1570893493
        }
      ],
      'pagination': {
        'page': 1,
        'last': 1
      }
    }


### Crypto generate address<a name="cryptogenerateaddress"></a>
Generate a new crypto address (will replace existing address; previous address can still be used to received funds)
List all approved bank accounts. ```Required initial secure obj```

#### Function:
    bitkub.crypto_generate_address(sym='THB_BTC')

#### Parameter:
  * ```sym``` **string** The symbol


#### Response:

    {
      'error': 0,
      'result': [
        {
           'currency': 'BTC',
           'address': '0x520165471daa570ab632dd504c6af257bd36edfb',
           'memo': ''
        }
      ]
    }



### Fiat accounts<a name="fiataccounts"></a>

List all approved bank accounts. ```Required initial secure obj```

#### Function:
    bitkub.fiat_accounts(p=1, lmt=1)

#### Parameter:
  * ```p``` **int** Page (optional) ```default``` 1
  * ```lmt``` **int** Limit (optional) ```default``` 10


#### Response:

    {
      'error': 0,
      'result': [
        {
          'id': '7262109099',
          'bank': 'Kasikorn Bank',
          'name': 'Somsak',
          'time': 1570893867
        }
      ],
      'pagination': {
        'page': 1,
        'last': 1
      }
    }


### Fiat withdraw<a name="fiatwithdraw"></a>

Make a withdrawal to an approved bank account. ```Required initial secure obj```

#### Function:
    bitkub.fiat_withdraw(id=1, amt=1)

#### Parameter:
  * ```id``` **string** Bank account id
  * ```amt``` **float** Amount you want to withdraw


#### Response:

    {
      'error': 0,
      'result': {
        'txn': 'THBWD0000012345',
        'acc': '7262109099',
        'cur': 'THB',
        'amt': 21,
        'fee': 20,
        'rec': 1,
        'ts': 1569999999
      }
    }


### Fiat deposit history<a name="fiatdeposithistory"></a>

List fiat deposit history. ```Required initial secure obj```

#### Function:
    bitkub.fiat_deposit_history(p=1, lmt=1)

#### Parameter:
  * ```p``` **int** Page (optional) ```default``` 1
  * ```lmt``` **int** Limit (optional) ```default``` 10


#### Response:

    {
      'error':0,
      'result':[
        {
           'txn_id': 'THBDP0000012345',
           'currency': 'THB',
           'amount': 5000.55,
           'status': 'complete',
           'time': 1570893867
        }
      ],
      'pagination':{
        'page': 1,
        'last': 1
      }
    }


### Fiat withdraw history<a name="fiatwithdrawhistory"></a>

List fiat withdrawal history. ```Required initial secure obj```

#### Function:
    bitkub.fiat_withdraw_history(p=1, lmt=1)

#### Parameter:
  * ```p``` **int** Page (optional) ```default``` 1
  * ```lmt``` **int** Limit (optional) ```default``` 10


#### Response:

    {
      'error': 0,
      'result': [
        {
           'txn_id': 'THBDP0000012345',
           'currency': 'THB',
           'amount': 5000.55,
           'fee': 20,
           'status': 'complete',
           'time': 1570893867
        }
      ],
      'pagination':{
        'page': 1,
        'last': 1
      }
    }


### Market wstoken<a name="marketwstoken"></a>

Get the token for websocket authentication. ```Required initial secure obj```

#### Function:
    bitkub.market_wstoken()

#### Response:

    {
      'error': 0,
      'result': 'sdCBCTwaS2Z1IBB6uTCefIbVN6dQVz9dkDeU96IoFJp14GGhlw9hoUDNe1KSYC23dXBPIqyX2QjVEOFHITxgPMvo8kdVaTkiZBA8KgvVTSMsq6JjjlyERDVZn3tt4PEp'
    }

### User limits<a name="userlimits"></a>

Check deposit/withdraw limitations and usage. ```Required initial secure obj```

#### Function:
    bitkub.user_limits()

#### Response:

    {
      'error': 0,
      'result': {
        'limits': {
          'crypto': {
            'deposit': 0,
            'withdraw': 0
          },
          'fiat': {
            'deposit': 0,
            'withdraw': 0
          }
        },
        'usage': {
          'crypto': {
            'deposit': 0,
            'withdraw': 0,
            'deposit_percentage': 0,
            'withdraw_percentage': 0,
            'deposit_thb_equivalent': 0,
            'withdraw_thb_equivalent': 0
          },
          'fiat': {
            'deposit': 0,
            'withdraw': 0,
            'deposit_percentage': 0,
            'withdraw_percentage': 0
          }
        },
        'rate': 177100.32
      }
    }


### User trading-credit<a name="usertradingcredits"></a>

Check trading credit balance. ```Required initial secure obj```

#### Function:
    bitkub.user_trading_credits()

#### Response:

    {
      'error': 0,
      'result': 0
    }

            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/sang-sakarin/bitkub",
    "name": "bitkub",
    "maintainer": null,
    "docs_url": null,
    "requires_python": null,
    "maintainer_email": null,
    "keywords": "bitkub bitkub-python bitkub-python-sdk",
    "author": "sang_sakarin",
    "author_email": "sang_sakarin@outlook.com",
    "download_url": "https://files.pythonhosted.org/packages/c3/88/7be65d10f90e9b81a7b252a6ce2a6fc3efaa4c0daf227aab61c57ff10107/bitkub-2.0.0.tar.gz",
    "platform": null,
    "description": "# Bitkub Python\n\n\nA Python library for [bitkub.com](https://github.com/bitkub/bitkub-official-api-docs) API\n\n## Releases\n  * ```2024-10-26``` version ```2.0.0```\n    * support api ```v3```\n  * ```2022-01-07``` version ```1.1.0```\n    * add [Create buy order test](#createbuyordertest)\n    * add [Create sell order test](#createsellordertest)\n    * [Viewing tradingview history](#viewingtradingviewhistory) endpoint is now deprecated and will be updated with a new endpoint soon. The old endpoint will always return empty result.\n    * include is_maker in [My order history](#myorderhistory)\n    * removed address and instead include from_address and to_address in [Crypto deposit history](#cryptodeposithistory)\n    * add [Crypto internal withdraw](#cryptinternalowithdraw)\n    * include partial_filled and remaining in [Order info](#orderinfo)\n  * ```2020-04-02``` version ```1.0.3``` add [generate-address](#cryptogenerateaddress) method\n\n## Table of Contents\n\n- [Installation](#installation)\n- [Usage](#usage)\n  - [Creating a Bitkub](#creating)\n  - [Set API key & API secret](#api_key)\n  - [Viewing status](#viewingstatus)\n  - [Viewing servertime](#viewingservertime)\n  - [Viewing symbols](#viewingsymbols)\n  - [Viewing ticker](#viewingticker)\n  - [Viewing trades](#viewingtrades)\n  - [Viewing bids](#viewingbids)\n  - [Viewing asks](#viewingasks)\n  - [Viewing books](#viewingbooks)\n  - [Viewing depth](#viewingdepth)\n  - [Viewing tradingview history](#viewingtradingviewhistory)\n  - [Viewing wallet](#viewingwallet)\n  - [Viewing balances](#viewingbalances)\n  - [Create buy order](#createbuyorder)\n  - [Create sell order](#createsellorder)\n  - [Cancel order](#cancelorder)\n  - [My open orders](#myopenorders)\n  - [My order history](#myorderhistory)\n  - [Order info](#orderinfo)\n  - [Crypto addresses](#cryptoaddressses)\n  - [Crypto withdraw](#cryptowithdraw)\n  - [Crypto internal withdraw](#cryptinternalowithdraw)\n  - [Crypto deposit history](#cryptodeposithistory)\n  - [Crypto withdraw history](#cryptowithdrawhistory)\n  - [Crypto generate address](#cryptogenerateaddress)\n  - [Fiat accounts](#fiataccounts)\n  - [Fiat withdraw](#fiatwithdraw)\n  - [Fiat deposit history](#fiatdeposithistory)\n  - [Fiat withdraw history](#fiatwithdrawhistory)\n  - [Market wstoken](#marketwstoken)\n  - [User limits](#userlimits)\n  - [User trading credits](#usertradingcredits)\n\n\n## Installation <a name=\"installation\"></a>\n\n    pip install bitkub\n\n## Usage <a name=\"usage\"></a>\n\n    from bitkub import Bitkub\n\n### Creating a Bitkub Object <a name=\"creating\"></a>\n\n    API_KEY = 'YOUR API KEY'\n    API_SECRET = 'YOUR API SECRET'\n\n    # initial obj only non-secure\n    bitkub = Bitkub()\n\n    # initial obj non-secure and secure\n    bitkub = Bitkub(api_key=API_KEY, api_secret=API_SECRET)\n\nYou can find API KEY and API SECRET from [here](https://www.bitkub.com/publicapi).\n\n### Set API key and API secret <a name=\"api_key\"></a>\n  If you initial obj with only non-secure. You can set up API key and API secret on below.\n\n    API_KEY = 'YOUR API KEY'\n    API_SECRET = 'YOUR API SECRET'\n\n    bitkub = Bitkub()\n    bitkub.set_api_key(API_KEY)\n    bitkub.set_api_secret(API_SECRET)\n\n### Viewing status <a name=\"viewingstatus\"></a>\n\nGet endpoint status.\n\n#### Function:\n    bitkub.status()\n\n#### Response:\n\n    [\n      {\n        'name': 'Non-secure endpoints',\n        'status': 'ok',\n        'message': ''\n      },\n      {\n        'name': 'Secure endpoints',\n        'status': 'ok',\n        'message': ''\n      }\n    ]\n\n### Viewing servertime <a name=\"viewingservertime\"></a>\n\nGet server timestamp.\n\n#### Function:\n    bitkub.servertime()\n\n#### Response:\n\n    1583051817\n\n### Viewing symbols <a name=\"viewingsymbols\"></a>\n\nList all available symbols.\n\n#### Function:\n    bitkub.symbols()\n\n#### Response:\n\n    {\n      'error': 0,\n      'result': [\n        {\n          'id': 1,\n          'info': 'Thai Baht to Bitcoin',\n          'symbol': 'THB_BTC'\n        },\n        {\n          'id': 2,\n          'info': 'Thai Baht to Ethereum',\n          'symbol': 'THB_ETH'\n        }\n      ]\n    }\n\n### Viewing ticker <a name=\"viewingticker\"></a>\n\nGet ticker information.\n\n#### Function:\n    bitkub.ticker(sym='THB_BTC')\n\n#### Parameter:\n\n  * ```sym``` **string** The symbol (optional) ```default``` \"\"\n\n#### Response:\n\n    {\n      'THB_BTC': {\n        'id': 1,\n        'last': 278000,\n        'lowestAsk': 278869.41,\n        'highestBid': 278000,\n        'percentChange': -1.44,\n        'baseVolume': 206.01549914,\n        'quoteVolume': 57883319.04,\n        'isFrozen': 0,\n        'high24hr': 284000,\n        'low24hr': 277579.62,\n        'change': -4075.81,\n        'prevClose': 281800,\n        'prevOpen': 281800\n      }\n    }\n\n### Viewing trades <a name=\"viewingtrades\"></a>\n\nList recent trades.\n\n#### Function:\n    bitkub.trades(sym=\"THB_BTC\", lmt=2)\n\n#### Parameter:\n\n  * ```sym``` **string** The symbol\n  * ```lmt``` **int** No. of limit to Parameter recent trades ```default``` 1\n\n#### Response:\n\n    {\n      'error': 0,\n      'result': [\n        [\n          1583246192, // timestamp\n          278798.34, // rate\n          0.00375672, // amount\n          'BUY' // side\n        ],\n        [\n          1583246159,\n          278000,\n          0.0001042,\n          'SELL'\n        ]\n      ]\n    }\n\n\n### Viewing bids <a name=\"viewingbids\"></a>\n\nList open buy orders.\n\n#### Function:\n    bitkub.bids(sym=\"THB_BTC\", lmt=2)\n\n#### Parameter:\n\n  * ```sym``` **string** The symbol\n  * ```lmt``` **int** No. of limit to Parameter open buy orders ```default``` 1\n\n#### Response:\n\n    {\n      'error': 0,\n      'result': [\n        [\n          4632978, // order id\n          1583245687, // timestamp\n          73110.59, // volume\n          278000, // rate\n          0.26298773 // amount\n        ],\n        [\n          4632732,\n          1583245871,\n          1312.68,\n          278000,\n          0.00472187\n        ]\n      ]\n    }\n\n\n### Viewing asks <a name=\"viewingasks\"></a>\n\nList open sell orders.\n\n#### Function:\n    bitkub.asks(sym=\"THB_BTC\", lmt=2)\n#### Parameter:\n\n  * ```sym``` **string** The symbol\n  * ```lmt``` **int** No. of limit to Parameter open sell orders ```default``` 1\n\n#### Response:\n\n    {\n      'error': 0,\n      'result': [\n        [\n          4761288, // order id\n          1583246870, // timestamp\n          163813.12, // volume\n          278499.03, // rate\n          0.5882 // amount\n        ],\n        [\n          4761287,\n          1583246870,\n          379232.12,\n          278499.03,\n          1.3617\n        ]\n      ]\n    }\n\n\n### Viewing books <a name=\"viewingbooks\"></a>\n\nList all open orders.\n\n#### Function:\n    bitkub.books(sym=\"THB_BTC\", lmt=1)\n#### Parameter:\n\n  * ```sym``` **string** The symbol\n  * ```lmt``` **int** No. of imit to Parameter open orders ```default``` 1\n\n#### Response:\n\n    {\n      'error': 0,\n      'result': {\n        'asks': [\n          [\n            4761425, // order id\n            1583247105, // timestamp\n            360885.74, // volume\n            278300.17, // rate\n            1.29675 // amount\n          ]\n        ],\n        'bids': [\n          [\n            4633099, // order id\n            1583247090, // timestamp\n            622146.15, // volume\n            277946.2, // rate\n            2.23836897 // amount\n          ]\n        ]\n      }\n    }\n\n\n\n### Viewing tradingview history <a name=\"viewingtradingviewhistory\"></a>\n\nGet historical data for TradingView chart.\n\n#### Function:\n    bitkub.tradingview(sym='THB_BTC', int=1, frm='', to='')\n#### Parameter:\n\n  * ```sym``` **string** The symbol\n  * ```int``` **int** Chart resolution (1, 5, 15, 60, 240, 1D) ```default``` 1\n  * ```frm``` **int** Timestamp of the starting time\n  * ```to``` **int** Timestamp of the ending time\n\n#### Response:\n    \n    {\n      'c': [\n        1685000,\n        1680699.95,\n        1688998.99,\n        1692222.22\n      ],\n      'h': [\n        1685000,\n        1685000,\n        1689000,\n        1692222.22\n      ],\n      'l': [\n        1680053.22,\n        1671000,\n        1680000,\n        1684995.07\n      ],\n      'o': [\n        1682500,\n        1685000,\n        1680100,\n        1684995.07\n      ],\n      's': \"ok\",\n      't': [\n        1633424400,\n        1633425300,\n        1633426200,\n        1633427100\n      ],\n      'v': [\n        4.604352630000001,\n        8.530631670000005,\n        4.836581560000002,\n        2.8510189200000022\n      ]\n    }\n\n### Viewing depth <a name=\"viewingdepth\"></a>\n\nGet depth information.\n\n#### Function:\n    bitkub.depth(sym='THB_BTC', lmt=1)\n#### Parameter:\n\n  * ```sym``` **string** The symbol\n  * ```lmt``` **int** Depth size  ```default``` 1\n\n#### Response:\n\n    {\n      'asks': [\n        [\n          277946.16,\n          1.29675\n        ]\n      ],\n      'bids': [\n        [\n          277936.27,\n          0.94071896\n        ]\n      ]\n    }\n\n\n### Viewing wallet <a name=\"viewingwallet\"></a>\n\nGet user available balances. ```Required initial secure obj```\n\n#### Function:\n    bitkub.wallet()\n\n#### Response:\n\n    {\n      'error': 0,\n      'result': {\n        'THB': 0,\n        'BTC': 0,\n        'ETH': 0\n      }\n    }\n\n\n### Viewing balances <a name=\"viewingbalances\"></a>\n\nGet balances info: this includes both available and reserved balances. ```Required initial secure obj```\n\n#### Function:\n    bitkub.balances()\n\n#### Response:\n\n    {\n      'error': 0,\n      'result': {\n        'THB': {\n          'available': 0,\n          'reserved': 0\n        },\n        'BTC': {\n          'available': 0,\n          'reserved': 0\n        }\n      }\n    }\n\n\n### Create buy order <a name=\"createbuyorder\"></a>\n\nCreate a buy order. ```Required initial secure obj```\n\n#### Function:\n    bitkub.place_bid(sym='THB_BTC', amt=1, rat=1, typ='limit', client_id='a7sjas7', post_only=false)\n\n#### Parameter:\n  * ```sym``` **string** The symbol\n  * ```amt``` **float** Amount you want to spend with no trailing zero (e.g 1000.00 is invalid, 1000 is ok) ```default``` 1\n  * ```rat``` **float** Rate you want for the order with no trailing zero (e.g 1000.00 is invalid, 1000 is ok) ```default``` 1\n  * ```typ``` **string** Order type: limit or market ```default``` limit\n  * ```client_id``` **string** your id for reference ( not required )\n  * ```post_only``` **bool** Postonly flag: ```true``` or ```false``` ( not required )\n\n\n#### Response:\n\n    {\n      'error': 0,\n      'result': {\n        'id': 1,\n        'hash': 'fwQ6dnQWQPs4cbatF5Am2xCDP1J',\n        'typ': 'limit',\n        'amt': 1,\n        'rat': 1,\n        'fee': 2.5,\n        'cre': 2.5,\n        'rec': 0.06666666,\n        'ts': 1533834547\n      }\n    }\n\n### Create sell order <a name=\"createsellorder\"></a>\n\nCreate a sell order. ```Required initial secure obj```\n\n#### Function:\n    bitkub.place_ask(sym='THB_BTC', amt=1, rat=1, typ='limit', client_id='a7sjas7', post_only=false)\n\n#### Parameter:\n  * ```sym``` **string** The symbol\n  * ```amt``` **float** Amount you want to spend with no trailing zero (e.g 1000.00 is invalid, 1000 is ok) ```default``` 1\n  * ```rat``` **float** Rate you want for the order with no trailing zero (e.g 1000.00 is invalid, 1000 is ok) ```default``` 1\n  * ```typ``` **string** Order type: limit or market ```default``` limit'\n  * ```client_id``` **string** your id for reference ( not required )\n  * ```post_only``` **bool** Postonly flag: ```true``` or ```false``` ( not required )\n\n\n#### Response:\n\n    {\n      'error': 0,\n      'result': {\n        'id': 1,\n        'hash': 'fwQ6dnQWQPs4cbatF5Am2xCDP1J',\n        'typ': 'limit',\n        'amt': 1,\n        'rat': 1,\n        'fee': 2.5,\n        'cre': 2.5,\n        'rec': 0.06666666,\n        'ts': 1533834547\n      }\n    }\n\n\n### Cancel order<a name=\"cancelorder\"></a>\n\nCancel an open order. ```Required initial secure obj```\n\n#### Function:\n    bitkub.cancel_order(sym='THB_BTC', id=1, sd=1, hash='XXXXXX')\n\n#### Parameter:\n  * ```sym``` **string** The symbol\n  * ```id``` **int** Order id you wish to cancel\n  * ```sd``` **string** Order side: buy or sell ```default``` buy\n  * ```hash``` **string** Cancel an order with order hash (optional). You don't need to specify sym, id, and sd when you specify order hash.\n\n\n#### Response:\n\n    {\n      'error': 0\n    }\n\n\n### My open orders<a name=\"myopenorders\"></a>\n\nList all open orders of the given symbol. ```Required initial secure obj```\n\n#### Function:\n    bitkub.my_open_orders(sym='THB_BTC')\n\n#### Parameter:\n  * ```sym``` **string** The symbol\n\n\n#### Response:\n\n    {\n      'error': 0,\n      'result': [\n        {\n          'id': 2,\n          'hash': 'fwQ6dnQWQPs4cbatFSJpMCcKTFR',\n          'side': 'SELL',\n          'type': 'limit',\n          'rate': 15000,\n          'fee': 35.01,\n          'credit': 35.01,\n          'amount': 0.93333334,\n          'receive': 14000,\n          'parent_id': 1,\n          'super_id': 1,\n          'ts': 1533834844\n        }\n      ]\n    }\n\n\n### My order history<a name=\"myorderhistory\"></a>\n\nList all orders that have already matched. ```Required initial secure obj```\n\n#### Function:\n    bitkub.my_open_history(sym='THB_BTC', p=1, lmt=10)\n\n#### Parameter:\n  * ```sym``` **string** The symbol\n  * ```p``` **string** Page (optional)\n  * ```lmt``` **string** Limit (optional)\n  * ```start``` **string** Start timestamp (optional)\n  * ```end``` **string** End timestamp (optional)\n\n\n#### Response:\n\n    {\n      'error': 0,\n      'result': [\n        {\n          'txn_id': 'ETHBUY0000000197',\n          'order_id': 240,\n          'hash': 'fwQ6dnQWQPs4cbaujNyejinS43a',\n          'parent_order_id': 0,\n          'super_order_id': 0,\n          'taken_by_me': true,\n          'is_maker': true,\n          'side': 'buy',\n          'type': 'limit',\n          'rate': 13335.57,\n          'fee': 0.34,\n          'credit': 0.34,\n          'amount': 0.00999987,\n          'ts': 1531513395\n        }\n\n    {\n      'error': 0,\n      'result': {\n          'id': 289,\n      ],\n      'pagination': {\n        'page': 2,\n        'last': 3,\n        'next': 3,\n        'prev': 1\n      }\n    }\n\n\n### Order info<a name=\"orderinfo\"></a>\n\nGet information regarding the specified order. ```Required initial secure obj```\n\n#### Function:\n    bitkub.order_info(sym='THB_BTC', id=1, sd='buy', hash='XXXXXX')\n\n#### Parameter:\n  * ```sym``` **string** The symbol\n  * ```id``` **int** Order id\n  * ```sd``` **string** Order side: buy or sell ```default```  buy\n  * ```hash``` **string** Lookup an order with order hash (optional). You don't need to specify sym, id, and sd when you specify order hash.\n\n\n#### Response:\n\n    {\n      'error': 0,\n      'result': {\n          'id': 289,\n          'first': 289,\n          'parent': 0,\n          'last': 316,\n          'amount': 4000,\n          'rate': 291000,\n          'fee': 10,\n          'credit': 10,\n          'filled': 3999.97,\n          'total': 4000,\n          'status': 'filled',\n          'partial_filled': False,\n          'remaining': 0,\n          'history': [\n            {\n                'amount': 98.14848,\n                'credit': 0.25,\n                'fee': 0.25,\n                'id': 289,\n                'rate': 291000,\n                'timestamp': 1525944169\n            }\n          ]\n        }\n      }\n\n\n### Crypto addresses<a name=\"cryptoaddress\"></a>\n\nList all crypto addresses. ```Required initial secure obj```\n\n#### Function:\n    bitkub.crypto_address(p=1, lmt=1)\n\n#### Parameter:\n  * ```p``` **int** Page (optional) ```default``` 1\n  * ```lmt``` **int** Limit (optional) ```default``` 10\n\n\n#### Response:\n\n    {\n      'error': 0,\n      'result': [\n        {\n           'currency': 'BTC',\n           'address': '3BtxdKw6XSbneNvmJTLVHS9XfNYM7VAe8k',\n           'tag': 0,\n           'time': 1570893867\n        }\n      ],\n      'pagination': {\n        'page': 1,\n        'last\": 1\n      }\n    }\n\n\n### Crypto withdraw<a name=\"cryptowithdraw\"></a>\n\nMake a withdrawal to a trusted address. ```Required initial secure obj```\n\n#### Function:\n    bitkub.crypto_withdraw(cur='BTC', amt=0.1, adr='4asyjKw6XScneNvhJTLVHS9XfNYM7VBf8x', mem='', net='')\n\n#### Parameter:\n  * ```cur``` **string** Currency for withdrawal (e.g. BTC, ETH)\n  * ```amt``` **float** Amount you want to withdraw\n  * ```adr``` **string** Address to which you want to withdraw\n  * ```mem``` **string** (Optional) Memo or destination tag to which you want to withdraw\n  * ```net``` **string** Cryptocurrency network to withdraw\n\n\n#### Response:\n\n    {\n      'error': 0,\n      'result': {\n          'txn': 'BTCWD0000012345',\n          'adr': '4asyjKw6XScneNvhJTLVHS9XfNYM7VBf8x'\n          'mem': '',\n          'cur': 'BTC',\n          'amt': 0.1,\n          'fee': 0.0002,\n          'ts': 1569999999\n      }\n    }\n\n\n### Crypto internal withdraw<a name=\"cryptointernalwithdraw\"></a>\n\nMake a withdrawal to a trusted address. ```Required initial secure obj```\n\nThe destination address is not required to be a trusted address. This API is not enabled by default, Only KYB users can request this feature by contacting us via support@bitkub.com\n\n#### Function:\n    bitkub.crypto_internal_withdraw(cur='BTC', amt=0.1, adr='4asyjKw6XScneNvhJTLVHS9XfNYM7VBf8x', mem='', net='')\n\n#### Parameter:\n  * ```cur``` **string** Currency for withdrawal (e.g. BTC, ETH)\n  * ```amt``` **float** Amount you want to withdraw\n  * ```adr``` **string** Address to which you want to withdraw\n  * ```mem``` **string** (Optional) Memo or destination tag to which you want to withdraw\n  * ```net``` **string** Cryptocurrency network to withdraw\n\n\n#### Response:\n\n    {\n      'error': 0,\n      'result': {\n          'txn': 'BTCWD0000012345',\n          'adr': '4asyjKw6XScneNvhJTLVHS9XfNYM7VBf8x'\n          'mem': '',\n          'cur': 'BTC',\n          'amt': 0.1,\n          'fee': 0.0002,\n          'ts': 1569999999\n      }\n    }\n\n\n### Crypto deposit history<a name=\"cryptodeposithistory\"></a>\n\nList crypto deposit history. ```Required initial secure obj```\n\n#### Function:\n    bitkub.crypto_deposit_history(p=1, lmt=1)\n\n#### Parameter:\n  * ```p``` **int** Page (optional) ```default``` 1\n  * ```lmt``` **int** Limit (optional) ```default``` 10\n\n\n#### Response:\n\n    {\n      'error': 0,\n      'result': [\n        {\n           'hash': 'XRPWD0000100276',\n           'currency': 'XRP',\n           'amount': 5.75111474,\n           'from_address': 'sender address',\n           'to_address': 'receipent address',\n           'confirmations': 1,\n           'status': 'complete',\n           'time': 1570893867\n        }\n      ],\n      'pagination': {\n        'page': 1,\n        'last': 1\n      }\n    }\n\n\n### Crypto withdraw history<a name=\"cryptowithdrawhistory\"></a>\n:\nList crypto withdrawal history. ```Required initial secure obj```\n\n#### Function:\n    bitkub.crypto_withdraw_history(p=1, lmt=1)\n\n#### Parameter:\n  * ```p``` **int** Page (optional) ```default``` 1\n  * ```lmt``` **int** Limit (optional) ```default``` 10\n\n\n#### Response:\n\n    {\n      'error': 0,\n      'result': [\n        {\n          'txn_id': 'XRPWD0000100276',\n          'hash': 'send_internal',\n          'currency': 'XRP',\n          'amount': '5.75111474',\n          'fee': 0.01,\n          'address': 'rpXTzCuXtjiPDFysxq8uNmtZBe9Xo97JbW',\n          'status': 'complete',\n          'time': 1570893493\n        }\n      ],\n      'pagination': {\n        'page': 1,\n        'last': 1\n      }\n    }\n\n\n### Crypto generate address<a name=\"cryptogenerateaddress\"></a>\nGenerate a new crypto address (will replace existing address; previous address can still be used to received funds)\nList all approved bank accounts. ```Required initial secure obj```\n\n#### Function:\n    bitkub.crypto_generate_address(sym='THB_BTC')\n\n#### Parameter:\n  * ```sym``` **string** The symbol\n\n\n#### Response:\n\n    {\n      'error': 0,\n      'result': [\n        {\n           'currency': 'BTC',\n           'address': '0x520165471daa570ab632dd504c6af257bd36edfb',\n           'memo': ''\n        }\n      ]\n    }\n\n\n\n### Fiat accounts<a name=\"fiataccounts\"></a>\n\nList all approved bank accounts. ```Required initial secure obj```\n\n#### Function:\n    bitkub.fiat_accounts(p=1, lmt=1)\n\n#### Parameter:\n  * ```p``` **int** Page (optional) ```default``` 1\n  * ```lmt``` **int** Limit (optional) ```default``` 10\n\n\n#### Response:\n\n    {\n      'error': 0,\n      'result': [\n        {\n          'id': '7262109099',\n          'bank': 'Kasikorn Bank',\n          'name': 'Somsak',\n          'time': 1570893867\n        }\n      ],\n      'pagination': {\n        'page': 1,\n        'last': 1\n      }\n    }\n\n\n### Fiat withdraw<a name=\"fiatwithdraw\"></a>\n\nMake a withdrawal to an approved bank account. ```Required initial secure obj```\n\n#### Function:\n    bitkub.fiat_withdraw(id=1, amt=1)\n\n#### Parameter:\n  * ```id``` **string** Bank account id\n  * ```amt``` **float** Amount you want to withdraw\n\n\n#### Response:\n\n    {\n      'error': 0,\n      'result': {\n        'txn': 'THBWD0000012345',\n        'acc': '7262109099',\n        'cur': 'THB',\n        'amt': 21,\n        'fee': 20,\n        'rec': 1,\n        'ts': 1569999999\n      }\n    }\n\n\n### Fiat deposit history<a name=\"fiatdeposithistory\"></a>\n\nList fiat deposit history. ```Required initial secure obj```\n\n#### Function:\n    bitkub.fiat_deposit_history(p=1, lmt=1)\n\n#### Parameter:\n  * ```p``` **int** Page (optional) ```default``` 1\n  * ```lmt``` **int** Limit (optional) ```default``` 10\n\n\n#### Response:\n\n    {\n      'error':0,\n      'result':[\n        {\n           'txn_id': 'THBDP0000012345',\n           'currency': 'THB',\n           'amount': 5000.55,\n           'status': 'complete',\n           'time': 1570893867\n        }\n      ],\n      'pagination':{\n        'page': 1,\n        'last': 1\n      }\n    }\n\n\n### Fiat withdraw history<a name=\"fiatwithdrawhistory\"></a>\n\nList fiat withdrawal history. ```Required initial secure obj```\n\n#### Function:\n    bitkub.fiat_withdraw_history(p=1, lmt=1)\n\n#### Parameter:\n  * ```p``` **int** Page (optional) ```default``` 1\n  * ```lmt``` **int** Limit (optional) ```default``` 10\n\n\n#### Response:\n\n    {\n      'error': 0,\n      'result': [\n        {\n           'txn_id': 'THBDP0000012345',\n           'currency': 'THB',\n           'amount': 5000.55,\n           'fee': 20,\n           'status': 'complete',\n           'time': 1570893867\n        }\n      ],\n      'pagination':{\n        'page': 1,\n        'last': 1\n      }\n    }\n\n\n### Market wstoken<a name=\"marketwstoken\"></a>\n\nGet the token for websocket authentication. ```Required initial secure obj```\n\n#### Function:\n    bitkub.market_wstoken()\n\n#### Response:\n\n    {\n      'error': 0,\n      'result': 'sdCBCTwaS2Z1IBB6uTCefIbVN6dQVz9dkDeU96IoFJp14GGhlw9hoUDNe1KSYC23dXBPIqyX2QjVEOFHITxgPMvo8kdVaTkiZBA8KgvVTSMsq6JjjlyERDVZn3tt4PEp'\n    }\n\n### User limits<a name=\"userlimits\"></a>\n\nCheck deposit/withdraw limitations and usage. ```Required initial secure obj```\n\n#### Function:\n    bitkub.user_limits()\n\n#### Response:\n\n    {\n      'error': 0,\n      'result': {\n        'limits': {\n          'crypto': {\n            'deposit': 0,\n            'withdraw': 0\n          },\n          'fiat': {\n            'deposit': 0,\n            'withdraw': 0\n          }\n        },\n        'usage': {\n          'crypto': {\n            'deposit': 0,\n            'withdraw': 0,\n            'deposit_percentage': 0,\n            'withdraw_percentage': 0,\n            'deposit_thb_equivalent': 0,\n            'withdraw_thb_equivalent': 0\n          },\n          'fiat': {\n            'deposit': 0,\n            'withdraw': 0,\n            'deposit_percentage': 0,\n            'withdraw_percentage': 0\n          }\n        },\n        'rate': 177100.32\n      }\n    }\n\n\n### User trading-credit<a name=\"usertradingcredits\"></a>\n\nCheck trading credit balance. ```Required initial secure obj```\n\n#### Function:\n    bitkub.user_trading_credits()\n\n#### Response:\n\n    {\n      'error': 0,\n      'result': 0\n    }\n",
    "bugtrack_url": null,
    "license": "sang_sakarin",
    "summary": "A Python library for Bitkub API",
    "version": "2.0.0",
    "project_urls": {
        "Homepage": "https://github.com/sang-sakarin/bitkub"
    },
    "split_keywords": [
        "bitkub",
        "bitkub-python",
        "bitkub-python-sdk"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "c3887be65d10f90e9b81a7b252a6ce2a6fc3efaa4c0daf227aab61c57ff10107",
                "md5": "2f7db8b10cedc7ba136ac78bdb28a925",
                "sha256": "9930a59b0c55cda504220b9e62f22c4499d70617f8ebde7a1c8ce9be7bafd074"
            },
            "downloads": -1,
            "filename": "bitkub-2.0.0.tar.gz",
            "has_sig": false,
            "md5_digest": "2f7db8b10cedc7ba136ac78bdb28a925",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 14867,
            "upload_time": "2024-10-26T09:04:38",
            "upload_time_iso_8601": "2024-10-26T09:04:38.710657Z",
            "url": "https://files.pythonhosted.org/packages/c3/88/7be65d10f90e9b81a7b252a6ce2a6fc3efaa4c0daf227aab61c57ff10107/bitkub-2.0.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-10-26 09:04:38",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "sang-sakarin",
    "github_project": "bitkub",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": false,
    "lcname": "bitkub"
}
        
Elapsed time: 0.78542s