Summary

This documentation is for users of the FTS public API, which provides data in JSON or XML formats. The FTS data model has been redesigned completely, and is now structured around a flow model, where each record is conceptualised as a flow of funds from source to destination.  Resultsets of flows are retrieved by defining a boundary, into which funds flow into the boundary, internally within the boundary, or out of the boundary.  Based on these 3 categories, various groupings of the flows can then be set, giving multiple useful perspectives of the data.  More information about the flow model is presented in this short video.

The API is RESTful, and is accessed with GET requests only.  We recommend that you use https to access our API.

Full details of how to use the FTS API can be found here: https://api.hpc.tools/docs/v1/

API Authentication

In order to access the API, you will need to request a client id and password from the FTS administrators.  The FTS API is secured using HTTP Basic Authentication.  This means that for each request, you will need to set the ‘Authorization’ request header with ‘Basic ’  + base64 encoded version of "clientId:password".  For example, if your client id is “clientABC” and you password is “passwordXYZ”, you would set the header as such using base64 encoding:

GET /v1/public/fts/flow?year=2016 HTTP/1.1

Host: api.hpc.tools

Content-Type: application/json

Authorization: Basic base64(clientABC:passwordXYZ)

Most API client frameworks have native support for creating HTTP Basic Authentication headers.  To request a client ID and password, please email fts@un.org with the following information:

  • Your name and email

  • The name of your organization and country your office is located in

  • The URL of the website or application name which will be using the FTS API