Fipto - OpenAPI 3.0
1.2.2

This is a REST API specifications based on OpenAPI 3.0 for Fipto solution.

This is the documentation for version 1.2.2 of the API. Last update on Aug 30, 2023.

Base URL 
https://api.fipto.app

Get historical consolidated wallets data

GET /companies/{company_id}/wallets/history/{datetime}/consolidation

Retrieve historical, consolidated per asset, balances and valuations of your wallets.

Path parameters

  • company_id string Required

    The Company ID given by Fipto.

    Format should match the following pattern: [0-9a-fA-F]{8}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F]{12}.

  • datetime string(date-time) Required

    Date

Query parameters

  • valuation_asset string

    Specifies the asset used to value the resources retrieved by the endpoint.

    Values are EUR or USD. Default value is EUR.

  • assets array[string]

    Filters the wallets returned based on the specified assets. All assets will be returned by default.

Responses

  • • 200

    List of historical consolidated wallets.

    Hide response attributes Show response attributes object
    • meta object Required
      Hide meta attributes Show meta attributes
      • request_id string Required

        Unique identifier generated by the server.

        Format should match the following pattern: [0-9a-fA-F]{8}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F]{12}.

      • query_parameters object

        Information about the parameters in the request. All query string parameters provided (or implicit/with default value) will be returned

    • data object
      Hide data attributes Show data attributes
      • type string

        Default value is wallets-consolidation.

      • attributes object
        Hide attributes attributes Show attributes attributes
        • total_value string

          Sum of all value of the wallets.

          Format should match the following pattern: ^-?\d*(\.\d+)?$.

        • valuation_asset string

          Specifies the asset used to value the resources retrieved by the endpoint.

        • assets array[object]
          Hide assets attributes Show assets attributes
          • asset string

            The symbol/ticker of the crypto asset.

            Format should match the following pattern: ([A-Z_]){3,}.

          • balances object
            Hide balances attributes Show balances attributes
            • available string

              Amount expressed in a currency.

              Format should match the following pattern: ^-?\d*(\.\d+)?$.

            • forecasted string

              Amount expressed in a currency.

              Format should match the following pattern: ^-?\d*(\.\d+)?$.

          • value string

            The value based on the selected valuation asset. Data based on the requested date.

            Format should match the following pattern: ^-?\d*(\.\d+)?$.

          • wallets_count integer

            Represents the number of wallets associated with the given asset.
GET /companies/{company_id}/wallets/history/{datetime}/consolidation 
curl \
 -X GET https://api.fipto.app/companies/9de0691c-bc8d-409b-8f40-75d4f45db2f3/wallets/history/2017-07-21T17:32:28Z/consolidation
Response examples (200) 
{
  "meta": {
    "request_id": "string",
    "query_parameters": {}
  },
  "data": {
    "type": "wallets-consolidation",
    "attributes": {
      "total_value": "1000",
      "valuation_asset": "string",
      "assets": [
        {
          "asset": "BTC",
          "balances": {
            "available": "1000",
            "forecasted": "1000"
          },
          "value": "1000",
          "wallets_count": 42
        }
      ]
    }
  }
}