3Box APIs allow developers to interact with 3Box data stores in various ways. This page contains an overview of the methods offered by the 3Box SDK.

Static vs. Stateful API Methods

• Static API methods are always available to developers and do not require user authentication. They are limited to reading public information from stores. Static methods are performed on the Box object.

• Stateful API methods are only available to developers while the user is active on their app and require user authentication, achieved with the Auth API. Stateful methods can be performed on the box, space, and thread object.

Identity

Static

• ​Box.getConfig​

• ​Box.idUtils.verifyClaim​

• ​Box.idUtils.isMuportDID​

• ​Box.idUtils.isClaim​

Stateful

• ​box.DID​

• ​box.linkAddress​

• ​box.isAddressLinked​

• ​box.listAddressLinks​

• ​box.removeAddressLink​

Auth

Static

• ​Box.openBox​

• ​Box.isLoggedIn​

Stateful

• ​box.openSpace​

• ​box.onSyncDone​

• ​box.logout​

Profiles

GET

Static

• ​Box.getProfile​

• ​Box.getProfiles​

• ​Box.profileGraphQL​

• ​Box.getVerifiedAccounts​

Stateful

• ​box.public.all​

• ​box.private.all​

• ​box.public.get​

• ​box.private.get​

• ​box.public.getMetadata​

• ​box.private.getMetadata​

• ​box.public.log​

• ​box.private.log​

SET

Stateful

• ​box.public.set​

• ​box.private.set​

• ​box.public.setMultiple​

• ​box.private.setMultiple​

REMOVE

Stateful

• ​box.public.remove​

• ​box.private.remove​

Storage (Spaces)

GET

Static

• ​Box.getSpace​

• ​Box.listSpaces​

Stateful

• ​space.all​

• ​space.public.get​

• ​space.private.get​

• ​space.public.getMetadata​

• ​space.private.getMetadata​

• ​space.public.log​

• ​space.private.log​

SET

Stateful

• ​space.public.set​

• ​space.private.set​

• ​space.public.setMultiple​

• ​space.private.setMultiple​

REMOVE

Stateful

• ​space.public.remove​

• ​space.private.remove​

Messaging (Threads)

VIEW

Static

• ​Box.getThread​

• ​Box.getThreadByAddress​

CREATE

Stateful

• ​space.joinThread​

• ​space.joinThreadByAddress​

• ​space.subscribeThread​

• ​space.unsubscribeThread​

• ​space.subscribedThreads​

READ

Stateful

• ​thread.getPosts​

• ​thread.onUpdate​

ADD/REMOVE

Stateful

• ​thread.post​

• ​thread.deletePost​

CAPABILITIES

Stateful

• ​thread.addModerator​

• ​thread.listModerators​

• ​thread.addMember​

• ​thread.listMembers​

• ​thread.onNewCapabilities​