https://github.com/jaredsmithse/monzo.cr

API Wrapper for Monzo API
https://github.com/jaredsmithse/monzo.cr

crystal monzo

Last synced: 2 months ago
JSON representation

API Wrapper for Monzo API

• Host: GitHub
• URL: https://github.com/jaredsmithse/monzo.cr
• Owner: jaredsmithse
• License: mit
• Created: 2019-10-13T21:31:00.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2021-05-01T22:50:13.000Z (about 4 years ago)
• Last Synced: 2025-02-11T15:53:19.079Z (4 months ago)
• Topics: crystal, monzo
• Language: Crystal
• Size: 47.9 KB
• Stars: 2
• Watchers: 2
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# monzo.cr

[![Build Status](https://travis-ci.org/jaredsmithse/monzo.cr.svg?branch=master)](https://travis-ci.org/jaredsmithse/monzo.cr)

[![GitHub license](https://img.shields.io/github/license/c910335/mass-spec.svg)](https://github.com/c910335/mass-spec/blob/master/LICENSE)

[![GitHub release](https://img.shields.io/github/release/jaredsmithse/monzo.cr.svg)](https://github.com/jaredsmithse/monzo.cr/releases)

The Monzo API is designed to be a predictable and intuitive interface for interacting with users’ accounts.

This is an API wrapper client for Monzo. It is still under construction and all help is welcome!

## Installation

1. Add the dependency to your `shard.yml`:

```yaml

  dependencies:

    monzo.cr:

      github: jaredsmithse/monzo.cr

```

2. Run `shards install`

## Usage

#### Configuration

Instructions for obtaining your own API token can be found on the Monzo documentation website [here](https://docs.monzo.com/#authentication).

```crystal

require "monzo"

Monzo::Client.configure do |settings|

  settings.access_token = monzo_access_token

  settings.base_url = "https://api.monzo.com"

end

client = Monzo::Client

```

#### Getting All Accounts Belonging To You

```crystal

client = Monzo::Client

accounts = client.accounts.list.each do |account|

  puts account.id

end

```

## Development

For development, you will need a personal access token from Monzo. You can find instructions on how to acquire one for your account [here](https://docs.monzo.com/#authentication).

## Contributing

1. Fork it ()

2. Create your feature branch (`git checkout -b my-new-feature`)

3. Commit your changes (`git commit -am 'Add some feature'`)

4. Push to the branch (`git push origin my-new-feature`)

5. Create a new Pull Request

## Contributors

- [@jaredsmithse](https://github.com/jaredsmithse) Jared Smith - creator, maintainer