Git Product home page Git Product logo

albion-api's Introduction

albion-api

Build Status Built with Spacemacs

A Ruby API Library for Albion Online

Disclaimer

I am actively updating this gem all the time, I recommend locking your version for now unless you want the new API calls.

Install

# Gemfile
gem 'albion-api', '~> 0.0'

or, you can of course install it via your shell.

$ gem install albion-api -v '~> 0.0'

Supported API calls

  • UserKillboard
  • UserSearch
  • GuildSearch
  • GuildMembers

Not Supported API calls

A bunch still haha, I haven't scraped all of them quite yet so an exhaustive list isn't here yet.

Terms

API IDs: The Albion API operates off of internally generated API IDs for every objects in their database. This term refers to said ID for a given object.

Usage

The simple way to use the library is as such:

require 'albion-api'

client = AlbionApi::UserSearch.new('USER_NAME')
response = client.find

More in depth details about each call to come.

Contributing

Create a fork, and send me a PR! I am always happy to accept contributions.

Travis will be setup soon to run tests, so make sure you add them!

the tests aren't 100% exhaustive yet, mainly just integration tests, so don't break your back for now ;)

albion-api's People

Contributors

kmontag42 avatar

Stargazers

 avatar

Watchers

 avatar  avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.