bittrex

bittrex: An R client for the Bittrex Crypto-Currency Exchange - Published in JOSS (2017)

https://github.com/ropensci-archive/bittrex

Science Score: 46.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • CITATION.cff file
  • codemeta.json file
    Found codemeta.json file
  • .zenodo.json file
    Found .zenodo.json file
  • DOI references
  • Academic publication links
    Links to: zenodo.org
  • Committers with academic emails
    1 of 10 committers (10.0%) from academic institutions
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (16.7%) to scientific vocabulary

Keywords

crypto-currency-exchanges finance peer-reviewed r r-package rstats

Keywords from Contributors

weather-data reproducibility sepa precipitation mopex kgclimateclass hydrology grdc data60uk spatial-data

Scientific Fields

Sociology Social Sciences - 87% confidence
Last synced: 4 months ago · JSON representation

Repository

:warning: ARCHIVED :warning: A R Client for the Bittrex Crypto-Currency Exchange

Basic Info
  • Host: GitHub
  • Owner: ropensci-archive
  • Language: R
  • Default Branch: master
  • Homepage:
  • Size: 588 KB
Statistics
  • Stars: 25
  • Watchers: 9
  • Forks: 8
  • Open Issues: 0
  • Releases: 2
Archived
Topics
crypto-currency-exchanges finance peer-reviewed r r-package rstats
Created over 8 years ago · Last pushed over 3 years ago
Metadata Files
Readme Changelog Codemeta

README-not.md

bittrex: An R client for the Bittrex Crypto-Currency Exchange

Authors: Michael J. Kane
License: LGPL-2

Build Status Coverage Status DOI

Disclaimer

This software is in no way affiliated, endorsed, or approved by the Bittrex crypto-currency exchange or any of its affiliates. It comes with absolutely no warranty and should not be used in actual trading unless the user can read and understand the source and know what you are doing.

Overview

Package 'bittrex' is an R implementation of the REST interface used by the Bittrex crypto-currency exchange. It provides functions for endpoints supported by the exchange. This includes the ability to retrieve price, volume, and order book information as well as the ability to trade crypto-currencies.

Calls to the exchange are categorized as either public, which includes requests for price, volume, and order book information, and private, which includes all requests requiring an account including placing buy or sell orders. Public calls can be used directly by installing the package. Private calls require that you create an account and create an API and secret key with appropriate permissions.

Private calls retrieve the API and secret key using the BITTREXAPIKEY and BITTREXSECRETKEY environment variables. These may be set by the user before opening the R session or, they can be set using the 'bittrex_authenticate' function.

Quickstart

Install

The package is available from GitHub and will be uploaded to CRAN shortly. If you wish to install the development version then install the devtools package, available from CRAN.

```r

install.packages("devtools")

devtools::install_github("ropensci/bittrex") ```

Using the Package

After installation, you may query the exchange with any of the public calls. For example, if we want to see the spread of the cost of doge coins in bitcoins, we can use the following code.

```r library(bittrex) library(scales) library(ggplot2)

The price of doge coins in bitcoins.

dogebtc = btgetmarkethistory(market='btc-doge')$result

ggplot(dogebtc, aes(x=timestamp, y=price, group=ordertype, color=ordertype)) + geomline() + scalexdatetime(breaks=datebreaks("hours"), labels=dateformat("%m-%d %H:%M")) + xlab("Date and Time") + ylab("Price") + scalecolour_discrete(name="Order Type") ```

Contributing

If you would like to contribute to the project please contact the maintainer directly. Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.

ropensci_footer

Owner

  • Name: rOpenSci Archive
  • Login: ropensci-archive
  • Kind: organization
  • Email: info@ropensci.org

Abandoned rOpenSci projects -- email info@ropensci.org if you have questions!

CodeMeta (codemeta.json)

