The Fuse Studio REST API for accessing the data and the services of the Fuse network in a simple way. You can use this API to query and interact with the objects of the Fuse network such as: Communities, Tokens, Bridges and Entities.
The token bridge connects the Ethereum and Fuse network
GET /bridges/:homeTokenAddress
Name | Type | Description |
homeTokenAddress |
| Home (Fuse) token address |
Name | Type | Description |
homeTokenAddress |
| Token address on the Fuse network |
foreignTokenAddress |
| Token address on the Ethereum network |
foreignBridgeAddress |
| Bridge address on the Ethereum network |
homeBridgeAddress |
| Bridge address on the Fuse network |
homeBridgeBlockNumber |
| Bridge creation block number on the Fuse network |
foreignBridgeBlockNumber |
| Bridge creation block number on the Ethereum network |
POST /communities/:communityAddress
Name | Type | Description |
communityAddress |
| Community address |
plugins |
| The plugins (with arguments) |
json
- Request-Example:
{"plugins": {"businessList": {"isActive": true,},"joinBonus": {"isActive": false,"hasTransferToFunder": false},}}
Community is a set of contracts and services. Members of the community are users of the Fuse network. The community is configured via the plugins.
GET /communities/:communityAddress
Name | Type | Description |
communityAddress |
| Community address |
Name | Type | Description |
communityAddress |
| Address of the community on the Fuse network |
homeTokenAddress |
| Address of the community token on the Fuse network |
foreignTokenAddress |
| Address of the community token on the Ethereum network |
homeBridgeAddress |
| Address of the community bridge on the Fuse network |
foreignBridgeAddress |
| Address of the community bridge on the Ethereum network |
isClosed |
| Is the community is closed or open. Closed community requires an approve of community admin to join. |
plugins |
| Defines the community plugins. |
Fetching communities I'm part of
GET /entities/account/:account
Name | Type | Description |
account |
| address |
Name | Type | Description |
- |
| List of entities with their communities and tokens |
GET /entities/:communityAddress
Name | Type | Description |
communityAddress |
| Community address of the Fuse network |
page |
| Page number for pagination |
withMetadata |
| Get entities with entity's metadata |
search |
| Entity's name for a search by name |
Name | Type | Description |
- |
| List of entities. See GetEntity endpoint for entity fields |
Entity is an account on the Fuse network. It can have variety of roles like user, admin, business, or custom defined role.
GET /entities/:communityAddress/:account
Name | Type | Description |
communityAddress |
| Community address |
account |
| Entity's account address |
Name | Type | Description |
account |
| Entity's account on Fuse network |
communityAddress |
| Community address of the entity |
uri |
| IPFS URI points to entity's metadata |
name |
| Entity's name |
roles |
| Entity's role encoded as a byte array |
type |
| Entity's type |
isAdmin |
| ​ |
isApproved |
| ​ |
Tokens are compatible with the ERC20 standard, and they also can be burnable/mintable. Tokens are an important part of the community economy.
GET /tokens/:address
Name | Type | Description |
address |
| Token address |
Name | Type | Description |
address |
| Token's address |
name |
| Token's name |
symbol |
| Token's symbol |
tokenURI |
| IPFS URI points to token metadata |
totalSupply |
| Token's total supply |
owner |
| Token's owner |
factoryAddress |
| Factory contract that created the token |
blockNumber |
| Block number of the token's creation |
tokenType |
| Token type: basic/mintableBurnable/imported |
networkType |
| Network type where the token is issued: mainnet/ropsten/fuse |
GET /tokens
Name | Type | Description |
networkType |
| mainnet/ropsten/fuse |
page |
| Page number for pagination |
Name | Type | Description |
- |
| List of Tokens. See GetToken endpoint for token fields |
GET /tokens/owner/:owner
Name | Type | Description |
owner |
| account address of the token owner |
networkType |
| mainnet/ropsten/fuse |
Name | Type | Description |
- |
| List of Tokens. See GetToken endpoint for token fields |