Sign in
ledger.v2

Get account by its address

get/v2/{ledger}/accounts/{address}

Path parameters

ledgerstring required
Example:ledger001

Name of the ledger.

addressstring required
Example:users:001

Exact address of the account. It must match the following regular expressions pattern:

^\w+(:\w+)*$

Query parameters

expandstring
pitstring date-time

Response

OK

Example response

{
  "data": {
    "address": "users:001",
    "metadata": {
      "admin": "true"
    },
    "insertionDate": "2023-01-01T00:00:00Z",
    "updatedAt": "2023-01-01T00:00:00Z",
    "firstUsage": "2023-01-01T00:00:00Z",
    "volumes": {
      "USD": {
        "input": 100,
        "output": 10,
        "balance": 90
      },
      "EUR": {
        "input": 100,
        "output": 10,
        "balance": 90
      }
    },
    "effectiveVolumes": {
      "USD": {
        "input": 100,
        "output": 10,
        "balance": 90
      },
      "EUR": {
        "input": 100,
        "output": 10,
        "balance": 90
      }
    }
  }
}

Changes

Changed in 6 of the 53 revisions of this API.54

  • 2945092328b92See the full diff
    • ●

      added the new SCHEMA_ALREADY_EXISTS enum value to the errorCode response property for the response status default

      response-property-enum-value-added

    • ●

      added the new SCHEMA_NOT_SPECIFIED enum value to the errorCode response property for the response status default

      response-property-enum-value-added

  • 07091e08e7792See the full diff
    • ○

      added the optional property data/insertionDate to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property data/updatedAt to the response with the 200 status

      response-optional-property-added

  • c51f6899d1011See the full diff
    • ○

      added the optional property data/firstUsage to the response with the 200 status

      response-optional-property-added

  • 7ee573f0087f11See the full diff
    • ●

      added the new OUTDATED_SCHEMA enum value to the errorCode response property for the response status default

      response-property-enum-value-added

    • ○

      removed the BUCKET_OUTDATED enum value from the errorCode response property for the response status default

      response-property-enum-value-removed

  • d93e4ae21e381See the full diff
    • ●

      added the new BUCKET_OUTDATED enum value to the errorCode response property for the response status default

      response-property-enum-value-added

  • dcde15f756b51See the full diff
    • ●

      added the new LEDGER_ALREADY_EXISTS enum value to the errorCode response property for the response status default

      response-property-enum-value-added