{
  "@context": [
    "https://doi.org/doi:10.5063/schema/codemeta-2.0",
    "http://schema.org"
  ],
  "@type": "SoftwareSourceCode",
  "identifier": "bittrex",
  "description": "A client for the Bittrex crypto-currency exchange \\url{https://bittrex.com/} including the ability to query trade data, manage account balances, and place orders.",
  "name": "bittrex: Client for the Bitrex Exchange",
  "codeRepository": "https://github.com/ropensci/bittrex",
  "issueTracker": "https://github.com/kaneplusplus/bittrex/issues",
  "license": "https://spdx.org/licenses/LGPL-2.0",
  "version": "0.1.7",
  "programmingLanguage": {
    "@type": "ComputerLanguage",
    "name": "R",
    "version": "3.3.2",
    "url": "https://r-project.org"
  },
  "runtimePlatform": "R version 3.3.2 (2016-10-31)",
  "author": [
    {
      "@type": "Person",
      "givenName": "Michael",
      "familyName": "Kane",
      "email": "kaneplusplus@gmail.com",
      "@id": "http://orcid.org/0000-0003-1899-6662"
    }
  ],
  "copyrightHolder": [
    {
      "@type": "Person",
      "givenName": "Michael",
      "familyName": "Kane",
      "email": "kaneplusplus@gmail.com",
      "@id": "http://orcid.org/0000-0003-1899-6662"
    }
  ],
  "maintainer": {
    "@type": "Person",
    "givenName": "Michael",
    "familyName": "Kane",
    "email": "kaneplusplus@gmail.com",
    "@id": "http://orcid.org/0000-0003-1899-6662"
  },
  "softwareSuggestions": [
    {
      "@type": "SoftwareApplication",
      "identifier": "covr",
      "name": "covr",
      "provider": {
        "@id": "https://cran.r-project.org",
        "@type": "Organization",
        "name": "Central R Archive Network (CRAN)",
        "url": "https://cran.r-project.org"
      }
    },
    {
      "@type": "SoftwareApplication",
      "identifier": "testthat",
      "name": "testthat",
      "provider": {
        "@id": "https://cran.r-project.org",
        "@type": "Organization",
        "name": "Central R Archive Network (CRAN)",
        "url": "https://cran.r-project.org"
      }
    },
    {
      "@type": "SoftwareApplication",
      "identifier": "knitr",
      "name": "knitr",
      "provider": {
        "@id": "https://cran.r-project.org",
        "@type": "Organization",
        "name": "Central R Archive Network (CRAN)",
        "url": "https://cran.r-project.org"
      }
    },
    {
      "@type": "SoftwareApplication",
      "identifier": "rmarkdown",
      "name": "rmarkdown",
      "provider": {
        "@id": "https://cran.r-project.org",
        "@type": "Organization",
        "name": "Central R Archive Network (CRAN)",
        "url": "https://cran.r-project.org"
      }
    },
    {
      "@type": "SoftwareApplication",
      "identifier": "threejs",
      "name": "threejs",
      "provider": {
        "@id": "https://cran.r-project.org",
        "@type": "Organization",
        "name": "Central R Archive Network (CRAN)",
        "url": "https://cran.r-project.org"
      }
    },
    {
      "@type": "SoftwareApplication",
      "identifier": "tidyverse",
      "name": "tidyverse",
      "provider": {
        "@id": "https://cran.r-project.org",
        "@type": "Organization",
        "name": "Central R Archive Network (CRAN)",
        "url": "https://cran.r-project.org"
      }
    },
    {
      "@type": "SoftwareApplication",
      "identifier": "igraph",
      "name": "igraph",
      "provider": {
        "@id": "https://cran.r-project.org",
        "@type": "Organization",
        "name": "Central R Archive Network (CRAN)",
        "url": "https://cran.r-project.org"
      }
    },
    {
      "@type": "SoftwareApplication",
      "identifier": "quantmod",
      "name": "quantmod",
      "provider": {
        "@id": "https://cran.r-project.org",
        "@type": "Organization",
        "name": "Central R Archive Network (CRAN)",
        "url": "https://cran.r-project.org"
      }
    }
  ],
  "softwareRequirements": [
    {
      "@type": "SoftwareApplication",
      "identifier": "httr",
      "name": "httr",
      "provider": {
        "@id": "https://cran.r-project.org",
        "@type": "Organization",
        "name": "Central R Archive Network (CRAN)",
        "url": "https://cran.r-project.org"
      }
    },
    {
      "@type": "SoftwareApplication",
      "identifier": "openssl",
      "name": "openssl",
      "provider": {
        "@id": "https://cran.r-project.org",
        "@type": "Organization",
        "name": "Central R Archive Network (CRAN)",
        "url": "https://cran.r-project.org"
      }
    }
  ],
  "applicationCategory": "DataAccess",
  "isPartOf": "\"https://ropensci.org\"",
  "keywords": [
    "cryptocurrency",
    "cryptocurency-exchange",
    "finance"
  ],
  "contIntegration": "https://travis-ci.org/ropensci/bittrex",
  "releaseNotes": "https://github.com/ropensci/bittrex/blob/master/NEWS.md",
  "readme": "https://github.com/ropensci/bittrex/blob/master/README.md",
  "fileSize": "174.209KB"
}

GitHub Events

Total
Last Year

Committers

Last synced: 5 months ago

All Time
  • Total Commits: 90
  • Total Committers: 10
  • Avg Commits per committer: 9.0
  • Development Distribution Score (DDS): 0.122
Past Year
  • Commits: 0
  • Committers: 0
  • Avg Commits per committer: 0.0
  • Development Distribution Score (DDS): 0.0
Top Committers
Name Email Commits
Michael Kane k****s@g****m 79
Maëlle Salmon m****n@y****e 3
Rory Nolan r****n@g****m 1
Noam Ross n****s@g****m 1
Karthik Ram k****m@g****m 1
Jeroen Ooms j****s@g****m 1
Chris Fan c****n@b****u 1
Arfon Smith a****n 1
ropenscibot m****t@g****m 1
Noam Ross r****s@e****g 1
Committer Domains (Top 20 + Academic)

Issues and Pull Requests

Last synced: 4 months ago

All Time
  • Total issues: 9
  • Total pull requests: 7
  • Average time to close issues: 10 months
  • Average time to close pull requests: about 21 hours
  • Total issue authors: 7
  • Total pull request authors: 6
  • Average comments per issue: 3.22
  • Average comments per pull request: 1.29
  • Merged pull requests: 7
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 0
  • Pull requests: 0
  • Average time to close issues: N/A
  • Average time to close pull requests: N/A
  • Issue authors: 0
  • Pull request authors: 0
  • Average comments per issue: 0
  • Average comments per pull request: 0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
Top Authors
Issue Authors
  • rorynolan (2)
  • madsurgeon (2)
  • chrisfan24 (1)
  • maelle (1)
  • kaneplusplus (1)
  • j4rd44 (1)
  • jeroen (1)
Pull Request Authors
  • noamross (2)
  • chrisfan24 (1)
  • maelle (1)
  • rorynolan (1)
  • arfon (1)
  • karthik (1)
Top Labels
Issue Labels
enhancement (1)
Pull Request Labels

Dependencies

DESCRIPTION cran
  • httr * imports
  • openssl * imports
  • igraph * suggests
  • knitr * suggests
  • quantmod * suggests
  • rmarkdown * suggests
  • testthat * suggests
  • threejs * suggests
  • tidyverse * suggests