{"id":37083501,"url":"https://github.com/shrimpy-dev/shrimpy-python","last_synced_at":"2026-01-14T10:11:18.230Z","repository":{"id":46133392,"uuid":"194943580","full_name":"shrimpy-dev/shrimpy-python","owner":"shrimpy-dev","description":"Shrimpy’s Developer Trading API is a unified way to integrating trading functionality across every major exchange. Collect historical market data, access real-time websockets, execute advanced trading strategies, and manage an unlimited number of users.","archived":false,"fork":false,"pushed_at":"2023-04-12T17:53:26.000Z","size":36,"stargazers_count":123,"open_issues_count":3,"forks_count":32,"subscribers_count":11,"default_branch":"master","last_synced_at":"2025-10-27T16:01:02.783Z","etag":null,"topics":["binance-trading-bots","crypto-python","crypto-trading","cryptocurrency-market-data","live-crypto-charts","python-trading-bot"],"latest_commit_sha":null,"homepage":"https://developers.shrimpy.io","language":"Python","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/shrimpy-dev.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":"2019-07-02T22:34:49.000Z","updated_at":"2025-05-24T20:18:52.000Z","dependencies_parsed_at":"2024-06-19T23:26:24.516Z","dependency_job_id":"45df1bf7-94b6-4a3d-be84-3b41f00a8c3a","html_url":"https://github.com/shrimpy-dev/shrimpy-python","commit_stats":null,"previous_names":[],"tags_count":5,"template":false,"template_full_name":null,"purl":"pkg:github/shrimpy-dev/shrimpy-python","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/shrimpy-dev%2Fshrimpy-python","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/shrimpy-dev%2Fshrimpy-python/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/shrimpy-dev%2Fshrimpy-python/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/shrimpy-dev%2Fshrimpy-python/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/shrimpy-dev","download_url":"https://codeload.github.com/shrimpy-dev/shrimpy-python/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/shrimpy-dev%2Fshrimpy-python/sbom","scorecard":{"id":821127,"data":{"date":"2025-08-11","repo":{"name":"github.com/shrimpy-dev/shrimpy-python","commit":"fe31a5c721bf77a49db50b4c93451d8df902d7eb"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":3.2,"checks":[{"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":"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":"Pinned-Dependencies","score":-1,"reason":"no dependencies found","details":null,"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":"Dangerous-Workflow","score":-1,"reason":"no workflows found","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":1,"reason":"Found 3/26 approved changesets -- score normalized to 1","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":"Token-Permissions","score":-1,"reason":"No tokens found","details":null,"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":"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":"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":"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":"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":"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":"Branch-Protection","score":0,"reason":"branch protection not enabled on development/release branches","details":["Warn: branch protection not enabled for branch 'master'"],"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 6 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-23T15:37:39.780Z","repository_id":46133392,"created_at":"2025-08-23T15:37:39.780Z","updated_at":"2025-08-23T15:37:39.780Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28416651,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-14T08:38:59.149Z","status":"ssl_error","status_checked_at":"2026-01-14T08:38:43.588Z","response_time":107,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.6:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"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":["binance-trading-bots","crypto-python","crypto-trading","cryptocurrency-market-data","live-crypto-charts","python-trading-bot"],"created_at":"2026-01-14T10:11:17.662Z","updated_at":"2026-01-14T10:11:18.218Z","avatar_url":"https://github.com/shrimpy-dev.png","language":"Python","readme":"# [DEPRECATED] shrimpy-python\n\nThe official python library for the Shrimpy Developer API https://developers.shrimpy.io/docs. The library is currently only python3 compatible.\n\n## Installation\n\n```bash\npip install shrimpy-python\n```\n\n## Quick Start\n\nAll requests are synchronous. For a comprehensive API usage guide, please see https://developers.shrimpy.io/docs.\n\nIf you would like to use the async/await style similar to our Node.js library, consider using the ```asyncio``` python library to wrap the synchronous requests provided here.\n\n```python\nimport shrimpy\n\npublic_key = 'bea8edb348af226...'\nsecret_key = 'df84c39fb49026dcad9d99...'\nclient = shrimpy.ShrimpyApiClient(public_key, secret_key)\nticker = client.get_ticker('bittrex')\n```\n\n## Public Endpoints\n\nThe clients for both the public and authenticated endpoints are identical. Please note that if you attempt to use the authenticated endpoints without keys, it will fail.\n\n* [`get_supported_exchanges`](https://developers.shrimpy.io/docs/#get-supported-exchanges)\n\n```python\nsupported_exchanges = client.get_supported_exchanges()\n```\n\n* [`get_exchange_assets`](https://developers.shrimpy.io/docs/#get-exchange-assets)\n\n```python\nexchange_assets = client.get_exchange_assets('bittrex')\n```\n\n* [`get_trading_pairs`](https://developers.shrimpy.io/docs/#get-trading-pairs)\n\n```python\ntrading_pairs = client.get_trading_pairs('bittrex')\n```\n\n### Market Data Methods\n\n* [`get_ticker`](https://developers.shrimpy.io/docs/#get-ticker)\n\n```python\nticker = client.get_ticker('bittrex')\n```\n\n* [`get_orderbooks`](https://developers.shrimpy.io/docs/#get-order-books)\n\n```python\norderbooks = client.get_orderbooks(\n    'bittrex',  # exchange\n    'XLM',      # base_symbol\n    'BTC',      # quote_symbol\n    10          # limit\n)\n```\n\n* [`get_candles`](https://developers.shrimpy.io/docs/#get-candles)\n\n```python\ncandles = client.get_candles(\n    'bittrex',  # exchange\n    'XLM',      # base_trading_symbol\n    'BTC',      # quote_trading_symbol\n    '15m'       # interval\n)\n```\n\n## Authenticated Endpoints\n\nAs mentioned above, please use the provided Shrimpy API keys to access the authenticated endpoints. Endpoints such as user management require the master api key, while endpoints such as trading will work with either a master api key or a user api key.\n\n### User Management Methods\n\n* [`list_users`](https://developers.shrimpy.io/docs/#list-users)\n\n```python\nusers = client.list_users()\n```\n\n* [`get_user`](https://developers.shrimpy.io/docs/#get-a-user)\n\n```python\nuser = client.get_user(\n    '701e0d16-1e9e-42c9-b6a1-4cada1f395b8' # user_id\n)\n```\n\n* [`create_user`](https://developers.shrimpy.io/docs/#creating-a-user)\n\n```python\ncreate_user_response = client.create_user(\n    'mycustomname' # (optional) name\n)\nuser_id = create_user_response['id']\n```\n\n* [`name_user`](https://developers.shrimpy.io/docs/#naming-a-user)\n\n```python\nclient.name_user(\n    '701e0d16-1e9e-42c9-b6a1-4cada1f395b8', # user_id\n    'mycustomname' # name\n)\n```\n\n* [`remove_user`](https://developers.shrimpy.io/docs/#removing-a-user)\n\n```python\nclient.remove_user(\n    '701e0d16-1e9e-42c9-b6a1-4cada1f395b8', # user_id\n)\n```\n\n### User API Keys Methods\n\n* [`get_api_keys`](https://developers.shrimpy.io/docs/#get-api-keys)\n\n```python\npublic_user_keys = client.get_api_keys(\n    '701e0d16-1e9e-42c9-b6a1-4cada1f395b8' # user_id\n)\n```\n\n* [`create_api_keys`](https://developers.shrimpy.io/docs/#create-api-keys)\n\n```python\nuser_api_keys = client.create_api_keys(\n    '701e0d16-1e9e-42c9-b6a1-4cada1f395b8' # user_id\n)\n```\n\n* [`delete_api_keys`](https://developers.shrimpy.io/docs/#delete-api-keys)\n\n```python\nclient.delete_api_keys(\n    '701e0d16-1e9e-42c9-b6a1-4cada1f395b8',                            # user_id\n    '51ac18b7d208f59b3c88acbb1ecefe6ba6be6ea4edc07e7a2450307ddc27ab80' # public_key\n)\n```\n\n* [`get_api_key_permissions`](https://developers.shrimpy.io/docs/#get-api-key-permissions)\n\n```python\npermissions = client.get_api_key_permissions(\n    '701e0d16-1e9e-42c9-b6a1-4cada1f395b8',                            # user_id\n    '51ac18b7d208f59b3c88acbb1ecefe6ba6be6ea4edc07e7a2450307ddc27ab80' # public_key\n)\n```\n\n* [`set_api_key_permissions`](https://developers.shrimpy.io/docs/#set-api-key-permissions)\n\n```python\nclient.set_api_key_permissions(\n    '701e0d16-1e9e-42c9-b6a1-4cada1f395b8',                             # user_id\n    '51ac18b7d208f59b3c88acbb1ecefe6ba6be6ea4edc07e7a2450307ddc27ab80', # public_key\n    True,                                                               # enable account methods\n    False                                                               # enable trading methods\n)\n```\n\n### Account Methods\n\n* [`list_accounts`](https://developers.shrimpy.io/docs/#list-accounts)\n\n```python\naccounts = client.list_accounts(\n    '701e0d16-1e9e-42c9-b6a1-4cada1f395b8' # user_id\n)\n```\n\n* [`get_account`](https://developers.shrimpy.io/docs/#get-an-account)\n\n```python\naccount = client.get_account(\n    '701e0d16-1e9e-42c9-b6a1-4cada1f395b8', # user_id\n    123                                     # exchange_account_id\n)\n```\n\n* [`link_account`](https://developers.shrimpy.io/docs/#link-an-exchange-account)\n\n```python\nlink_account_response = client.link_account(\n    '701e0d16-1e9e-42c9-b6a1-4cada1f395b8',                             # user_id\n    'binance',                                                          # exchange\n    'GOelL5FT6TklPxAzICIQK25aqct52T2lHoKvtcwsFla5sbVXmeePqVJaoXmXI6Qd', # public_key (a.k.a. apiKey)\n    'SelUuFq1sF2zGd97Lmfbb4ghITeziKo9IvM5NltjEdffatRN1N5vfHXIU6dsqRQw',  # private_key (a.k.a. secretKey\n    'mypassphrase'                                                       # (optional)passphrase - required for exchanges with passphrases like CoinbasePro\n)\naccount_id = link_account_response['id']\n```\n\n* [`unlink_account`](https://developers.shrimpy.io/docs/#unlink-an-exchange-account)\n\n```python\nclient.unlink_account(\n    '701e0d16-1e9e-42c9-b6a1-4cada1f395b8', # user_id\n    456                                     # account_id\n)\n```\n\n* [`get_ip_whitelist_addresses`](https://developers.shrimpy.io/docs/#get-ip-whitelist-addresses)\n\n```python\nip_addresses = client.get_ip_whitelist_addresses(\n    '701e0d16-1e9e-42c9-b6a1-4cada1f395b8' # user_id\n)\n```\n\n### Trading Methods\n\n* [`create_trade`](https://developers.shrimpy.io/docs/#creating-a-trade)\n\n```python\ncreate_trade_response = client.create_trade(\n    '701e0d16-1e9e-42c9-b6a1-4cada1f395b8', # user_id\n    123,                                    # account_id\n    'BTC',                                  # from_symbol\n    'ETH',                                  # to_symbol\n    '0.01'                                  # amount of from_symbol\n)\ntrade_id = create_trade_response['id']\n```\n\n* [`get_trade_status`](https://developers.shrimpy.io/docs/#get-trade-status)\n\n```python\ntrade = client.get_trade_status(\n    '701e0d16-1e9e-42c9-b6a1-4cada1f395b8', # user_id\n    123,                                    # exchange_account_id\n    '72dff099-54c0-4a32-b046-5c19d4f55758'  # trade_id\n)\n```\n\n* [`list_active_trades`](https://developers.shrimpy.io/docs/#list-active-trades)\n\n```python\nactive_trades = client.list_active_trades(\n    '701e0d16-1e9e-42c9-b6a1-4cada1f395b8', # user_id\n    123,                                    # exchange_account_id\n)\n```\n\n### Balance Methods\n\n* [`get_balance`](https://developers.shrimpy.io/docs/#get-balance)\n\n```python\nbalance = client.get_balance(\n    '701e0d16-1e9e-42c9-b6a1-4cada1f395b8', # user_id\n    123                                     # account_id\n)\n```\n\n* [`get_total_balance_history`](https://developers.shrimpy.io/docs/#get-total-balance-history)\n\n```python\ntotal_balance_history = client.get_total_balance_history(\n    '701e0d16-1e9e-42c9-b6a1-4cada1f395b8', # user_id\n    123                                     # account_id\n)\n```\n\n### Asset Management Methods\n\n* [`rebalance`](https://developers.shrimpy.io/docs/#rebalancing)\n\n```python\nclient.rebalance(\n    '701e0d16-1e9e-42c9-b6a1-4cada1f395b8', # user_id\n    123                                     # account_id\n)\n```\n\n* [`get_rebalance_period`](https://developers.shrimpy.io/docs/#get-the-rebalance-period)\n\n```python\nrebalance_period_hours = client.get_rebalance_period(\n    '701e0d16-1e9e-42c9-b6a1-4cada1f395b8', # user_id\n    123                                     # account_id\n)\n```\n\n* [`set_rebalance_period`](https://developers.shrimpy.io/docs/#set-the-rebalance-period)\n\n```python\nclient.set_rebalance_period(\n    '701e0d16-1e9e-42c9-b6a1-4cada1f395b8', # user_id\n    123,                                    # account_id\n    24                                      # rebalance_period in hours\n)\n```\n\n* [`get_strategy`](https://developers.shrimpy.io/docs/#get-the-strategy)\n\n```python\nstrategy = client.get_strategy(\n    '701e0d16-1e9e-42c9-b6a1-4cada1f395b8', # user_id\n    123                                     # account_id\n)\n```\n\n* [`set_strategy`](https://developers.shrimpy.io/docs/#set-the-strategy)\n\n```python\nclient.set_strategy(\n    '701e0d16-1e9e-42c9-b6a1-4cada1f395b8',   # user_id\n    123,                                      # account_id\n    {\n        'isDynamic': False,\n        'allocations': [\n            { 'symbol': 'BTC', 'percent': '50' },\n            { 'symbol': 'ETH', 'percent': '50' }\n        ]\n    }                                         # strategy\n)\n```\n\n* [`clear_strategy`](https://developers.shrimpy.io/docs/#clear-the-strategy)\n\n```python\nclient.clear_strategy(\n    '701e0d16-1e9e-42c9-b6a1-4cada1f395b8',   # user_id\n    123                                       # account_id\n)\n```\n\n* [`allocate`](https://developers.shrimpy.io/docs/#allocating)\n\n```python\nclient.allocate(\n    '701e0d16-1e9e-42c9-b6a1-4cada1f395b8',    # user_id\n    123,                                       # account_id\n    {\n        'isDynamic': False,\n        'allocations': [\n            { 'symbol': 'USDT', 'percent': '100' }\n        ]\n    }                                          # strategy\n)\n```\n\n### Limit Order Methods\n\n* [`place_limit_order`](https://developers.shrimpy.io/docs/#place-a-limit-order)\n\n```python\nplace_limit_order_response = client.place_limit_order(\n    '701e0d16-1e9e-42c9-b6a1-4cada1f395b8', # user_id\n    123,                                    # account_id\n    'BTC',                                  # base_symbol\n    'ETH',                                  # quote_symbol\n    '0.01',                                 # quantity of base_symbol\n    '0.026',                                # price\n    'SELL',                                 # side\n    'IOC',                                  # time_in_force\n)\nlimit_order_id = place_limit_order_response['id']\n```\n\n* [`get_limit_order_status`](https://developers.shrimpy.io/docs/#get-limit-order-status)\n\n```python\norder = client.get_limit_order_status(\n    '701e0d16-1e9e-42c9-b6a1-4cada1f395b8', # user_id\n    123,                                    # account_id\n    '8c2a9401-eb5b-48eb-9ae2-e9e02c174058'  # order_id\n)\n```\n\n* [`list_open_orders`](https://developers.shrimpy.io/docs/#list-open-orders)\n\n```python\norders = client.list_open_orders(\n    '701e0d16-1e9e-42c9-b6a1-4cada1f395b8', # user_id\n    123                                     # account_id\n)\n```\n\n* [`cancel_limit_order`](https://developers.shrimpy.io/docs/#cancel-a-limit-order)\n\n```python\norder = client.cancel_limit_order(\n    '701e0d16-1e9e-42c9-b6a1-4cada1f395b8', # user_id\n    123,                                    # account_id\n    '8c2a9401-eb5b-48eb-9ae2-e9e02c174058'  # order_id\n)\n```\n\n### Analytics Methods\n\n* [`get_backtest_assets`](https://developers.shrimpy.io/docs/#get-backtest-assets)\n\n```python\nbacktest_assets = client.get_backtest_assets(\n    'kucoin' # exchange\n)\n```\n\n* [`run_backtest`](https://developers.shrimpy.io/docs/#run-backtest)\n\n```python\nbacktest_results = client.run_backtest(\n    'binance',                                       # exchange\n    10,                                              # rebalance_period in hours\n    '0.1',                                           # fee in percent\n    '2018-05-19T00:00:00.000Z',                      # start_time\n    '2018-11-02T00:00:00.000Z',                      # end_time\n    '5000',                                          # initial_value in USD\n    [\n        { 'symbol': \"BTC\", 'percent': '50' },\n        { 'symbol': \"ETH\", 'percent': '50' }\n    ]                                                # allocations\n)\n```\n\n* [`get_predictions`](https://developers.shrimpy.io/docs/#get-predictions)\n\n```python\npredictions = client.get_predictions(\n    'Bittrex',                                       # exchange\n    'LTC',                                           # base_symbol\n    'BTC'                                            # quote_symbol\n)\n```\n\n* [`get_trend`](https://developers.shrimpy.io/docs/#trend)\n\n```python\ntrend = client.get_trend(\n    'binance',                                       # exchange\n    'BTC',                                           # base_symbol\n    'BIDR',                                          # quote_symbol\n)\n```\n\n### Insight Methods\n\n* [`get_asset_dominance`](https://developers.shrimpy.io/docs/#get-asset-dominance)\n\n```python\nasset_dominance = client.get_asset_dominance()\n```\n\n* [`get_asset_popularity`](https://developers.shrimpy.io/docs/#get-asset-popularity)\n\n```python\nasset_popularity = client.get_asset_popularity()\n```\n\n### Historical Methods\n\n* [`get_historical_count`](https://developers.shrimpy.io/docs/#get-historical-count)\n\n```python\ncount = client.get_historical_count(\n    'trade',\n    'Bittrex',\n    'LTC',\n    'BTC',\n    '2019-05-19T01:00:00.000Z',\n    '2019-05-20T02:00:00.000Z'\n)\n```\n\n* [`get_historical_instruments`](https://developers.shrimpy.io/docs/#get-historical-instruments)\n\n```python\ninstruments = client.get_historical_instruments()\nbittrex_instruments = client.get_historical_instruments('Bittrex')\n```\n\n* [`get_historical_trades`](https://developers.shrimpy.io/docs/#get-historical-trades)\n\n```python\ntrades = client.get_historical_trades(\n    'Bittrex',\n    'LTC',\n    'BTC',\n    '2019-05-19T00:00:00.000Z',\n    '2019-05-20T00:00:00.000Z',\n    100\n)\n```\n\n* [`get_historical_orderbooks`](https://developers.shrimpy.io/docs/#get-historical-orderbooks)\n\n```python\norderbooks = client.get_historical_orderbooks(\n    'Bittrex',\n    'LTC',\n    'BTC',\n    '2019-05-19T00:00:00.000Z',\n    '2019-05-20T00:00:00.000Z',\n    100\n)\n```\n\n* [`get_historical_candles`](https://developers.shrimpy.io/docs/#get-historical-candles)\n\n```python\ncandles = client.get_historical_candles(\n    'Bittrex',\n    'LTC',\n    'BTC',\n    '2019-05-19T00:00:00.000Z',\n    '2019-05-20T00:00:00.000Z',\n    100,\n    '1m'\n)\n```\n\n### Management Methods\n\n* [`get_status`](https://developers.shrimpy.io/docs/#get-status)\n\n```python\nstatus = client.get_status()\n```\n\n* [`get_credits`](https://developers.shrimpy.io/docs/#get-credits)\n\n```python\nusage = client.get_credits()\n```\n\n* [`get_usage`](https://developers.shrimpy.io/docs/#get-usage)\n\n```python\nusage = client.get_usage()\n```\n\n## Websocket\n\nUsers can access the Shrimpy websocket feed using the [`ShrimpyWsClient`](https://github.com/shrimpy-dev/shrimpy-python/blob/master/shrimpy/shrimpy_ws_client.py) class. A handler must be\npassed in on subscription that is responsible for processing incoming messages from the websocket\nstream. It is recommended that you simply send the message to another processing thread from your custom\nhandler to prevent blocking the incoming message stream.\n\nThe client handles pings to the Shrimpy server based on the [`API Documentation`](https://developers.shrimpy.io/docs/#websocket)\n\n```python\nimport shrimpy\n\n\npublic_key = '6d73c2464a71b94a81aa7b13d...'\nprivate_key = 'e6238b0de3cdf19c7861f8e8f5d137ce7113ac1e884b191a14bbb2...'\n\n# This is a sample handler, it simply prints the incoming message to the console\ndef error_handler(err):\n    print(err)\n\n\n# This is a sample handler, it simply prints the incoming message to the console\ndef handler(msg):\n    print(msg)\n\n\napi_client = shrimpy.ShrimpyApiClient(public_key, private_key)\nraw_token = api_client.get_token()\nclient = shrimpy.ShrimpyWsClient(error_handler, raw_token['token'])\n\nsubscribe_data = {\n    \"type\": \"subscribe\",\n    \"exchange\": \"coinbasepro\",\n    \"pair\": \"ltc-btc\",\n    \"channel\": \"orderbook\"\n}\n\n# Start processing the Shrimpy websocket stream!\nclient.connect()\nclient.subscribe(subscribe_data, handler)\n\n# Once complete, stop the client\nclient.disconnect()\n```\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fshrimpy-dev%2Fshrimpy-python","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fshrimpy-dev%2Fshrimpy-python","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fshrimpy-dev%2Fshrimpy-python/lists"}