Skip to content

Latest commit

 

History

History
44 lines (30 loc) · 1.98 KB

File metadata and controls

44 lines (30 loc) · 1.98 KB

List all keys & values

Returns

An object of keys and corresponding content found for the address Aggregate Message.

If no aggregate is found, a 404 error "no aggregate found" will be returned.

{% hint style="info" %} Up to 1,000 results will be returned. {% endhint %}

Usage & Example

import { aggregate } from 'aleph-sdk-ts'

(async() => {
  await aggregate.Get({
    address: account.address,
    keys: [],
    APIServer: "api2.aleph.im"
  })
})();

// Returns all the keys found for this address
{
  test_key: { key_1: 'value_1'},
  test_key_2: { key_name: 'value for key'},
  ... 
}

Required parameters

Description
address - string Address for which the aggregate should be returned
keys - array of strings

If an empty array is passed, all keys and their content found for the address will be returned.

If some are passed, only the key value pairs with those keys will be returned for the address.

APIServer - string API server to query