REST API

⚠️Warning! Our REST API endpoints are not stable. Changes can occur without notification. For production use, we recommend using 3Box.js which is fully supported.

get
Get Profile

https://ipfs.3box.io/profile?address=<address>
Returns a user's public 3Box profile.
Request
Response
Request
Path Parameters
did
optional
string
User's 3Box DID can be used instead of their Ethereum address.
address
required
string
User's Ethereum address
Response
200: OK
Public profile data for the 3Box user.
{
"memberSince": "Alpha",
"proof_twitter": "...",
"coverPhoto": [...],
"emoji": "✨",
"year": "The future",
"major": "User-centric data models",
"school": "The internet",
"job": "Developer Advocate",
"employer": "3Box",
"location": "Web3",
"description": "Just a space narwhal sprinkling some magic on web3",
"name": "Mollie Narwhal",
"proof_github": "...",
"website": "3box.io",
"ethereum_proof": {...},
"image": [{...}],
"proof_did": "eyJ0eXAiOiJKV1QiLCJhbGciOiJFUzI1NksifQ.eyJpYXQiOjE1NDc3NDY2NTQsImlzcyI6ImRpZDptdXBvcnQ6UW1RTnRQU0xoelhTU0xlTUd0YVVyaHhYejRHbTIzTUNmQTJVYWtpbUZYN3VndSJ9.IKvA05baNmwTIfat1cbfMGnTSE7jo_shIOMfScLI_lcK6vzgZluMXnZjEOtZoicVZbo0doKwMnPjAW4Qpmjddw",
"github": "3boxdb"
}
404: Not Found
It was not possible to find a 3Box user for this address.
{
"status": "error",
"message": "Address link not found, address does not have a 3Box or is malformed"
}

get
List Spaces

https://ipfs.3box.io/list-spaces?address=<address>
Returns an array of 3Box spaces for a specific Ethereum address.
Request
Response
Request
Path Parameters
did
optional
string
User's 3Box DID can be used instead of their Ethereum address.
name
required
string
Space name
address
required
string
User's Ethereum address
Response
200: OK
Response to a request for thread data within a space.
{
"thread-/orbitdb/zdpuAw4KEyf5MLsa4WYf8U4RnX4pNWS3niKRMvNxX1jCDncEC/3box.thread.MyFollowing.profileWall": {
"name": "3box.thread.MyFollowing.profileWall",
"address": "/orbitdb/zdpuAw4KEyf5MLsa4WYf8U4RnX4pNWS3niKRMvNxX1jCDncEC/3box.thread.MyFollowing.profileWall",
"members": false,
"firstModerator": "did:3:bafyreig5no236r7yxxhliks5w2unszknq76nwzrtlndp2evdxlufqdwrxq"
}
}

get
Get Config

https://ipfs.3box.io/config?address=<address>
Get the configuration for a user's 3Box.
Request
Response
Request
Path Parameters
did
optional
string
User's 3Box DID can be used instead of their Ethereum address.
address
required
string
User's Ethereum address
Response
200: OK
"links": [
{
"type": "ethereum-eoa",
"message": "Create a new 3Box profile\n\n- \nYour unique profile ID is did:muport:QmQNtPSLhzXSSLeMGtaUrhxXz4Gm23MCfA2UakimFX7ugu \nTimestamp: 1565038634",
"version": 1,
"signature": "...",
"timestamp": 1565038634
}
],
"spaces": {
"3boxtestcomments": {
"DID": "did:3:bafyreidb6k5qfj67gh6jgcut4si5xvyobmnusryhjje5q2ycoooxffcsra"
} }
}
}