API Explorer

PSD2 + Open Data: Access to Accounts, Payments and Open Data related to the Bank.
Login

PSD2 + Open Data APIs 2.0.0 filtered by tag: Data-Warehouse (2 APIs)

API Host: https://uk.openbankproject.com

Bank

Accounts

Counterparties

Transactions

Data Warehouse Search

Search the data warehouse and get row level results.

Authentication is Mandatory

CanSearchWarehouse entitlement is required. You can request the Role below.

Elastic (search) is used in the background. See links below for syntax.

Examples of usage:

POST /search/warehouse/THE_INDEX_YOU_WANT_TO_USE

POST /search/warehouse/INDEX1,INDEX2

POST /search/warehouse/ALL

{ Any valid elasticsearch query DSL in the body }

Elasticsearch query DSL

Elastic simple query

Elastic aggregations

Typical Successful Response:

								
									
{
  "jsonString":"{}"
}
Headers:
Required Roles:
  • CanSearchWarehouse - Please login to request this Role
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-20006: User is missing one or more roles:
  • OBP-50000: Unknown Error.
Connector Methods:
Implemented in OBPv3.0.0 by dataWarehouseSearch

Data Warehouse Statistics

Search the data warehouse and get statistical aggregations over a warehouse field

Does a stats aggregation over some numeric field:

https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-metrics-stats-aggregation.html

Authentication is Mandatory

CanSearchWarehouseStats Role is required. You can request this below.

Elastic (search) is used in the background. See links below for syntax.

Examples of usage:

POST /search/warehouse/statistics/INDEX/FIELD

POST /search/warehouse/statistics/ALL/FIELD

{ Any valid elasticsearch query DSL in the body }

Elasticsearch query DSL

Elastic simple query

Elastic aggregations

Typical Successful Response:

								
									
{
  "jsonString":"{}"
}
Headers:
Required Roles:
  • CanSearchWarehouseStatistics - Please login to request this Role
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-20006: User is missing one or more roles:
  • OBP-50000: Unknown Error.
Connector Methods:
Implemented in OBPv3.0.0 by dataWarehouseStatistics