{ "info": { "author": "Matheus Dussin Bampi", "author_email": "matheusbampi@gmail.com", "bugtrack_url": null, "classifiers": [ "Development Status :: 4 - Beta", "Intended Audience :: Developers", "License :: OSI Approved :: MIT License", "Operating System :: OS Independent", "Programming Language :: Python :: 3" ], "description": "# Mercado Bitcoin API Client for Python\n\nAPI Client in Python for Mercado Bitcoin\n\n## Installation\n\nRun the following to install:\n```python\n pip install mercado-bitcoin\n```\n\n## Usage\n\n### Data API\n```python\nfrom mercado_bitcoin import DataAPI\nimport json\n\nresp = DataAPI.day_summary('BTC', 2019, 9, 11).json()\nprint(json.dumps(resp, indent=2))\n```\nResponse:\n```json\n{\n \"date\": \"2019-09-11\",\n \"opening\": 41772.12033,\n \"closing\": 41496.86984,\n \"lowest\": 41200,\n \"highest\": 41955.55,\n \"volume\": 11179626.56206287,\n \"quantity\": 269.18932163,\n \"amount\": 7917,\n \"avg_price\": 41530.72081153\n}\n```\n\n### Trade API\n```python\nfrom mercado_bitcoin import TradeAPI\nimport json\n\nTAPI_ID = \nTAPI_SECRET = \ntapi = TradeAPI(TAPI_ID, TAPI_SECRET)\n\ninfo = tapi.get_account_info()\nprint(json.dumps(info, indent=2))\n```\nResponse\n```json\n{\n \"response_data\": {\n \"balance\": {\n \"brl\": {\n \"available\": \"0.00000000\",\n \"total\": \"0.00000000\"\n },\n \"btc\": {\n \"available\": \"0.00000000\",\n \"total\": \"0.00000000\",\n \"amount_open_orders\": 0\n },\n \"ltc\": {\n \"available\": \"0.00000000\",\n \"total\": \"0.00000000\",\n \"amount_open_orders\": 0\n },\n \"bch\": {\n \"available\": \"0.00000000\",\n \"total\": \"0.00000000\",\n \"amount_open_orders\": 0\n },\n \"xrp\": {\n \"available\": \"0.00000000\",\n \"total\": \"0.00000000\",\n \"amount_open_orders\": 0\n },\n \"eth\": {\n \"available\": \"0.00000000\",\n \"total\": \"0.00000000\",\n \"amount_open_orders\": 0\n }\n },\n \"withdrawal_limits\": {\n \"brl\": {\n \"available\": \"20000.00\",\n \"total\": \"20000.00\"\n },\n \"btc\": {\n \"available\": \"10.00000000\",\n \"total\": \"10.00000000\"\n },\n \"ltc\": {\n \"available\": \"500.00000000\",\n \"total\": \"500.00000000\"\n },\n \"bch\": {\n \"available\": \"25.00000000\",\n \"total\": \"25.00000000\"\n },\n \"xrp\": {\n \"available\": \"20000.00000000\",\n \"total\": \"20000.00000000\"\n },\n \"eth\": {\n \"available\": \"70.00000000\",\n \"total\": \"70.00000000\"\n }\n }\n },\n \"status_code\": 100,\n \"server_unix_timestamp\": \"1568299534\"\n}\n```\n\n## Data API (API de Dados)\n\nO acesso \u00c3\u00a0 API de Dados \u00c3\u00a9 p\u00c3\u00bablico, n\u00c3\u00a3o \u00c3\u00a9 necess\u00c3\u00a1rio criar uma conta tampouco autenticar.\n\n| Method | Description |\n| ----- | ------------ |\n| ticker | Retorna informa\u00c3\u00a7\u00c3\u00b5es com o resumo das \u00c3\u00baltimas 24 horas de negocia\u00c3\u00a7\u00c3\u00b5es. |\n| orderbook | Livro de ofertas \u00c3\u00a9 composto por duas listas: (1) uma lista com as ofertas de compras ordenadas pelo maior valor; (2) uma lista com as ofertas de venda ordenadas pelo menor valor. O livro mostra at\u00c3\u00a9 1000 ofertas de compra e at\u00c3\u00a9 1000 ofertas de venda. Uma oferta \u00c3\u00a9 constitu\u00c3\u00adda por uma ou mais ordens, sendo assim, a quantidade da oferta \u00c3\u00a9 o resultado da soma das quantidades das ordens de mesmo pre\u00c3\u00a7o unit\u00c3\u00a1rio. Caso uma oferta represente mais de uma ordem, a prioridade de execu\u00c3\u00a7\u00c3\u00a3o se d\u00c3\u00a1 com base na data de cria\u00c3\u00a7\u00c3\u00a3o da ordem, da mais antiga para a mais nova. |\n| trades | Hist\u00c3\u00b3rico de negocia\u00c3\u00a7\u00c3\u00b5es realizadas. |\n| day-summary | Retorna resumo di\u00c3\u00a1rio de negocia\u00c3\u00a7\u00c3\u00b5es realizadas. |\n\n### Trade API (API de Negociacao)\n\n- Para utilizar a API de negocia\u00c3\u00a7\u00c3\u00b5es do Mercado Bitcoin s\u00c3\u00a3o necess\u00c3\u00a1rios: \n - Criar uma conta\n - Gerar o PIN de Seguran\u00c3\u00a7a\n - Gerar uma chave da API\n \n - O acesso \u00c3\u00a0 API \u00c3\u00a9 limitado por padr\u00c3\u00a3o ao m\u00c3\u00a1ximo de 60 requisi\u00c3\u00a7\u00c3\u00b5es a cada 60 segundos, por usu\u00c3\u00a1rio e n\u00c3\u00a3o por chave\n\n| Method | Description |\n| ----- | ------------ |\n| list_system_messages | M\u00c3\u00a9todo para comunica\u00c3\u00a7\u00c3\u00a3o de eventos do sistema relativos \u00c3\u00a0 TAP\u00c3\u0152, entre eles bugs, corre\u00c3\u00a7\u00c3\u00b5es, manuten\u00c3\u00a7\u00c3\u00a3o programada e novas funcionalidades e vers\u00c3\u00b5es. O conte\u00c3\u00bado muda a medida que os eventos ocorrem. A comunica\u00c3\u00a7\u00c3\u00a3o externa, feita via Twitter e e-mail aos usu\u00c3\u00a1rios da TAPI, continuar\u00c3\u00a1 ocorrendo. Entretanto, essa forma permite ao desenvolvedor tratar as informa\u00c3\u00a7\u00c3\u00b5es juntamente ao seus logs ou at\u00c3\u00a9 mesmo automatizar comportamentos. |\n| get_account_info | Retorna dados da conta, como saldos das moedas (Real, BCash, Bitcoin, Ethereum, Litecoin e XRP), saldos considerando reten\u00c3\u00a7\u00c3\u00a3o em ordens abertas, quantidades de ordens abertas por moeda digital, limites de saque/transfer\u00c3\u00aancias das moedas. |\n| get_order | Retorna os dados da ordem de acordo com o ID informado. Dentre os dados est\u00c3\u00a3o as informa\u00c3\u00a7\u00c3\u00b5es das Opera\u00c3\u00a7\u00c3\u00b5es executadas dessa ordem. Apenas ordens que pertencem ao propriet\u00c3\u00a1rio da chave da TAPI pode ser consultadas. Erros espec\u00c3\u00adficos s\u00c3\u00a3o retornados para os casos onde o order_id informado n\u00c3\u00a3o seja de uma ordem v\u00c3\u00a1lida ou perten\u00c3\u00a7a a outro usu\u00c3\u00a1rio. |\n| list_orders | Retorna uma lista de at\u00c3\u00a9 200 ordens, de acordo com os filtros informados, ordenadas pela data de \u00c3\u00baltima atualiza\u00c3\u00a7\u00c3\u00a3o. As opera\u00c3\u00a7\u00c3\u00b5es executadas de cada ordem tamb\u00c3\u00a9m s\u00c3\u00a3o retornadas. Apenas ordens que pertencem ao propriet\u00c3\u00a1rio da chave da TAPI s\u00c3\u00a3o retornadas. Caso nenhuma ordem seja encontrada, \u00c3\u00a9 retornada uma lista vazia. |\n| list_orderbook | Retorna informa\u00c3\u00a7\u00c3\u00b5es do livro de negocia\u00c3\u00a7\u00c3\u00b5es (orderbook) do Mercado Bitcoin para o par de moedas (coin_pair) informado. Diferente do m\u00c3\u00a9todo orderbook p\u00c3\u00bablico descrito em /api-doc/#method_trade_api_orderbook, aqui s\u00c3\u00a3o fornecidas informa\u00c3\u00a7\u00c3\u00b5es importantes para facilitar a tomada de a\u00c3\u00a7\u00c3\u00a3o de clientes TAPI e sincronia das chamadas. Dentre elas, o n\u00c3\u00bamero da \u00c3\u00baltima ordem contemplada (latest_order_id) e n\u00c3\u00bamero das ordens do livro (order_id), descritos abaixo. Importante salientar que nesse m\u00c3\u00a9todo ordens de mesmo pre\u00c3\u00a7o n\u00c3\u00a3o s\u00c3\u00a3o agrupadas como feito no m\u00c3\u00a9todo p\u00c3\u00bablico. |\n| place_buy_order | Abre uma ordem de compra (buy ou bid) do par de moedas, quantidade de moeda digital e pre\u00c3\u00a7o unit\u00c3\u00a1rio limite informados. A cria\u00c3\u00a7\u00c3\u00a3o contempla o processo de confrontamento da ordem com o livro de negocia\u00c3\u00a7\u00c3\u00b5es. Assim, a resposta pode informar se a ordem foi executada (parcialmente ou n\u00c3\u00a3o) imediatamente ap\u00c3\u00b3s sua cria\u00c3\u00a7\u00c3\u00a3o e, assim, se segue ou n\u00c3\u00a3o aberta e ativa no livro. |\n| place_sell_order | Abre uma ordem de venda (sell ou ask) do par de moedas, quantidade de moeda digital e pre\u00c3\u00a7o unit\u00c3\u00a1rio limite informados. A cria\u00c3\u00a7\u00c3\u00a3o contempla o processo de confrontamento da ordem com o livro de negocia\u00c3\u00a7\u00c3\u00b5es. Assim, a resposta pode informar se a ordem foi executada (parcialmente ou n\u00c3\u00a3o) imediatamente ap\u00c3\u00b3s sua cria\u00c3\u00a7\u00c3\u00a3o e, assim, se segue ou n\u00c3\u00a3o aberta e ativa no livro. |\n| place_market_buy_order | Abre uma ordem de compra (buy ou bid) do par de moedas com volume em reais limite informado. A cria\u00c3\u00a7\u00c3\u00a3o contempla o processo de bloqueio do saldo para execu\u00c3\u00a7\u00c3\u00a3o da ordem e confrontamento da ordem com o livro de negocia\u00c3\u00a7\u00c3\u00b5es. Assim, a resposta pode informar se a ordem foi executada (parcialmente ou n\u00c3\u00a3o) imediatamente ap\u00c3\u00b3s sua cria\u00c3\u00a7\u00c3\u00a3o. Caso n\u00c3\u00a3o seja poss\u00c3\u00advel execut\u00c3\u00a1-la totalmente por restri\u00c3\u00a7\u00c3\u00b5es no saldo dispon\u00c3\u00advel do usu\u00c3\u00a1rio, o montante n\u00c3\u00a3o executado \u00c3\u00a9 cancelado.|\n| place_market_sell_order | Abre uma ordem de venda (sell ou ask) do par de moeda com quantidade da moeda digital informado. A cria\u00c3\u00a7\u00c3\u00a3o contempla o processo de confrontamento da ordem com o livro de negocia\u00c3\u00a7\u00c3\u00b5es. Assim, a resposta pode informar se a ordem foi executada (parcialmente ou n\u00c3\u00a3o) imediatamente ap\u00c3\u00b3s sua cria\u00c3\u00a7\u00c3\u00a3o. |\n| cancel_order | Cancela uma ordem, de venda ou compra, de acordo com o ID e par de moedas informado. O retorno contempla o sucesso ou n\u00c3\u00a3o do cancelamento, bem como os dados e status atuais da ordem. Somente ordens pertencentes ao pr\u00c3\u00b3prio usu\u00c3\u00a1rio podem ser canceladas. |\n| get_withdrawal | Retorna os dados de uma transfer\u00c3\u00aancia de moeda digital ou de um saque de Real (BRL). |\n| withdraw_coin | Requisita pedido de transfer\u00c3\u00aancia de moeda digital ou saque de Real. Assim, caso o valor de coin seja BRL, ent\u00c3\u00a3o realiza um saque para a conta banc\u00c3\u00a1ria informada. Caso o valor seja uma criptomoeda, realiza uma transa\u00c3\u00a7\u00c3\u00a3o para o endere\u00c3\u00a7o de moeda digital informado. |", "description_content_type": "text/markdown", "docs_url": null, "download_url": "https://github.com/mbampi/mercado-bitcoin/archive/v1.0.0.tar.gz", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/mbampi/mercado-bitcoin", "keywords": "bitcoin,trade,data,finance", "license": "", "maintainer": "", "maintainer_email": "", "name": "mercado-bitcoin", "package_url": "https://pypi.org/project/mercado-bitcoin/", "platform": "", "project_url": "https://pypi.org/project/mercado-bitcoin/", "project_urls": { "Download": "https://github.com/mbampi/mercado-bitcoin/archive/v1.0.0.tar.gz", "Homepage": "https://github.com/mbampi/mercado-bitcoin" }, "release_url": "https://pypi.org/project/mercado-bitcoin/1.0.0/", "requires_dist": null, "requires_python": ">=3.6", "summary": "API Client in Python for Mercado Bitcoin", "version": "1.0.0" }, "last_serial": 5823091, "releases": { "1.0.0": [ { "comment_text": "", "digests": { "md5": "dd045b0f9af92de506a46cd0699334b3", "sha256": "2ff1d342d55c1a7e80bfb2eac151a329e8f30acffc0c1b1f6da83df1d80edbc2" }, "downloads": -1, "filename": "mercado-bitcoin-1.0.0.tar.gz", "has_sig": false, "md5_digest": "dd045b0f9af92de506a46cd0699334b3", "packagetype": "sdist", "python_version": "source", "requires_python": ">=3.6", "size": 7761, "upload_time": "2019-09-12T23:28:44", "url": "https://files.pythonhosted.org/packages/6b/b7/d592552cd7ba3d0405e24523e50a918db673d3b584960cf0b4d564bdba98/mercado-bitcoin-1.0.0.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "dd045b0f9af92de506a46cd0699334b3", "sha256": "2ff1d342d55c1a7e80bfb2eac151a329e8f30acffc0c1b1f6da83df1d80edbc2" }, "downloads": -1, "filename": "mercado-bitcoin-1.0.0.tar.gz", "has_sig": false, "md5_digest": "dd045b0f9af92de506a46cd0699334b3", "packagetype": "sdist", "python_version": "source", "requires_python": ">=3.6", "size": 7761, "upload_time": "2019-09-12T23:28:44", "url": "https://files.pythonhosted.org/packages/6b/b7/d592552cd7ba3d0405e24523e50a918db673d3b584960cf0b4d564bdba98/mercado-bitcoin-1.0.0.tar.gz" } ] }