{"id":15632180,"url":"https://github.com/khiav223577/max_exchange_api","last_synced_at":"2025-10-24T19:15:02.988Z","repository":{"id":45893752,"uuid":"379656050","full_name":"khiav223577/max_exchange_api","owner":"khiav223577","description":"MAX Exchange API Ruby SDK","archived":false,"fork":false,"pushed_at":"2024-09-14T18:22:15.000Z","size":68,"stargazers_count":2,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-10-07T22:57:57.878Z","etag":null,"topics":["api","cryptocurrency","cryptocurrency-api","cryptocurrency-exchanges","maicoin","max","ruby"],"latest_commit_sha":null,"homepage":"","language":"Ruby","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/khiav223577.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","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":"2021-06-23T15:52:17.000Z","updated_at":"2024-09-14T18:22:18.000Z","dependencies_parsed_at":"2024-10-23T02:01:21.998Z","dependency_job_id":null,"html_url":"https://github.com/khiav223577/max_exchange_api","commit_stats":{"total_commits":77,"total_committers":3,"mean_commits":"25.666666666666668","dds":"0.22077922077922074","last_synced_commit":"0460c5b3288ec72fecff3f55c18e8bc250c5af56"},"previous_names":[],"tags_count":7,"template":false,"template_full_name":"khiav223577/gem_template","purl":"pkg:github/khiav223577/max_exchange_api","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/khiav223577%2Fmax_exchange_api","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/khiav223577%2Fmax_exchange_api/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/khiav223577%2Fmax_exchange_api/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/khiav223577%2Fmax_exchange_api/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/khiav223577","download_url":"https://codeload.github.com/khiav223577/max_exchange_api/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/khiav223577%2Fmax_exchange_api/sbom","scorecard":{"id":559028,"data":{"date":"2025-08-11","repo":{"name":"github.com/khiav223577/max_exchange_api","commit":"8a6ca89786aaab58609743f6cdd7219f95043499"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":3.8,"checks":[{"name":"Token-Permissions","score":0,"reason":"detected GitHub workflow tokens with excessive permissions","details":["Warn: no topLevel permission defined: .github/workflows/ruby.yml:1","Info: no jobLevel write permissions found"],"documentation":{"short":"Determines if the project's workflows follow the principle of least privilege.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#token-permissions"}},{"name":"Binary-Artifacts","score":10,"reason":"no binaries found in the repo","details":null,"documentation":{"short":"Determines if the project has generated executable (binary) artifacts in the source repository.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#binary-artifacts"}},{"name":"Packaging","score":-1,"reason":"packaging workflow not detected","details":["Warn: no GitHub/GitLab publishing workflow detected."],"documentation":{"short":"Determines if the project is published as a package that others can easily download, install, easily update, and uninstall.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#packaging"}},{"name":"Maintained","score":0,"reason":"0 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project is \"actively maintained\".","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#maintained"}},{"name":"Dangerous-Workflow","score":10,"reason":"no dangerous workflow patterns detected","details":null,"documentation":{"short":"Determines if the project's GitHub Action workflows avoid dangerous patterns.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#dangerous-workflow"}},{"name":"Code-Review","score":0,"reason":"Found 0/22 approved changesets -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project requires human code review before pull requests (aka merge requests) are merged.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#code-review"}},{"name":"Pinned-Dependencies","score":0,"reason":"dependency not pinned by hash detected -- score normalized to 0","details":["Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ruby.yml:34: update your workflow using https://app.stepsecurity.io/secureworkflow/khiav223577/max_exchange_api/ruby.yml/master?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/ruby.yml:36: update your workflow using https://app.stepsecurity.io/secureworkflow/khiav223577/max_exchange_api/ruby.yml/master?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/ruby.yml:44: update your workflow using https://app.stepsecurity.io/secureworkflow/khiav223577/max_exchange_api/ruby.yml/master?enable=pin","Info:   0 out of   1 GitHub-owned GitHubAction dependencies pinned","Info:   0 out of   2 third-party GitHubAction dependencies pinned"],"documentation":{"short":"Determines if the project has declared and pinned the dependencies of its build process.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#pinned-dependencies"}},{"name":"CII-Best-Practices","score":0,"reason":"no effort to earn an OpenSSF best practices badge detected","details":null,"documentation":{"short":"Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#cii-best-practices"}},{"name":"Security-Policy","score":0,"reason":"security policy file not detected","details":["Warn: no security policy file detected","Warn: no security file to analyze","Warn: no security file to analyze","Warn: no security file to analyze"],"documentation":{"short":"Determines if the project has published a security policy.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#security-policy"}},{"name":"Vulnerabilities","score":10,"reason":"0 existing vulnerabilities detected","details":null,"documentation":{"short":"Determines if the project has open, known unfixed vulnerabilities.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#vulnerabilities"}},{"name":"Fuzzing","score":0,"reason":"project is not fuzzed","details":["Warn: no fuzzer integrations found"],"documentation":{"short":"Determines if the project uses fuzzing.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#fuzzing"}},{"name":"Signed-Releases","score":-1,"reason":"no releases found","details":null,"documentation":{"short":"Determines if the project cryptographically signs release artifacts.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#signed-releases"}},{"name":"License","score":10,"reason":"license file detected","details":["Info: project has a license file: LICENSE:0","Info: FSF or OSI recognized license: MIT License: LICENSE:0"],"documentation":{"short":"Determines if the project has defined a license.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#license"}},{"name":"Branch-Protection","score":-1,"reason":"internal error: error during branchesHandler.setup: internal error: githubv4.Query: Resource not accessible by integration","details":null,"documentation":{"short":"Determines if the default and release branches are protected with GitHub's branch protection settings.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#branch-protection"}},{"name":"SAST","score":0,"reason":"SAST tool is not run on all commits -- score normalized to 0","details":["Warn: 0 commits out of 12 are checked with a SAST tool"],"documentation":{"short":"Determines if the project uses static code analysis.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#sast"}}]},"last_synced_at":"2025-08-20T13:07:47.059Z","repository_id":45893752,"created_at":"2025-08-20T13:07:47.059Z","updated_at":"2025-08-20T13:07:47.059Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":280851711,"owners_count":26402239,"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","status":"online","status_checked_at":"2025-10-24T02:00:06.418Z","response_time":73,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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":["api","cryptocurrency","cryptocurrency-api","cryptocurrency-exchanges","maicoin","max","ruby"],"created_at":"2024-10-03T10:42:53.984Z","updated_at":"2025-10-24T19:15:02.975Z","avatar_url":"https://github.com/khiav223577.png","language":"Ruby","funding_links":[],"categories":[],"sub_categories":[],"readme":"# MAX Exchange API Ruby SDK\n\n[![Gem Version](https://img.shields.io/gem/v/max_exchange_api.svg?style=flat)](http://rubygems.org/gems/max_exchange_api)\n[![Build Status](https://github.com/khiav223577/max_exchange_api/workflows/Ruby/badge.svg)](https://github.com/khiav223577/max_exchange_api/actions)\n[![RubyGems](http://img.shields.io/gem/dt/max_exchange_api.svg?style=flat)](http://rubygems.org/gems/max_exchange_api)\n[![Code Climate](https://codeclimate.com/github/khiav223577/max_exchange_api/badges/gpa.svg)](https://codeclimate.com/github/khiav223577/max_exchange_api)\n[![Test Coverage](https://codeclimate.com/github/khiav223577/max_exchange_api/badges/coverage.svg)](https://codeclimate.com/github/khiav223577/max_exchange_api/coverage)\n\nA ruby implementation of MAX exchange API\n\n* REST API V2\n* Websocket API\n\n## Documentations\n\n* [REST API Introduction](https://max.maicoin.com/documents/api_v2)\n* [REST API End Points](https://max.maicoin.com/documents/api_list)\n* [WebSocket API Documentation](https://maicoin.github.io/max-websocket-docs/)\n\n\n## Supports\n- Ruby 2.2 ~ 2.7, 3.0 ~ 3.3\n\n## Installation\n\n```ruby\ngem 'max_exchange_api'\n```\n\nAnd then execute:\n\n    $ bundle\n\nOr install it yourself as:\n\n    $ gem install max_exchange_api\n\n## Configuration\n\n### Set timeout time\n\n```rb\n# Set default timeout time\nMaxExchangeApi.default_config.timeout = 3 # seconds\n\n# Create an api instance with custom timeout time\napi = MaxExchangeApi::PublicApi.new(config: { timeout: 12 })\napi = MaxExchangeApi::PrivateApi.new(access_key, secret_key, config: { timeout: 12 })\n```\n\n### Logging\n\n```rb\nrequire 'logger'\n\n# Print log to standard output\nMaxExchangeApi.default_config.logger = Logger.new(STDOUT)\n\n# Print log to file\nMaxExchangeApi.default_config.logger = Logger.new('log/api.log')\n\n# Create an api instance with custom logger\napi = MaxExchangeApi::PublicApi.new(config: { logger: Logger.new(STDOUT) })\napi = MaxExchangeApi::PrivateApi.new(access_key, secret_key, config: { logger: Logger.new(STDOUT) })\n```\n\n## Usage\n\n### Public Api Examples\n\n```rb\n@api_v2 = MaxExchangeApi::PublicV2Api.new\n@api_v3 = MaxExchangeApi::PublicV3Api.new\n```\n\n#### [GET /api/v2/vip_levels](https://max.maicoin.com/documents/api_list#!/public/getApiV2VipLevels)\n\n\u003e Get all VIP level fees.\n\n\u003cdetails\u003e\n  \u003csummary\u003eShow code\u003c/summary\u003e\n  \n```rb\n@api_v2vip_levels\n```\n\u003c/details\u003e\n\n#### [GET /api/v2/vip_levels/{level}](https://max.maicoin.com/documents/api_list#!/public/getApiV2VipLevelsLevel)\n\n\u003e Get VIP level fee by level.\n\n\u003cdetails\u003e\n  \u003csummary\u003eShow code\u003c/summary\u003e\n  \n```rb\n@api_v2vip_levels(2)\n```\n\u003c/details\u003e\n\n#### [GET /api/v2/currencies](https://max.maicoin.com/documents/api_list#!/public/getApiV2Currencies)\n\n\u003e Get all available currencies.\n\n\u003cdetails\u003e\n  \u003csummary\u003eShow code\u003c/summary\u003e\n  \n```rb\n@api_v2currencies\n```\n\u003c/details\u003e\n\n#### [GET /api/v2/k](https://max.maicoin.com/documents/api_list#!/public/getApiV2K)\n\n\u003e Get OHLC(k line) of a specific market.\n\n\u003cdetails\u003e\n  \u003csummary\u003eShow code\u003c/summary\u003e\n  \n```rb\n# use default parameters\n@api_v2k('btctwd')\n\n# provide all possible parameters\n@api_v2k('btctwd', limit: 30, period: 1, timestamp: 1624705402)\n```\n\u003c/details\u003e\n\n#### [GET /api/v2/depth](https://max.maicoin.com/documents/api_list#!/public/getApiV2Depth)\n\n\u003e Get depth of a specified market.\n\n\u003cdetails\u003e\n  \u003csummary\u003eShow code\u003c/summary\u003e\n  \n```rb\n# use default parameters\n@api_v2depth('maxtwd')\n\n# provide all possible parameters\n@api_v2depth('maxtwd', limit: 10, sort_by_price: true)\n```\n\u003c/details\u003e\n\n#### [GET /api/v2/trades](https://max.maicoin.com/documents/api_list#!/public/getApiV2Trades)\n\n\u003e Get recent trades on market, sorted in reverse creation order.\n\n\u003cdetails\u003e\n  \u003csummary\u003eShow code\u003c/summary\u003e\n  \n```rb\n# use default parameters\n@api_v2trades('btctwd')\n\n# provide all possible parameters\n@api_v2trades(\n  'maxtwd', \n  timestamp: 1624705402,\n  from: 68444,\n  to: 69444,\n  order_by: 'asc',\n  pagination: true,\n  page: 3,\n  limit: 15,\n  offset: 5,\n)\n```\n\u003c/details\u003e\n\n#### [GET /api/v2/markets](https://max.maicoin.com/documents/api_list#!/public/getApiV2Markets)\n\n\u003e Get all available markets.\n\n\u003cdetails\u003e\n  \u003csummary\u003eShow code\u003c/summary\u003e\n  \n```rb\n@api_v2markets\n```\n\u003c/details\u003e\n\n#### [GET /api/v2/summary](https://max.maicoin.com/documents/api_list#!/public/getApiV2Summary)\n\n\u003e Overview of market data for all tickers.\n\n\u003cdetails\u003e\n  \u003csummary\u003eShow code\u003c/summary\u003e\n  \n```rb\n@api_v2summary\n```\n\u003c/details\u003e\n\n#### [GET /api/v2/tickers/{path_market}](https://max.maicoin.com/documents/api_list#!/public/getApiV2TickersPathMarket)\n\n\u003e Get ticker of specific market.\n\n\u003cdetails\u003e\n  \u003csummary\u003eShow code\u003c/summary\u003e\n  \n```rb\n@api_v2tickers('btctwd')\n```\n\u003c/details\u003e\n\n#### [GET /api/v2/tickers](https://max.maicoin.com/documents/api_list#!/public/getApiV2Tickers)\n\n\u003e Get ticker of all markets.\n\n\u003cdetails\u003e\n  \u003csummary\u003eShow code\u003c/summary\u003e\n  \n```rb\n@api_v2tickers\n```\n\u003c/details\u003e\n\n#### [GET /api/v2/timestamp](https://max.maicoin.com/documents/api_list#!/public/getApiV2Timestamp)\n\n\u003e Get server current time, in seconds since Unix epoch.\n\n\u003cdetails\u003e\n  \u003csummary\u003eShow code\u003c/summary\u003e\n  \n```rb\n@api_v2timestamp\n```\n\u003c/details\u003e\n\n#### [GET /api/v3/wallet/m/limits](https://max.maicoin.com/documents/api_list/v3#tag/Public/operation/getApiV3WalletMLimits)\n\n\u003e Get total available loan amount\n\n\u003cdetails\u003e\n  \u003csummary\u003eShow code\u003c/summary\u003e\n  \n```rb\n@api_v3.available_loan_amount\n```\n\u003c/details\u003e\n\n---\n\n### Private Api Examples\n\n```rb\naccess_key = 'YOUR_ACCESS_KEY'\nsecret_key = 'YOUR_SECRET_KEY'\n\n@api_v2 = MaxExchangeApi::PrivateV2Api.new(access_key, secret_key)\n@api_v3 = MaxExchangeApi::PrivateV3Api.new(access_key, secret_key)\n```\n\n### Trade\n#### [GET /api/v2/trades/my/of_order](https://max.maicoin.com/documents/api_list#!/private/getApiV2TradesMyOfOrder)\n\n\u003e get your executed trades related to a order\n\n\u003cdetails\u003e\n  \u003csummary\u003eShow code\u003c/summary\u003e\n\n```rb\n# use max unique order id\n@api_v2my_trades_of_order(123456)\n\n# use user specified order id\n@api_v2my_trades_of_order('MY_ORDER_123456', use_client_id: true)\n```\n\u003c/details\u003e\n\n#### [GET /api/v2/trades/my](https://max.maicoin.com/documents/api_list#!/private/getApiV2TradesMy)\n\n\u003e get your executed trades, sorted in reverse creation order\n\n\u003cdetails\u003e\n  \u003csummary\u003eShow code\u003c/summary\u003e\n\n```rb\n# use default parameters\n@api_v2my_trades('btctwd')\n\n# provide all possible parameters\n@api_v2my_trades(\n  'maxtwd',\n  timestamp: 1624705402,\n  from: 68444,\n  to: 69444,\n  order_by: 'asc',\n  pagination: true,\n  page: 3,\n  limit: 15,\n  offset: 5,\n)\n```\n\u003c/details\u003e\n\n### Withdrawal\n#### [GET /api/v2/withdrawals](https://max.maicoin.com/documents/api_list#!/private/getApiV2Withdrawals)\n\n\u003e get your external withdrawals history\n\n\u003cdetails\u003e\n  \u003csummary\u003eShow code\u003c/summary\u003e\n\n```rb\n# use default parameters\n@api_v2withdrawals('max')\n\n# provide all possible parameters\n@api_v2withdrawals(\n  'max',\n  'confirmed',\n  from: 68444,\n  to: 69444,\n  state: 'confirmed',\n  pagination: true,\n  page: 3,\n  limit: 15,\n  offset: 5,\n)\n```\n\u003c/details\u003e\n\n#### [GET /api/v2/withdrawal](https://max.maicoin.com/documents/api_list#!/private/getApiV2Withdrawal)\n\n\u003e get details of a specific external withdraw\n\n\u003cdetails\u003e\n  \u003csummary\u003eShow code\u003c/summary\u003e\n\n```rb\n@api_v2withdrawal('withdraw_id')\n```\n\u003c/details\u003e\n\n#### [POST /api/v2/withdrawal](https://max.maicoin.com/documents/api_list#!/private/postApiV2Withdrawal)\n\n\u003e submit a withdrawal. IP whitelist for api token is required.\n\n\u003cdetails\u003e\n  \u003csummary\u003eShow code\u003c/summary\u003e\n\n```rb\n@api_v2create_withdrawal!('twd', 'withdraw_address_id', 100000)\n```\n\u003c/details\u003e\n\n### Profile\n#### [GET /api/v2/members/profile](https://max.maicoin.com/documents/api_list#!/private/getApiV2MembersProfile)\n\n\u003e get personal profile information\n\n\u003cdetails\u003e\n  \u003csummary\u003eShow code\u003c/summary\u003e\n\n```rb\n@api_v2member_profile\n```\n\u003c/details\u003e\n\n#### [GET /api/v2/members/me](https://max.maicoin.com/documents/api_list#!/private/getApiV2MembersMe)\n\n\u003e get your profile and accounts information\n\n\u003cdetails\u003e\n  \u003csummary\u003eShow code\u003c/summary\u003e\n\n```rb\n@api_v2me\n```\n\u003c/details\u003e\n\n#### [GET /api/v2/members/vip_level](https://max.maicoin.com/documents/api_list#!/private/getApiV2MembersVipLevel)\n\n\u003e get VIP level info\n\n\u003cdetails\u003e\n  \u003csummary\u003eShow code\u003c/summary\u003e\n\n```rb\n@api_v2vip_level\n```\n\u003c/details\u003e\n\n### Account\n#### [GET /api/v2/members/accounts](https://max.maicoin.com/documents/api_list#!/private/getApiV2MembersAccounts)\n\n\u003e get personal accounts information\n\n\u003cdetails\u003e\n  \u003csummary\u003eShow code\u003c/summary\u003e\n\n```rb\n@api_v2accounts\n```\n\u003c/details\u003e\n\n#### [GET /api/v2/members/accounts/{path_currency}](https://max.maicoin.com/documents/api_list#!/private/getApiV2MembersAccountsPathCurrency)\n\n\u003e get personal accounts information of a currency\n\n\u003cdetails\u003e\n  \u003csummary\u003eShow code\u003c/summary\u003e\n\n```rb\n@api_v2account(currnecy)\n```\n\u003c/details\u003e\n\n### Deposit\n#### [GET /api/v2/deposits](https://max.maicoin.com/documents/api_list#!/private/getApiV2Deposits)\n\n\u003e get your deposits history\n\n\u003cdetails\u003e\n  \u003csummary\u003eShow code\u003c/summary\u003e\n\n```rb\n# use default parameters\n@api_v2deposits('max')\n\n# provide all possible parameters\n@api_v2deposits(\n  'max',\n  'confirmed',\n  from: 68444,\n  to: 69444,\n  state: 'accepted',\n  pagination: true,\n  page: 3,\n  limit: 15,\n  offset: 5,\n)\n```\n\u003c/details\u003e\n\n#### [GET /api/v2/deposit](https://max.maicoin.com/documents/api_list#!/private/getApiV2Deposit)\n\n\u003e get details of a specific deposit\n\n\u003cdetails\u003e\n  \u003csummary\u003eShow code\u003c/summary\u003e\n\n```rb\n@api_v2deposit('transaction_id')\n```\n\u003c/details\u003e\n\n### Address\n#### [GET /api/v2/deposit_addresses](https://max.maicoin.com/documents/api_list#!/private/getApiV2DepositAddresses)\n\n\u003e The addresses could be empty before generated, please call POST /deposit_addresses in that case\n\n\u003cdetails\u003e\n  \u003csummary\u003eShow code\u003c/summary\u003e\n\n```rb\n# use default parameters\n@api_v2deposit_addresses\n\n# provide all possible parameters\n@api_v2deposit_addresses(currency: 'twd', pagination: true, page: 3, limit: 15, offset: 5)\n```\n\u003c/details\u003e\n\n#### [POST /api/v2/deposit_addresses](https://max.maicoin.com/documents/api_list#!/private/postApiV2DepositAddresses)\n\n\u003e Address creation is asynchronous, please call GET /deposit_addresses later to get generated addresses\n\n\u003cdetails\u003e\n  \u003csummary\u003eShow code\u003c/summary\u003e\n\n```rb\n@api_v2create_deposit_addresses!('twd')\n```\n\u003c/details\u003e\n\n#### [GET /api/v2/withdraw_addresses](https://max.maicoin.com/documents/api_list#!/private/getApiV2WithdrawAddresses)\n\n\u003e get withdraw addresses\n\n\u003cdetails\u003e\n  \u003csummary\u003eShow code\u003c/summary\u003e\n\n```rb\n# use default parameters\n@api_v2withdraw_addresses('twd')\n\n# provide all possible parameters\n@api_v2withdraw_addresses('usdt', pagination: true, page: 3, limit: 15, offset: 5)\n```\n\u003c/details\u003e\n\n### Internal Transfer\n#### [GET /api/v2/internal_transfers](https://max.maicoin.com/documents/api_list#!/private/getApiV2InternalTransfers)\n\n\u003e get internal transfers history\n\n\u003cdetails\u003e\n  \u003csummary\u003eShow code\u003c/summary\u003e\n\n```rb\n# use default parameters\n@api_v2internal_transfers\n\n# provide all possible parameters\n@api_v2internal_transfers(\n  currency: 'btc',\n  side: 'in',\n  from: 68444,\n  to: 69444,\n  pagination: true, \n  page: 3, \n  limit: 15, \n  offset: 5,\n)\n```\n\u003c/details\u003e\n\n#### [GET /api/v2/internal_transfer](https://max.maicoin.com/documents/api_list#!/private/getApiV2InternalTransfer)\n\n\u003e get details of a specific internal transfer\n\n\u003cdetails\u003e\n  \u003csummary\u003eShow code\u003c/summary\u003e\n\n```rb\n@api_v2internal_transfer('internal_transfer_id')\n```\n\u003c/details\u003e\n\n### Reward\n#### [GET /api/v2/rewards](https://max.maicoin.com/documents/api_list#!/private/getApiV2Rewards)\n\n\u003e get rewards history\n\n\u003cdetails\u003e\n  \u003csummary\u003eShow code\u003c/summary\u003e\n\n```rb\n# use default parameters\n@api_v2rewards\n\n# provide all possible parameters\n@api_v2rewards(\n  currency: 'btc',\n  from: 68444,\n  to: 69444,\n  pagination: true,\n  page: 3,\n  limit: 15,\n  offset: 5,\n)\n```\n\u003c/details\u003e\n\n#### [GET /api/v2/rewards/{path_reward_type}](https://max.maicoin.com/documents/api_list#!/private/getApiV2RewardsPathRewardType)\n\n\u003e get specific rewards history\n\n\u003cdetails\u003e\n  \u003csummary\u003eShow code\u003c/summary\u003e\n\n```rb\n# use default parameters\n@api_v2rewards(reward_type: 'airdrop_rewards')\n\n# provide all possible parameters\n@api_v2rewards(\n  reward_type: 'airdrop_rewards',\n  currency: 'btc',\n  from: 68444,\n  to: 69444,\n  pagination: true,\n  page: 3,\n  limit: 15,\n  offset: 5,\n)\n```\n\u003c/details\u003e\n\n#### [GET /api/v2/max_rewards/yesterday](https://max.maicoin.com/documents/api_list#!/private/getApiV2MaxRewardsYesterday)\n\n\u003e get max rewards yesterday\n\n\u003cdetails\u003e\n  \u003csummary\u003eShow code\u003c/summary\u003e\n\n```rb\n@api_v2max_rewards_yesterday\n```\n\u003c/details\u003e\n\n#### [GET /api/v2/yields](https://max.maicoin.com/documents/api_list#!/private/getApiV2Yields)\n\n\u003e get yields history\n\n\u003cdetails\u003e\n  \u003csummary\u003eShow code\u003c/summary\u003e\n\n```rb\n# use default parameters\n@api_v2yields\n\n# provide all possible parameters\n@api_v2yields(\n  currency: 'usdt',\n  from: 68444,\n  to: 69444,\n  pagination: true,\n  page: 3,\n  limit: 15,\n  offset: 5,\n)\n```\n\u003c/details\u003e\n\n### Order\n#### [GET /api/v2/orders](https://max.maicoin.com/documents/api_list#!/private/getApiV2Orders)\n\n\u003e get your orders, results is paginated.\n\n\u003cdetails\u003e\n  \u003csummary\u003eShow code\u003c/summary\u003e\n\n```rb\n# use default parameters\n@api_v2orders('maxtwd')\n\n# provide all possible parameters\n@api.orders(\n  'maxtwd',\n  state: 'done',\n  order_by: 'desc',\n  group_id: 12345,\n  pagination: true,\n  page: 3,\n  limit: 15,\n  offset: 5,\n)\n```\n\u003c/details\u003e\n\n#### [GET /api/v2/order](https://max.maicoin.com/documents/api_list#!/private/getApiV2Order)\n\n\u003e get a specific order.\n\n\u003cdetails\u003e\n  \u003csummary\u003eShow code\u003c/summary\u003e\n\n```rb\n# use max unique order id\n@api.order(123456)\n\n# use user specified order id\n@api.order('MY_ORDER_123456', use_client_id: true)\n```\n\u003c/details\u003e\n\n#### [POST /api/v2/orders/clear](https://max.maicoin.com/documents/api_list#!/private/postApiV2OrdersClear)\n\n\u003e cancel all your orders with given market and side\n\n\u003cdetails\u003e\n  \u003csummary\u003eShow code\u003c/summary\u003e\n\n```rb\n# use default parameters\n@api.cancel_orders!\n\n# provide all possible parameters\n@api.cancel_orders!(market: 'maxtwd', side: 'sell', group_id: '123456')\n```\n\u003c/details\u003e\n\n#### [POST /api/v2/order/delete](https://max.maicoin.com/documents/api_list#!/private/postApiV2OrderDelete)\n\n\u003e cancel an order\n\n\u003cdetails\u003e\n  \u003csummary\u003eShow code\u003c/summary\u003e\n\n```rb\n# use max unique order id\n@api.cancel_order!(123456)\n\n# use user specified order id\n@api.cancel_order!('MY_ORDER_123456', use_client_id: true)\n```\n\u003c/details\u003e\n\n#### [POST /api/v2/orders](https://max.maicoin.com/documents/api_list#!/private/postApiV2Orders)\n\n\u003e create a sell/buy order\n\n\u003cdetails\u003e\n  \u003csummary\u003eShow code\u003c/summary\u003e\n\n```rb\n# use default parameters\n@api.create_order!('maxtwd', 'buy', 1000, price: 7.5)\n\n# provide all possible parameters\n@api.create_order!(\n  'maxtwd',\n  'buy',\n  1000,\n  price: 7.5,\n  client_oid: 'MY_ORDER_ID_12345',\n  stop_price: 8,\n  ord_type: 'limit',\n  group_id: 12345678,\n)\n```\n\u003c/details\u003e\n\n#### [POST /api/v2/orders/multi/onebyone](https://max.maicoin.com/documents/api_list#!/private/postApiV2OrdersMultiOnebyone)\n\n\u003e Create multiple sell/buy orders, orders may be partially accepted, please put your orders as an array in json body.\n\n\u003cdetails\u003e\n  \u003csummary\u003eShow code\u003c/summary\u003e\n\n```rb\n# use default parameters\n@api.create_orders!('maxtwd', [\n  { side: 'buy', volume: '1000', price: '7.5' },\n  { side: 'buy', volume: '1500', price: '7.2' },\n])\n\n# provide all possible parameters\n@api.create_orders!('maxtwd', [\n  { side: 'buy', volume: '1000', price: '7.5', client_oid: 'MY_ORDER_ID_12345', stop_price: '8', ord_type: 'limit' },\n  { side: 'buy', volume: '1500', price: '7.2', client_oid: 'MY_ORDER_ID_12346', stop_price: '8', ord_type: 'limit' },\n], group_id: 12345)\n```\n\u003c/details\u003e\n\n## Development\n\nAfter checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.\n\nTo install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).\n\n## Contributing\n\nBug reports and pull requests are welcome on GitHub at https://github.com/khiav223577/max_exchange_api. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.\n\n\n## License\n\nThe gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkhiav223577%2Fmax_exchange_api","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fkhiav223577%2Fmax_exchange_api","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkhiav223577%2Fmax_exchange_api/lists"}