Skip to content

OpenFinTech.io API

by openfintech.io

No authHTTPSFinance
Open documentation ↗

Overview

# Introduction [OpenFinTech.io](https://openfintech.io) is an open database that comprises of standardized primary data for FinTech industry.<br> It contains such information as geolocation data (countries, cities, regions), organizations, currencies (national, digital, virtual, crypto), banks, digital exchangers, payment providers (PSP), payment methods, etc.<br> It is created for communication of cross-integrated micro-services on "one language". This is achieved through standardization of entity identifiers that are used to exchange information among different services.<br> ### UML UML Domain Model diagram you can find [here](https://api.openfintech.io/public_domain_model.png).<br> ### Persistence Entities are updated not more than 1 time per day.<br> ### Terms and Conditions This *OpenFinTech.io* is made available under the [Open Database License](http://opendatacommons.org/licenses/odbl/1.0/).<br> Any rights in individual contents of the database are licensed under the [Database Contents License](http://opendatacommons.org/licenses/dbcl/1.0/).<br> ### Contacts For any questions, please email - [email protected]<br> Or you can contact us at <a href="https://gitter.im/paymaxicom/openfintech.io">Gitter</a><br> Powered by [Paymaxi](https://www.paymaxi.com) # Get Started If you use [POSTMAN](https://www.getpostman.com) or similar program which can operate with swagger`s files - just [download](https://docs.openfintech.io) our spec and [import it](https://www.getpostman.com/docs/importing_swagger). Also you can try live [API demo](https://api.openfintech.io). ## Overview The OpenFinTech API is organized around [REST](https://en.wikipedia.org/wiki/Representational_state_transfer). Our API has predictable, resource-oriented URLs, and uses HTTP response codes to indicate API errors.<br> API is based on [JSON API](http://jsonapi.org) standard. JSON is returned by all API responses, including errors, although our API libraries convert responses to appropriate language-specific objects.<br> JSON API requires use of the JSON API media type (`application/vnd.api+json`) for exchanging data.<br> ### Additional Request Headers #### ACCEPT HEADER Your requests should always include the header: ```curl Accept: application/vnd.api+json ``` ## Authentication To use OpenFinTech API no needed authorization. ## Versioning When we make changes to the API, we release new, dated versions. The current version is **2017-08-24**. Read our [API upgrades guide]() to see our API changelog and to learn more about backwards compatibility. ## Pagination OpenFinTech APIs to retrieve lists of banks, currencies and other resources - paginated to **100** items by default. The pagination information will be included in the list API response under the node name `meta` - contains information about listed objects [`total` - contains information about total count of listed objects, `pages` - count of pages], `links` - contain links to navigate between pages [`first` - link to first page, `prev` - link to previous page, `next` - link to next page, `last` - link to last page].<br> By default first page will be listed. For navigating through pages, use the page parameter (e.g. `page[number]`, `page[size]`).<br> The `page[size]` parameter can be used to set the number of records that you want to receive in the response.<br> The `page[number]` parameter can be used to set needed page number.<br> Example of response: ```json { "meta": { "total": 419, "pages": 42 }, "links": { "first": "/v1/{path}?page[number]=1&page[size]=10", "prev": "/v1/{path}?page[number]=39&page[size]=10", "next": "/v1/{path}?page[number]=41&page[size]=10", "last": "/v1/{path}?page[number]=42&page[size]=10" } ``` ### Sorting OpenFinTech\`s API supported query parameter to sort result collection [e.g. `?sort=code`]. Information about available parameters may be found in the endpoint description. Positive parameter [e.g. `?sort=code`] points to ascending sorting, negative [e.g. `?sort=-code`] - to de

OpenFinTech.io is a finance API from openfintech.io. It needs no API key. It is served over HTTPS. Its OpenAPI description documents 18 endpoints.

At a glance

Authentication
No auth
HTTPS
Yes
CORS
Unknown
Category
Finance
Base URL
https://api.openfintech.io/v1/
Version
2017-08-24
Endpoints
18
Spec updated
2018-04-19

Make a first request

Replace the placeholders; the documentation says exactly where credentials go.

cURL
curl -X GET "https://api.openfintech.io/v1/banks" \
  -H "Accept: application/json"
JavaScript
const response = await fetch("https://api.openfintech.io/v1/banks", {
  method: "GET",
  headers: {
    "Accept": "application/json",
  },
});
const data = await response.json();
console.log(data);
Python
import requests

response = requests.request(
    "GET",
    "https://api.openfintech.io/v1/banks",
    headers={
    "Accept": "application/json",
    },
    timeout=30,
)
print(response.json())

Endpoints

MethodPathWhat it does
GET/banksList of banks
GET/banks/{id}Bank by ID
GET/countriesList of countries
GET/countries/{id}Country by ID
GET/currenciesList of currencies
GET/currencies/{id}Currency by ID
GET/deposit-methodsList of deposit methods
GET/deposit-methods/{id}Deposit method by ID
GET/exchangersList of exchangers
GET/exchangers/{id}Exchanger by ID
GET/merchant-industriesList of merchant industries
GET/merchant-industries/{id}Merchant industry by ID
GET/organizationsList of organizations
GET/organizations/{id}Organization by ID
GET/payment-methodsList of payment methods
GET/payment-methods/{id}Payment method by ID
GET/payment-providersList of payment providers
GET/payment-providers/{id}Payment provider by ID

Questions

Does the OpenFinTech.io API need an API key?

No. The OpenFinTech.io API can be called without an API key or sign-up, which makes it handy for prototypes and front-end demos.

Does the OpenFinTech.io API support HTTPS?

Yes, the OpenFinTech.io API is served over HTTPS.

How many endpoints does the OpenFinTech.io API have?

Its OpenAPI description lists 18 endpoints in version 2017-08-24. All of them are shown on this page.

What are alternatives to the OpenFinTech.io API?

Other Finance APIs include Stripe, SEC EDGAR Data, Plaid, Fed Treasury, Razorpay IFSC.

Compare alternatives →

Listed from APIs.guru (CC0).