Giter Club home page Giter Club logo

go-fintual's Introduction

go-fintual

GoDoc

go-fintual is a Go client library for accessing the Fintual API.

Installation

To install the library, simply

go get github.com/ferueda/go-fintual

Usage

import "github.com/ferueda/go-fintual/fintual"

Construct a new Fintual client, then use the various services on the client to access different parts of the Fintual API. For example:

client := fintual.NewClient(nil)
ctx := context.Background()

// list all banks
banks, err := client.Banks.ListAll(ctx, nil)

Some API methods have optional parameters that can be passed in order to filter results. For example:

client := fintual.NewClient(nil)
ctx := context.Background()

// list all banks with the word "nova" in their name
params := &fintual.BankListParams{Query: "nova"}
banks, err := client.Banks.ListAll(ctx, params)

Authentication

For authenticating the client, just call the provided Client.Authenticate method with valid credentials:

client := fintual.NewClient(nil)
ctx := context.Background()

err := client.Authenticate(ctx, "[email protected]", "validPassword")

Coverage

Auth

  • POST /access_token

Asset Providers

  • GET /asset_providers
  • GET /asset_providers/:id
  • GET /asset_providers/:id/conceptual_assets

Banks

  • GET /banks

Conceptual Assets

  • GET /conceptual_assets
  • GET /conceptual_assets/:id
  • GET /conceptual_assets/:id/real_assets

Goals

  • GET /goals
  • GET /goals/:id

Real Assets

  • GET /real_assets/:id
  • GET /real_assets/:id/days
  • GET /real_assets/:id/expense_ratio

How to Contribute

  • Fork a repository
  • Add/Fix something
  • Check that tests are passing
  • Create PR

Current contributors:

License

This library is distributed under the MIT License found in the LICENSE file.

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.