diff --git a/README.md b/README.md index 51ee40e3..6d6efbd1 100644 --- a/README.md +++ b/README.md @@ -214,6 +214,8 @@ const { profileGraphQL, getProfile, getProfiles, getVerifiedAccounts } = require * _static_ * [.getProfile(address, opts)](#Box.getProfile) ⇒ Object * [.getProfiles(address, opts)](#Box.getProfiles) ⇒ Object + * [.getSpace(address, name, opts)](#Box.getSpace) ⇒ Object + * [.listSpaces(address, opts)](#Box.listSpaces) ⇒ Object * [.profileGraphQL(query, opts)](#Box.profileGraphQL) ⇒ Object * [.getVerifiedAccounts(profile)](#Box.getVerifiedAccounts) ⇒ Object * [.openBox(address, ethereumProvider, opts)](#Box.openBox) ⇒ [Box](#Box) @@ -329,6 +331,35 @@ Get a list of public profiles for given addresses. This relies on 3Box profile A | opts | Object | Optional parameters | | opts.profileServer | String | URL of Profile API server | + + +#### Box.getSpace(address, name, opts) ⇒ Object +Get the public data in a space of a given address with the given name + +**Kind**: static method of [Box](#Box) +**Returns**: Object - a json object with the public space data + +| Param | Type | Description | +| --- | --- | --- | +| address | String | An ethereum address | +| name | String | A space name | +| opts | Object | Optional parameters | +| opts.profileServer | String | URL of Profile API server | + + + +#### Box.listSpaces(address, opts) ⇒ Object +Get the names of all spaces a user has + +**Kind**: static method of [Box](#Box) +**Returns**: Object - an array with all spaces as strings + +| Param | Type | Description | +| --- | --- | --- | +| address | String | An ethereum address | +| opts | Object | Optional parameters | +| opts.profileServer | String | URL of Profile API server | + #### Box.profileGraphQL(query, opts) ⇒ Object