Furo (1.0.0)
Download OpenAPI specification:Download
Earn, stream and automate your DAO salaries and token vesting with Furo.
Get user streams
Get user streams
path Parameters
chainId required | integer Chain ID |
address required | string User address |
Responses
Response samples
- 200
{- "incomingStreams": [
- {
- "id": "1018",
- "__typename": "Stream",
- "status": "ACTIVE",
- "startedAt": "1655276100",
- "expiresAt": "1676447340",
- "modifiedAtTimestamp": "1655275790",
- "totalAmount": "1336999999999998",
- "withdrawnAmount": "0",
- "recipient": {
- "id": "0x23defc2ca207e7fbd84ae43b00048fb5cb4db5b2"
}, - "createdBy": {
- "id": "0xc39c2d6eb8adef85f9caa141ec95e7c0b34d8dec"
}, - "token": {
- "id": "0x6b3595068778dd592e39a122f4f5a5cf09c90fe2",
- "symbol": "SUSHI",
- "name": "SushiToken",
- "decimals": "18"
}
}
], - "outgoingStreams": [
- {
- "id": "1014",
- "__typename": "Stream",
- "status": "ACTIVE",
- "startedAt": "1654534260",
- "expiresAt": "1654620300",
- "modifiedAtTimestamp": "1654533995",
- "totalAmount": "9999999999999",
- "withdrawnAmount": "0",
- "recipient": {
- "id": "0xc39c2d6eb8adef85f9caa141ec95e7c0b34d8dec"
}, - "createdBy": {
- "id": "0x23defc2ca207e7fbd84ae43b00048fb5cb4db5b2"
}, - "token": {
- "id": "0x6b3595068778dd592e39a122f4f5a5cf09c90fe2",
- "symbol": "SUSHI",
- "name": "SushiToken",
- "decimals": "18"
}
}
]
}
Get stream
Stream status can be ACTIVE
or CANCELLED
path Parameters
chainId required | integer Chain ID number |
streamId required | integer Stream ID number, starts at 1000 |
Responses
Response samples
- 200
{- "id": "1021",
- "__typename": "Stream",
- "status": "ACTIVE",
- "startedAt": "1654896300",
- "expiresAt": "1685269219",
- "modifiedAtTimestamp": "1654891693",
- "totalAmount": "190562207738",
- "withdrawnAmount": "0",
- "txHash": "0x8ef330231938de480733823ce27f717ee80149b81d0ea26e66b19578c100e503",
- "recipient": {
- "id": "0xc86498822ef633f6e1e971484c56e3a087ecc333"
}, - "createdBy": {
- "id": "0x19b3eb3af5d93b77a5619b047de0eed7115a19e7"
}, - "token": {
- "id": "0xa0b86991c6218b36c1d19d4a2e9eb0ce3606eb48",
- "symbol": "USDC",
- "name": "USD Coin",
- "decimals": "6"
}
}
Get stream transactions
Get stream transactions
Transactions types:
DEPOSIT
WITHDRAWAL
EXTEND
- A stream can be topped up, increasing the amountDISBURSEMENT
- When a stream is cancelled, two disbursement transactions will be created, returning the remaining shares to the recipient and the creator.
path Parameters
chainId required | integer Chain ID |
streamId required | integer Stream ID number, starts at 1000 |
Responses
Response samples
- 200
[- {
- "id": "1021:tx:1",
- "type": "WITHDRAWAL",
- "amount": "397004598",
- "toBentoBox": false,
- "createdAtBlock": "14985857",
- "createdAtTimestamp": "1655568392",
- "txHash": "0x1f914b83ff4eeed923b89cfda57220742d3a52e592bf8f011275804d0e0599e3",
- "token": {
- "id": "0xa0b86991c6218b36c1d19d4a2e9eb0ce3606eb48",
- "name": "USD Coin",
- "symbol": "USDC",
- "decimals": "6"
}, - "to": {
- "id": "0xc86498822ef633f6e1e971484c56e3a087ecc333"
}
}, - {
- "id": "1021:tx:0",
- "type": "DEPOSIT",
- "amount": "190562207738",
- "toBentoBox": false,
- "createdAtBlock": "14940306",
- "createdAtTimestamp": "1654891693",
- "txHash": "0x8ef330231938de480733823ce27f717ee80149b81d0ea26e66b19578c100e503",
- "token": {
- "id": "0xa0b86991c6218b36c1d19d4a2e9eb0ce3606eb48",
- "name": "USD Coin",
- "symbol": "USDC",
- "decimals": "6"
}, - "to": {
- "id": "0xc86498822ef633f6e1e971484c56e3a087ecc333"
}
}
]
Get user vests
Get user vests
path Parameters
chainId required | integer Chain ID |
address required | string User address |
Responses
Response samples
- 200
{- "incomingVestings": [
- {
- "id": "2",
- "__typename": "Vesting",
- "status": "ACTIVE",
- "steps": "1",
- "startedAt": "1654139700",
- "expiresAt": "1656040320",
- "modifiedAtTimestamp": "1654139575",
- "cliffDuration": "1295820",
- "stepDuration": "604800",
- "stepAmount": "99999999999999",
- "cliffAmount": "1000000000000001",
- "totalAmount": "1100000000000000",
- "withdrawnAmount": "0",
- "fromBentoBox": false,
- "token": {
- "id": "0x6b3595068778dd592e39a122f4f5a5cf09c90fe2",
- "symbol": "SUSHI",
- "name": "SushiToken",
- "decimals": "18"
}, - "recipient": {
- "id": "0x7a5f66eb194f629db12f25bd0695819cb690fcc7"
}, - "createdBy": {
- "id": "0x7a5f66eb194f629db12f25bd0695819cb690fcc7"
}
}, - {
- "id": "3",
- "__typename": "Vesting",
- "status": "CANCELLED",
- "steps": "9",
- "startedAt": "1654152000",
- "expiresAt": "1659595260",
- "modifiedAtTimestamp": "1654782844",
- "cliffDuration": "60",
- "stepDuration": "604800",
- "stepAmount": "999999999999999",
- "cliffAmount": "100000000000009",
- "totalAmount": "9100000000000000",
- "withdrawnAmount": "1100000000000008",
- "fromBentoBox": false,
- "token": {
- "id": "0x6b3595068778dd592e39a122f4f5a5cf09c90fe2",
- "symbol": "SUSHI",
- "name": "SushiToken",
- "decimals": "18"
}, - "recipient": {
- "id": "0x7a5f66eb194f629db12f25bd0695819cb690fcc7"
}, - "createdBy": {
- "id": "0x7a5f66eb194f629db12f25bd0695819cb690fcc7"
}
}
], - "outgoingVestings": [
- {
- "id": "2",
- "__typename": "Vesting",
- "status": "ACTIVE",
- "steps": "1",
- "startedAt": "1654139700",
- "expiresAt": "1656040320",
- "modifiedAtTimestamp": "1654139575",
- "cliffDuration": "1295820",
- "stepDuration": "604800",
- "stepAmount": "99999999999999",
- "cliffAmount": "1000000000000001",
- "totalAmount": "1100000000000000",
- "withdrawnAmount": "0",
- "fromBentoBox": false,
- "token": {
- "id": "0x6b3595068778dd592e39a122f4f5a5cf09c90fe2",
- "symbol": "SUSHI",
- "name": "SushiToken",
- "decimals": "18"
}, - "recipient": {
- "id": "0x7a5f66eb194f629db12f25bd0695819cb690fcc7"
}, - "createdBy": {
- "id": "0x7a5f66eb194f629db12f25bd0695819cb690fcc7"
}
}
]
}
Get vest
Get vest
Vest status can be ACTIVE
or CANCELLED
path Parameters
chainId required | integer Chain ID number |
vestId required | integer Vest ID number, starts at 1 |
Responses
Response samples
- 200
{- "id": "1",
- "__typename": "Vesting",
- "status": "ACTIVE",
- "steps": "4",
- "startedAt": "1655222400",
- "expiresAt": "1702486800",
- "modifiedAtTimestamp": "1654012508",
- "cliffDuration": "15814800",
- "stepDuration": "7862400",
- "stepAmount": "34530387",
- "cliffAmount": "0",
- "totalAmount": "138121548",
- "withdrawnAmount": "0",
- "fromBentoBox": false,
- "txHash": "0x269479de4d7f84f0fc398ee545d75353cd8c24ffdb364336bb2df9c15a2c1d33",
- "token": {
- "id": "0x6b3595068778dd592e39a122f4f5a5cf09c90fe2",
- "symbol": "SUSHI",
- "name": "SushiToken",
- "decimals": "18"
}, - "recipient": {
- "id": "0xd4bad6e7887110081aa8ee9e16c9341890cae7e5"
}, - "createdBy": {
- "id": "0xc9ecab4ae699ac237a5abc5a7f2c08afc09aa253"
}
}
Get vest transactions
Get vest transactions
Transactions types:
DEPOSIT
WITHDRAWAL
DISBURSEMENT
- When a vest is cancelled, two disbursement transactions will be created, returning the remaining shares to the recipient and the creator.
path Parameters
chainId required | integer Chain ID number |
vestId required | integer Vest ID number, starts at 1 |
Responses
Response samples
- 200
[- {
- "id": "1:tx:0",
- "type": "DEPOSIT",
- "amount": "138121548",
- "toBentoBox": true,
- "createdAtBlock": "14879604",
- "createdAtTimestamp": "1654012508",
- "txHash": "0x269479de4d7f84f0fc398ee545d75353cd8c24ffdb364336bb2df9c15a2c1d33",
- "token": {
- "id": "0x6b3595068778dd592e39a122f4f5a5cf09c90fe2",
- "symbol": "SUSHI",
- "name": "SushiToken",
- "decimals": "18"
}, - "to": {
- "id": "0xd4bad6e7887110081aa8ee9e16c9341890cae7e5"
}
}
]