{"id":18031577,"url":"https://github.com/fremantle-industries/ex_bitmex","last_synced_at":"2025-03-29T04:31:45.204Z","repository":{"id":38820758,"uuid":"159876173","full_name":"fremantle-industries/ex_bitmex","owner":"fremantle-industries","description":"BitMEX API Client for Elixir","archived":false,"fork":false,"pushed_at":"2023-03-20T01:17:00.000Z","size":423,"stargazers_count":15,"open_issues_count":7,"forks_count":6,"subscribers_count":3,"default_branch":"main","last_synced_at":"2024-03-14T21:24:02.577Z","etag":null,"topics":["algorithmic-trading","automated-trading","bitcoin","bitmex","crypto","crypto-trader","elixir","fintech","hft","hft-trading","quant","trading","trading-bot","trading-systems"],"latest_commit_sha":null,"homepage":"","language":"Elixir","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/fremantle-industries.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2018-11-30T20:39:15.000Z","updated_at":"2024-03-10T11:38:07.000Z","dependencies_parsed_at":"2024-10-30T10:19:45.033Z","dependency_job_id":null,"html_url":"https://github.com/fremantle-industries/ex_bitmex","commit_stats":null,"previous_names":["fremantle-capital/ex_bitmex"],"tags_count":16,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fremantle-industries%2Fex_bitmex","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fremantle-industries%2Fex_bitmex/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fremantle-industries%2Fex_bitmex/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fremantle-industries%2Fex_bitmex/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/fremantle-industries","download_url":"https://codeload.github.com/fremantle-industries/ex_bitmex/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246140565,"owners_count":20729797,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["algorithmic-trading","automated-trading","bitcoin","bitmex","crypto","crypto-trader","elixir","fintech","hft","hft-trading","quant","trading","trading-bot","trading-systems"],"created_at":"2024-10-30T10:09:38.535Z","updated_at":"2025-03-29T04:31:43.523Z","avatar_url":"https://github.com/fremantle-industries.png","language":"Elixir","funding_links":[],"categories":[],"sub_categories":[],"readme":"# ExBitmex\n[![Build Status](https://github.com/fremantle-capital/ex_bitmex/workflows/Test/badge.svg?branch=master)](https://github.com/fremantle-capital/ex_bitmex/actions?query=workflow%3ATest)\n[![Coverage Status](https://coveralls.io/repos/github/fremantle-capital/ex_bitmex/badge.svg?branch=master)](https://coveralls.io/github/fremantle-capital/ex_bitmex?branch=master)\n[![hex.pm version](https://img.shields.io/hexpm/v/ex_bitmex.svg?style=flat)](https://hex.pm/packages/ex_bitmex)\n\nBitMEX API Client for Elixir\n\n## Installation\n\nAdd the `ex_bitmex` package to your list of dependencies in `mix.exs`:\n\n```elixir\ndef deps do\n  [{:ex_bitmex, \"~\u003e 0.6\"}]\nend\n```\n\n## Usage\n\n```elixir\n# Public\n{:ok, instruments, rate_limit} = ExBitmex.Rest.Instrument.Index.get(start: 0, count: 20)\n\n# Private\ncredentials = %ExBitmex.Credentials{\n  api_key: System.get_env(\"BITMEX_API_KEY\"),\n  api_secret: System.get_env(\"BITMEX_API_SECRET\")\n}\n\n{:ok, positions, rate_limit} = ExBitmex.Rest.Position.Index.get(credentials)\n```\n\n## WebSocket\n\nCreate a WebSocket wrapper with a handler\n\n```elixir\ndefmodule BitMexWebSocketWrapper do\n  use ExBitmex.WebSocket\n\n  def handle_response(json, _state) do\n    Logger.warn(\"Received #{inspect(json)}\")\n  end\nend\n```\n\n## REST Status\n\n#### Announcement\n\n- [ ] `GET /announcement`\n- [ ] `GET /announcement/urgent`\n\n#### APIKey\n\n- [ ] `GET /apiKey`\n\n#### Chat\n\n- [ ] `GET /chat`\n- [ ] `POST /chat`\n- [ ] `GET /chat/channels`\n- [ ] `GET /chat/connected`\n\n#### Execution\n\n- [ ] `GET /execution`\n- [ ] `GET /execution/tradeHistory`\n\n#### Funding\n\n- [x] `GET /funding`\n\n#### GlobalNotification\n\n- [ ] `GET /globalNotification`\n\n#### Instrument\n\n- [x] `GET /instrument`\n- [x] `GET /instrument/active`\n- [x] `GET /instrument/activeAndIndices`\n- [x] `GET /instrument/activeIntervals`\n- [x] `GET /instrument/compositeIndex`\n- [x] `GET /instrument/indicies`\n\n#### Insurance\n\n- [ ] `GET /insurance`\n\n#### Leaderboard\n\n- [ ] `GET /leaderboard`\n- [ ] `GET /leaderboard/name`\n\n#### Liquidation\n\n- [ ] `GET /liquidation`\n\n#### Order\n\n- [ ] `GET /order`\n- [x] `PUT /order`\n- [x] `POST /order`\n- [x] `DELETE /order`\n- [x] `DELETE /order/all`\n- [x] `PUT /order/bulk`\n- [ ] `POST /order/bulk`\n- [ ] `POST /order/cancelAllAfter`\n- [ ] `POST /order/closePosition`\n\n#### OrderBook\n\n- [ ] `GET /orderBook/L2`\n\n#### Position\n\n- [x] `GET /position`\n- [ ] `POST /position/isolate`\n- [ ] `POST /position/leverage`\n- [ ] `POST /position/riskLimit`\n- [ ] `POST /position/transferMargin`\n\n#### Quote\n\n- [ ] `GET /quote`\n- [ ] `GET /quote/bucketed`\n\n#### Schema\n\n- [ ] `GET /schema`\n- [ ] `GET /schema/websocketHelp`\n\n#### Settlement\n\n- [ ] `GET /settlement`\n\n#### Stats\n\n- [ ] `GET /stats`\n- [ ] `GET /stats/history`\n- [ ] `GET /stats/historyUSD`\n\n#### Trade\n\n- [x] `GET /trade`\n- [ ] `GET /trade/bucketed`\n\n#### User\n\n- [x] `GET /user`\n- [x] `GET /user/affiliateStatus`\n- [ ] `POST /user/cancelWithdrawal`\n- [ ] `GET /user/checkReferralCode`\n- [x] `GET /user/commmission`\n- [ ] `POST /user/communicationToken`\n- [ ] `POST /user/confirmEmail`\n- [ ] `POST /user/confirmWithdrawal`\n- [ ] `GET /user/depositAddress`\n- [ ] `GET /user/executionHistory`\n- [ ] `POST /user/logout`\n- [x] `GET /user/margin`\n- [ ] `GET /user/minWithdrawalFee`\n- [ ] `POST /user/preferences`\n- [ ] `GET /user/quoteFillRatio`\n- [ ] `POST /user/requestWithdrawal`\n- [x] `GET /user/wallet`\n- [x] `GET /user/walletHistory`\n- [ ] `GET /user/walletSummary`\n\n#### UserEvent\n\n- [ ] `GET /userEvent`\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffremantle-industries%2Fex_bitmex","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ffremantle-industries%2Fex_bitmex","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffremantle-industries%2Fex_bitmex/lists"}