{"id":29395130,"url":"https://github.com/AdesicLabs/Client-js","last_synced_at":"2025-07-10T11:14:55.159Z","repository":{"id":57172212,"uuid":"414363768","full_name":"AdesicLabs/Client-js","owner":"AdesicLabs","description":"JavaScript Client for Abyiss API","archived":false,"fork":false,"pushed_at":"2022-07-26T14:19:34.000Z","size":97,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-07-03T04:05:51.734Z","etag":null,"topics":["abyiss","api","api-client","bitcoin","bot","crypto","cryptocurrency","ethereum","exchange","javascript","js","libary","market-data","rest-api","trading","websocket","websockets","wrapper"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","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/AdesicLabs.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}},"created_at":"2021-10-06T20:42:13.000Z","updated_at":"2021-12-14T16:02:20.000Z","dependencies_parsed_at":"2022-08-24T14:40:56.771Z","dependency_job_id":null,"html_url":"https://github.com/AdesicLabs/Client-js","commit_stats":null,"previous_names":["adesiclabs/client-js"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/AdesicLabs/Client-js","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AdesicLabs%2FClient-js","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AdesicLabs%2FClient-js/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AdesicLabs%2FClient-js/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AdesicLabs%2FClient-js/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/AdesicLabs","download_url":"https://codeload.github.com/AdesicLabs/Client-js/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AdesicLabs%2FClient-js/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":263256604,"owners_count":23438263,"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":["abyiss","api","api-client","bitcoin","bot","crypto","cryptocurrency","ethereum","exchange","javascript","js","libary","market-data","rest-api","trading","websocket","websockets","wrapper"],"created_at":"2025-07-10T11:14:52.378Z","updated_at":"2025-07-10T11:14:55.154Z","avatar_url":"https://github.com/AdesicLabs.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\r\n# Abyiss Python Client - WebSocket \u0026 REST APIs\r\n\r\nPython Client for Abyiss Cryptocurrency APIs.\r\n\r\nTo use our API please sign up for a free account here: [Sign Up](https://www.abyiss.com/signin), and find your API Key in your [Dashboard](https://www.abyiss.com/dashboard).\r\n\r\n## Please use our official [Documentation](https://docs.abyiss.com/). It contains all the latest updates.\r\n\r\n### We will be adding some of the additional features to this client libary and our API in roughly in this order:\r\n* **WebSockets** - This will allow you to subscribe to real time cryptocurrency market data from the API.\r\n* **Unified Endpoints** - This will allow you get a unified view of the entire cryptocurrency market.\r\n* **CSV Export** - This will allow you to export the market data to a CSV file.\r\n* **More Support** - Add support for more currencies, exchanges, markets, symbols, timeframes, functions, indicators and more.\r\n\r\n\r\nIf you have any problems with this library, please open an issue request on [Github](https://github.com/Abyiss/Client-python/issues) or for any additional support please email us at [support@abyiss.com](mailto:support@abyiss.com).\r\n\r\n\r\n# Getting Started\r\n\r\n### Install Abyiss JS Library\r\n\r\n``` npm i abyiss ```\r\n\r\n# add details here\r\n\r\n# More Details\r\n\r\n\r\n### Abyiss Client\r\n\r\n## Reference Data\r\n\r\n\r\n### Get Exchanges\r\n\r\n```python\r\nexchanges = client.getExchanges()\r\n```\r\n\r\n* Returns an array of all supported exchanges in the form of market objects.\r\n\r\n* Parameters:\r\n  - **exchange**: String. Unique exchange identifier used by Abyiss.\r\n\r\n* Response Attributes:\r\n  - **name**: String. The official name of the exchange.\r\n  -  **id**: String. Unique exchange identifier used by Abyiss.\r\n\r\n* Response Object:\r\n    ```json\r\n    [\r\n        {\r\n            \"name\":\"Binance\",\r\n            \"id\":\"binance\"\r\n        },\r\n        {\r\n            \"name\":\"Binance US\",\r\n            \"id\":\"binanceus\"\r\n        },\r\n        {\r\n            \"name\":\"Coinbase Pro\",\r\n            \"id\":\"coinbasepro\"\r\n        },\r\n        {\r\n            \"name\":\"BitBay\",\r\n            \"id\":\"bitbay\"\r\n        }\r\n    ]\r\n    ```\r\n\r\n\r\n### Get Exchange Details\r\n\r\n\r\n\r\n* Returns an object with properties about the exchange.\r\n\r\n* Parameters:\r\n  - **exchange id**: String. Unique exchange identifier used by Abyiss.\r\n\r\n* Response Attributes:\r\n  - **name**: String. the official name of the exchange.\r\n  - **id**: String. the id of the exchange used within the api routes.\r\n  - **url**: String. the exchange's official website url.\r\n  - **hasTrades**: Boolean. Whether the api can be used to query market trades on the exchange.\r\n  - **hasAggregates**: Boolean. Whether the api can be used to query market candle aggregates on the exchange.\r\n  - **aggregateTimeframes**: Object containing all of the timeframes supported for market candle aggregates.\r\n\r\n* Response Object:\r\n    ```json\r\n    {\r\n        \"name\":\"Coinbase Pro\",\r\n        \"id\":\"coinbasepro\",\r\n        \"url\":\"https://pro.coinbase.com/\",\r\n        \"hasTrades\":true,\r\n        \"hasAggregates\":true,\r\n        \"aggregateTimeframes\":\r\n        {\r\n            \"1m\":60,\r\n            \"5m\":300,\r\n            \"15m\":900,\r\n            \"1h\":3600,\r\n            \"6h\":21600,\r\n            \"1d\":86400\r\n        }\r\n    }\r\n    ```\r\n\r\n\r\n### Get Exchange Status\r\n\r\n* Returns an object with properties that describe an exchange's status.\r\n\r\n* Parameters:\r\n  - **exchange id**: String. Unique exchange identifier used by Abyiss.\r\n\r\n* Response Attributes:\r\n  - **status**: String. The status of the exchange. 'ok' is good.\r\n  - **updated**: Int. Unix timestamp of last time the exchage's status was updated.\r\n\r\n* Response Object:\r\n    ```json\r\n    {\r\n        \"status\":\"ok\",\r\n        \"updated\":1634929487916\r\n    }\r\n    ```\r\n\r\n\r\n\r\n### Get Exchange Markets\r\n* Returns an array of all crypto pair ids on the exchange.\r\n\r\n* Parameters:\r\n  - **exchange id**: String. Unique exchange identifier used by Abyiss.\r\n\r\n* Response Attributes:\r\n  - **pair id**: String. Unique Crypto Pair identifier used by the exchange.\r\n\r\n* Response Object:\r\n    ```json\r\n    [\r\n        \"OGN/BTC\",\r\n        \"REQ/BTC\",\r\n        \"KEEP/USD\",\r\n        \"AAVE/USD\",\r\n        \"SKL/GBP\",\r\n        \"MIR/EUR\",\r\n        \"FORTH/EUR\",\r\n        \"DOT/USDT\"\r\n    ]\r\n    ```\r\n\r\n\r\n### Get Exchange Markets Details\r\n\r\n* Returns an object with properties about the crypto pair.\r\n\r\n* Parameters:\r\n  - **exchange id**: String. Unique exchange identifier used by Abyiss.\r\n  - **market id**: String. Unique Crypto Pair identifier used by the exchange.\r\n\r\n* Response Attributes:\r\n  - **exchange**: String. Unique identifier used by Abyiss for the exchange.\r\n  - **symbol**: String. The symbol of the market.\r\n  - **id**: String. Unique identifier used by Abyiss for the market.\r\n  - **active**: Boolean. Whether the market is active on the exchange.\r\n  - **base**: String. The base of the market. eg: The quantity that is bought.\r\n  - **quote**: String. The quote of the market. eg: The currency being compared.\r\n  - **percentage**: Boolean. Whether the taker and maker fee rate is a multiplier or a fixed flat amount.\r\n  - **taker**: Float. Taker fee rate, 0.002 = 0.2%.\r\n  - **maker**: Float. Maker fee rate, 0.0016 = 0.16%.\r\n  - **spot**: String. Exchange type that the market is listed on.\r\n\r\n* Response Object:\r\n    ```json\r\n    {\r\n        \"exchange\":\"coinbasepro\",\r\n        \"symbol\":\"BTC/USD\",\r\n        \"id\":\"BTC-USD\",\r\n        \"active\":true,\r\n        \"base\":\"BTC\",\r\n        \"quote\":\"USD\",\r\n        \"percentage\":true,\r\n        \"taker\":0.005,\r\n        \"maker\":0.005,\r\n        \"type\":\"spot\"\r\n    }\r\n    ```\r\n\r\n## Market Data\r\n\r\n### Aggregates\r\n\r\n\r\n\r\n* Returns an array of recent aggregate candlesticks of a given aggregate size for a market on an exchange.\r\n\r\n* Parameters:\r\n  - **exchange id**: String. Unique exchange identifier used by Abyiss.\r\n  - **market id**: String. Unique Crypto Pair identifier used by the exchange.\r\n  - **aggregate size**: String. Aggregate bar or candlestick time frame. (1m, 5m, 15m, 1h, 6h, 1d)\r\n  - **limit**: String. Optional. Number of results per request. Maximum 500. (default 200)\r\n\r\n* Response Attributes:\r\n  - **exchange**: String. Unique identifier used by Abyiss for the exchange.\r\n  - **market**: String. Unique identifier used by Abyiss for the market.\r\n  - **timestamp**: integer. Unix timestamp of the start of the aggregate calculation. Defining the scope.\r\n  - **open**: float. The first, or opening, price of the aggregate's scope.\r\n  - **high**: float. The highest price recorded within the scope of the aggregate.\r\n  - **low**: float. The lowest price recorded within the scope of the aggregate.\r\n  - **close**: float. The last, or closing, price within the aggregate's scope.\r\n  - **volume**: float. The volume within the aggregate's scope.\r\n\r\n* Response Object:\r\n    ```json\r\n    {\r\n        \"exchange\": \"coinbasepro\",\r\n        \"market\": \"BTC/USD\",\r\n        \"timestamp\": 1639532040000,\r\n        \"open\": 48080,\r\n        \"high\": 48111.79,\r\n        \"low\": 48080,\r\n        \"close\": 48088.72,\r\n        \"volume\": 2.55482409\r\n    }\r\n    ```\r\n\r\n\r\n### Trades\r\n\r\n\r\n* Returns an array of recent trades that have occurred on an exchange for a crypto pair.\r\n\r\n* Parameters:\r\n  - **exchange id**: String. Unique exchange identifier used by Abyiss.\r\n  - **market id**: String. Unique Crypto Pair identifier used by the exchange.\r\n  - **limit**: String. Optional. Number of results per request. Maximum 500. (default 200)\r\n\r\n* Response Attributes:\r\n  - **exchange**: String. Unique identifier used by Abyiss for the exchange.\r\n  - **market**: String. Unique identifier used by Abyiss for the market.\r\n  - **id**: String. The exchange specific unique id of the trade.\r\n  - **timestamp**: string. Unix timestamp of the start of the aggregate calculation. Defining the scope.\r\n  - **price**: float. The quote currency price of the market.\r\n  - **size**: float. The quantity traded.\r\n  - **cost**: float. The quote cost: (size * price).\r\n  - **side**: string. Whether the trade was a buy or sell.\r\n\r\n* Response Object:\r\n    ```json\r\n    {\r\n        \"exchange\": \"coinbasepro\",\r\n        \"market\": \"BTC/USD\",\r\n        \"id\": \"251180247\",\r\n        \"timestamp\": \"1639534096083\",\r\n        \"price\": 47887.03,\r\n        \"size\": 0.00013904,\r\n        \"cost\": 6.6582126511999995,\r\n        \"side\": \"sell\"\r\n    }\r\n    ```\r\n\r\n\r\n### Quotes\r\n\r\n* Returns an array of recent quotes that have occurred on an exchange for a crypto pair.\r\n\r\n* Parameters:\r\n  - **exchange id**: String. Unique exchange identifier used by Abyiss.\r\n  - **market id**: String. Unique Crypto Pair identifier used by the exchange.\r\n\r\n* Response Attributes:\r\n  - **exchange**: String. Unique identifier used by Abyiss for the exchange.\r\n  - **market**: String. Unique identifier used by Abyiss for the market.\r\n  - **bid price**: float. The bid price.\r\n  - **bid size**: float. The bid size.\r\n  - **ask price**: float. The ask price.\r\n  - **ask size**: float. The ask size.\r\n  - **timestamp**: integer. Unix timestamp of the start of the aggregate calculation. Defining the scope.\r\n\r\n\r\n* Response Object:\r\n    ```json\r\n    {\r\n        \"exchange\":\"coinbasepro\",\r\n        \"market\":\"BTC/USD\",\r\n        \"nonce\":14601360013,\r\n        \"bids\":\r\n        [\r\n            [\r\n                61947.91,\r\n                1.48088\r\n            ],\r\n            [\r\n                61947.9,\r\n                0.5\r\n            ],\r\n            [\r\n                61944.07,\r\n                0.44094\r\n            ]\r\n        ],\r\n        \"asks\":\r\n        [\r\n            [\r\n                61947.92,\r\n                2.28573\r\n            ],\r\n            [\r\n                61952.89,\r\n                0.11214\r\n            ],\r\n            [\r\n                61952.9,\r\n                0.50224\r\n            ]\r\n        ]\r\n    }\r\n    ```\r\n\r\n\r\n### Level 2 OrderBook\r\n\r\n* Returns a snapshot of the recent level 2 orderbook for a crypto pair on an exchange.\r\n\r\n* Parameters:\r\n  - **exchange id**: String. Unique exchange identifier used by Abyiss.\r\n  - **market id**: String. Unique Crypto Pair identifier used by the exchange.\r\n\r\n* Response Attributes:\r\n  - **exchange**: String. Unique identifier used by Abyiss for the exchange.\r\n  - **market**: String. Unique identifier used by Abyiss for the market.\r\n  - **bid price**: float. The bid price.\r\n  - **bid size**: float. The bid size.\r\n  - **ask price**: float. The ask price.\r\n  - **ask size**: float. The ask size.\r\n  - **timestamp**: integer. Unix timestamp of the start of the aggregate calculation. Defining the scope.\r\n\r\n\r\n* Response Object:\r\n    ```json\r\n    {\r\n        \"exchange\":\"coinbasepro\",\r\n        \"market\":\"BTC/USD\",\r\n        \"nonce\":14601360013,\r\n        \"bids\":\r\n        [\r\n            [\r\n                61947.91,\r\n                1.48088\r\n            ],\r\n            [\r\n                61947.9,\r\n                0.5\r\n            ],\r\n            [\r\n                61944.07,\r\n                0.44094\r\n            ]\r\n        ],\r\n        \"asks\":\r\n        [\r\n            [\r\n                61947.92,\r\n                2.28573\r\n            ],\r\n            [\r\n                61952.89,\r\n                0.11214\r\n            ],\r\n            [\r\n                61952.9,\r\n                0.50224\r\n            ]\r\n        ]\r\n    }\r\n    ```\r\n\r\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FAdesicLabs%2FClient-js","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FAdesicLabs%2FClient-js","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FAdesicLabs%2FClient-js/lists"}