https://github.com/impak-finance/flinks-python

A Python module for communicating with the Flinks.io API.
https://github.com/impak-finance/flinks-python

api bank-account client financial-data flinks pfm python transaction

Last synced: 2 days ago
JSON representation

A Python module for communicating with the Flinks.io API.

• Host: GitHub
• URL: https://github.com/impak-finance/flinks-python
• Owner: impak-finance
• License: mit
• Created: 2018-11-07T22:14:02.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2022-12-08T06:35:13.000Z (about 2 years ago)
• Last Synced: 2025-01-14T14:50:00.874Z (about 1 month ago)
• Topics: api, bank-account, client, financial-data, flinks, pfm, python, transaction
• Language: Python
• Size: 73.2 KB
• Stars: 7
• Watchers: 3
• Forks: 6
• Open Issues: 6
• Metadata Files:
  • Readme: README.rst
  • License: LICENSE

Awesome Lists containing this project

README

        
flinks-python

=============

.. image:: https://img.shields.io/pypi/l/flinks.svg

    :target: https://pypi.python.org/pypi/flinks/

    :alt: License

.. image:: https://img.shields.io/pypi/pyversions/flinks.svg

    :target: https://pypi.python.org/pypi/flinks

.. image:: https://img.shields.io/pypi/v/flinks.svg

    :target: https://pypi.python.org/pypi/flinks/

    :alt: Latest Version

.. image:: https://travis-ci.org/impak-finance/flinks-python.svg?branch=master

    :target: https://travis-ci.org/impak-finance/flinks-python

.. image:: https://codecov.io/gh/impak-finance/flinks-python/branch/master/graph/badge.svg

  :target: https://codecov.io/gh/impak-finance/flinks-python

|

**Flinks-python** is a Python module for communicating with the

`Flinks.io API `_.

.. contents:: Table of Contents

    :local:

Main requirements

-----------------

Python_ 3.4+, Requests_ 2.0+.

Installation

------------

To install Flinks, please use pip_ (or pipenv_) as follows:

.. code-block:: shell

    $ pip install --pre flinks

Basic usage

-----------

The first step to interact with the Flinks v3 API interface is to initialize a ``flinks.Client``

instance. You'll need a Flinks customer ID (and optionally a private API instance URL) to perform

this initialization:

.. code-block:: python

    >>> from flinks import Client

    >>> client = Client('', 'https://sandbox.flinks.io/v3/')

Then you can easily interact with the implemented entities and the underlying API endpoints. Here

are some examples:

.. code-block:: python

    >>> client.banking_services.authorize(login_id='', most_recent_cached=True)

    >>> client.banking_services.get_accounts_summary('')

Authors

-------

impak Finance .

License

-------

MIT. See ``LICENSE`` for more details.

.. _pip: https://github.com/pypa/pip

.. _pipenv: https://github.com/pypa/pipenv

.. _Python: https://www.python.org/

.. _Requests: http://docs.python-requests.org/en/master/