How to check TrueLayer's availability?

Using the Status API, you can check TrueLayer's availability as well as the availability per provider. This is useful if you want to set up alerts programmatically based on a provider's availability.

You can embed and modify the examples to add them to your code or use Postman to make requests. No authentication is needed for the Status API as there's no personal information being returned.

Alternatively, you can directly go the Status webpage for a visual representation.

Data API

Using the sample below you’ll get the availability of the Data API for only the ob-barclays and ob-monzo providers and the accounts endpoint between the 12th Oct 2020, 12:00 and the 13th Oct 2020 13:00.

​

curl "https://status-api.truelayer.com/api/v1/data/status?\from=2020-09-20T12:00:00&to=2020-09-20T13:00:00\&providers=ob-barclays,ob-monzo\&endpoints=accounts"

Which gives you the JSON response below:

{
"status": "ok",
"results": [
{
"timestamp": "2020-10-12T12:00:00.0000000",
"providers": [
{
"provider_id": "ob-barclays",
"endpoints": [
{
"endpoint": "accounts",
"latency_percentiles": {
"50": 3142.5,
"99": 8126.38,
"75": 3521.0,
"90": 4066.0667,
"95": 4554.1
},
"availability": 99.27007299270073,
"provider_error": 0.31282586027111575,
"truelayer_error": 0.4171011470281543
}
],
"availability": 99.27007299270073,
"provider_error": 0.31282586027111575,
"truelayer_error": 0.4171011470281543
},
{
"provider_id": "ob-monzo",
"endpoints": [
{
"endpoint": "accounts",
"latency_percentiles": {
"75": 535.3,
"99": 5924.77,
"90": 673.4,
"95": 774.65,
"50": 461.0
},
"availability": 99.2619926199262,
"provider_error": 0.0,
"truelayer_error": 0.7380073800738007
}
],
"availability": 99.2619926199262,
"provider_error": 0.0,
"truelayer_error": 0.7380073800738007
}
],
"availability": 99.26636568848758,
"provider_error": 0.16930022573363432,
"truelayer_error": 0.5643340857787811
},
{

(...) RESPONSE REDUCED FOR READABILITY
],
"availability": 100.0,
"provider_error": 0.0,
"truelayer_error": 0.0
}
]
}

You can add and remove providers and endpoints freely.

The three last values (availability, provider_error and truelayer_error) are aggregates that represent the general availability of the Data API based on the parameters provided.

​

Payments API

The example below returns the general availability for the Payments API between the 12th Oct 2020, 12:00 and the 13th Oct 2020 13:00.

curl "https://status-api.truelayer.com/api/v1/payments/status?\from=2020-10-12T12:00:00&to=2020-10-13T13:00:00"

{
"status": "ok",
"results": [
{
"timestamp": "2020-10-12T13:00:00.0000000",
"providers": [
{
"provider_id": "oauth-starling",
"endpoints": [
{
"endpoint": "/single-immediate-payments",
"latency_percentiles": {
"50": 95.0,
"99": 155.0,
"90": 148.0,
"95": 150.45,
"75": 129.25
},
"availability": 100.0,
"provider_error": 0.0,
"truelayer_error": 0.0
}
],
"availability": 100.0,
"provider_error": 0.0,
"truelayer_error": 0.0
},

...
],
"availability": 100.0,
"provider_error": 0.0,
"truelayer_error": 0.0
}
]
}

Similarly to the Data API example above, you can add provider_id parameters.

​

The three last values (availability, provider_error and truelayer_error) are aggregates that represent the general availability of the Payments API based on the parameters provided.

Authentication

To check the availability of our authentication services, including token refreshes per provider, check the example below:

curl "https://status-api.truelayer.com/api/v1/auth/status?\from=2020-10-12T12:00:00&to=2020-10-13T13:00:00"

More

Check out our documentation on the Status API