{"id":23840272,"url":"https://github.com/edennis/krakex","last_synced_at":"2025-10-24T22:39:47.793Z","repository":{"id":45100083,"uuid":"111149000","full_name":"edennis/krakex","owner":"edennis","description":"Elixir client for the Kraken Bitcoin Exchange API","archived":false,"fork":false,"pushed_at":"2022-01-08T12:09:56.000Z","size":148,"stargazers_count":22,"open_issues_count":1,"forks_count":15,"subscribers_count":2,"default_branch":"master","last_synced_at":"2023-09-16T16:28:20.104Z","etag":null,"topics":["bitcoin","crypto-exchange","cryptocurrency","elixir-client","kraken","kraken-exchange-api"],"latest_commit_sha":null,"homepage":null,"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/edennis.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2017-11-17T20:45:17.000Z","updated_at":"2023-09-01T08:52:15.000Z","dependencies_parsed_at":"2022-09-16T13:30:40.262Z","dependency_job_id":null,"html_url":"https://github.com/edennis/krakex","commit_stats":null,"previous_names":[],"tags_count":10,"template":null,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/edennis%2Fkrakex","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/edennis%2Fkrakex/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/edennis%2Fkrakex/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/edennis%2Fkrakex/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/edennis","download_url":"https://codeload.github.com/edennis/krakex/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":232137217,"owners_count":18477791,"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":["bitcoin","crypto-exchange","cryptocurrency","elixir-client","kraken","kraken-exchange-api"],"created_at":"2025-01-02T17:30:45.277Z","updated_at":"2025-10-24T22:39:47.742Z","avatar_url":"https://github.com/edennis.png","language":"Elixir","readme":"# Krakex\n\n[![Build Status](https://github.com/edennis/krakex/workflows/Elixir%20CI/badge.svg)](https://github.com/edennis/krakex/actions/workflows/elixir.yml)\n[![Coverage Status](https://coveralls.io/repos/github/edennis/krakex/badge.svg?branch=master)](https://coveralls.io/github/edennis/krakex?branch=master)\n[![Hex.pm](https://img.shields.io/hexpm/v/krakex.svg)](https://hex.pm/packages/krakex)\n\nElixir client for the [Kraken Bitcoin Exchange API](https://www.kraken.com/help/api)\n\n\u003e Note that this README refers to the `master` branch of Krakex, not the latest\n  released version on Hex. See [the documentation](http://hexdocs.pm/krakex) for\n  the documentation of the version you're using.\n\n## Installation\n\nThe package can be installed by adding `krakex` to your list of dependencies in `mix.exs`:\n\n```elixir\ndef deps do\n  [\n    {:krakex, \"~\u003e 0.7.0\"}\n  ]\nend\n```\n\n## Configuration\n\nThe Kraken API consists of public and private calls. While you can use the public API as you like,\nyou'll need to create an account and get yourself an API key if you want to do more. To use the\nprivate API you'll need to add some configuration to your Mix config:\n\n```elixir\nconfig :krakex,\n  api_key: System.get_env(\"KRAKEN_API_KEY\"),\n  private_key: System.get_env(\"KRAKEN_PRIVATE_KEY\")\n```\n\n## Usage\n\nThe entire functionality of the API can be accessed via the `Krakex` module. To get started just\nconfigure your API credentials as described above and call the functions:\n\n```elixir\niex(1)\u003e Krakex.balance()\n{:ok,\n %{\"BCH\" =\u003e \"0.0000000000\", \"XETH\" =\u003e \"0.0000000000\", \"ZEUR\" =\u003e \"50.00\"}}\n```\n\nIf you need to use multiple Kraken accounts in your application this can be achieved by explicitly\ndefining `Krakex.Client` structs and passing them as the first argument to any of the functions\ndefined in the `Krakex` module:\n\n```elixir\nclient1 = Krakex.Client.new(\"api_key1\", \"secret1\")\nclient2 = Krakex.Client.new(\"api_key2\", \"secret2\")\n\nbalance1 = client1 |\u003e Krakex.trade_balance(asset: \"ZUSD\")\nbalance2 = client2 |\u003e Krakex.trade_balance(asset: \"EUR\")\n```\n\n## TODO - Help wanted!\n\n### Private user data\n\n- [ ] [`add_export/3`](https://www.kraken.com/features/api#add-history-export)\n- [ ] [`export_status/2`](https://www.kraken.com/features/api#get-export-statuses)\n- [ ] [`retrieve_export/2`](https://www.kraken.com/features/api#get-history-export)\n- [ ] [`remove_export/3`](https://www.kraken.com/features/api#remove-history-export)\n\n### Private user trading\n\n- [ ] [`cancel_all/1`](https://www.kraken.com/features/api#cancel-all-open-orders)\n- [ ] [`cancel_all_orders_after/2`](https://www.kraken.com/features/api#cancel-all-orders-after)\n\n\n### Private user funding calls\n\n- [ ] [`withdraw/5`](https://www.kraken.com/help/api#withdraw-funds)\n- [ ] [`withdraw_status/3`](https://www.kraken.com/help/api#withdraw-status)\n- [ ] [`withdraw_cancel/4`](https://www.kraken.com/help/api#withdraw-cancel)\n- [ ] [`wallet_transfer/4`](https://www.kraken.com/features/api#wallet-transfer)\n\n## Contributing\n\n1. Fork it (https://github.com/edennis/krakex/fork)\n2. Create your feature branch (`git checkout -b my-new-feature`)\n3. Commit your changes (`git commit -am 'Add some feature'`)\n4. Push to the branch (`git push origin my-new-feature`)\n5. Create new Pull Request\n\n## License\n\nThis project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.\n\nCopyright (c) 2018 Erick Dennis\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fedennis%2Fkrakex","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fedennis%2Fkrakex","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fedennis%2Fkrakex/lists"}