Furo (2.0.0)

Download OpenAPI specification:Download

Earn, stream and automate your DAO salaries and token vesting with Furo.

Get user streams

path Parameters

chainId required	integer Chain ID
address required	string User address

Responses

Response samples

200

Content type

application/json

{"incomingStreams": [{"id": "1018",
"__typename": "Stream",
"status": "ACTIVE",
"startedAt": "1655276100",
"expiresAt": "1676447340",
"modifiedAtTimestamp": "1655275790",
"extendedAtTimestamp": "0",
"initialShares": "190562207738",
"initialAmount": "191999999999",
"extendedShares": "0",
"remainingShares": "164797739465",
"withdrawnAmount": "25981721647",
"recipient": {"id": 2.047874098967631e+47
},
"createdBy": {"id": 1.1167360742910279e+48
},
"token": {"id": 6.120569339260443e+47,
"symbol": "SUSHI",
"name": "SushiToken",
"decimals": "18"
}
}
],
"outgoingStreams": [{"id": "1014",
"__typename": "Stream",
"status": "ACTIVE",
"startedAt": "1654534260",
"expiresAt": "1654620300",
"modifiedAtTimestamp": "1654533995",
"extendedAtTimestamp": "0",
"initialShares": "90000000000",
"initialAmount": "91999999999",
"extendedShares": "0",
"remainingShares": "70000000000",
"withdrawnAmount": "22000000000",
"recipient": {"id": 1.1167360742910279e+48
},
"createdBy": {"id": 2.047874098967631e+47
},
"token": {"id": 6.120569339260443e+47,
"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

Content type

application/json

{"id": "1021",
"__typename": "Stream",
"status": "ACTIVE",
"startedAt": "1654896300",
"expiresAt": "1685269219",
"extendedAtTimestamp": "0",
"initialShares": "190562207738",
"initialAmount": "191999999999",
"extendedShares": "0",
"remainingShares": "164797739465",
"withdrawnAmount": "25981721647",
"txHash": 6.465810056564396e+76,
"recipient": {"id": 1.144041514051213e+48
},
"createdBy": {"id": 1.46737094111493e+47
},
"token": {"id": 9.175510568426712e+47,
"symbol": "USDC",
"name": "USD Coin",
"decimals": "6"
}
}

Get stream transactions

Transactions types:

DEPOSIT
WITHDRAWAL
EXTEND - A stream can be topped up, increasing the amount
DISBURSEMENT - 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

Content type

application/json

[{"id": "1021:tx:1",
"type": "WITHDRAWAL",
"amount": "397004598",
"toBentoBox": false,
"createdAtBlock": "14985857",
"createdAtTimestamp": "1655568392",
"txHash": 1.4278412320090252e+76,
"token": {"id": 9.175510568426712e+47,
"name": "USD Coin",
"symbol": "USDC",
"decimals": "6"
},
"to": {"id": 1.144041514051213e+48
}
},
{"id": "1021:tx:0",
"type": "DEPOSIT",
"amount": "190562207738",
"toBentoBox": false,
"createdAtBlock": "14940306",
"createdAtTimestamp": "1654891693",
"txHash": 6.465810056564396e+76,
"token": {"id": 9.175510568426712e+47,
"name": "USD Coin",
"symbol": "USDC",
"decimals": "6"
},
"to": {"id": 1.144041514051213e+48
}
}
]

Get user vests

path Parameters

chainId required	integer Chain ID
address required	string User address

Responses

Response samples

200

Content type

application/json

{"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": 6.120569339260443e+47,
"symbol": "SUSHI",
"name": "SushiToken",
"decimals": "18"
},
"recipient": {"id": 6.98624410287533e+47
},
"createdBy": {"id": 6.98624410287533e+47
}
},
{"id": "3",
"__typename": "Vesting",
"status": "CANCELLED",
"steps": "9",
"startedAt": "1654152000",
"expiresAt": "1659595260",
"modifiedAtTimestamp": "1654782844",
"cliffDuration": "60",
"stepDuration": "604800",
"stepShares": "1969395743041858967011",
"cliffShares": "23632786728961078424936",
"initialShares": "94531033478468001237332",
"initialAmount": "99999880000000000000000",
"remainingShares": "94531033478468001237332",
"withdrawnAmount": "0",
"fromBentoBox": false,
"token": {"id": 6.120569339260443e+47,
"symbol": "SUSHI",
"name": "SushiToken",
"decimals": "18"
},
"recipient": {"id": 6.98624410287533e+47
},
"createdBy": {"id": 6.98624410287533e+47
}
}
],
"outgoingVestings": [{"id": "2",
"__typename": "Vesting",
"status": "ACTIVE",
"steps": "1",
"startedAt": "1654139700",
"expiresAt": "1656040320",
"modifiedAtTimestamp": "1654139575",
"cliffDuration": "1295820",
"stepDuration": "604800",
"stepShares": "99999999999999",
"cliffShares": "1000000000000001",
"initialShares": "1000000000000000",
"initialAmount": "1100000000000000",
"remainingShares": "1000000000000000",
"withdrawnAmount": "0",
"fromBentoBox": false,
"token": {"id": 6.120569339260443e+47,
"symbol": "SUSHI",
"name": "SushiToken",
"decimals": "18"
},
"recipient": {"id": 6.98624410287533e+47
},
"createdBy": {"id": 6.98624410287533e+47
}
}
]
}

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

Content type

application/json

{"id": "1",
"__typename": "Vesting",
"status": "ACTIVE",
"steps": "4",
"startedAt": "1655222400",
"expiresAt": "1702486800",
"modifiedAtTimestamp": "1654012508",
"cliffDuration": "15814800",
"stepDuration": "7862400",
"stepShares": "34530387",
"cliffShares": "0",
"initialShares": "120000000",
"initialAmount": "138121548",
"withdrawnAmount": "0",
"fromBentoBox": false,
"txHash": 1.745022271632895e+76,
"token": {"id": 6.120569339260443e+47,
"symbol": "SUSHI",
"name": "SushiToken",
"decimals": "18"
},
"recipient": {"id": 1.2144727028373589e+48
},
"createdBy": {"id": 1.1527850424907549e+48
}
}

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

Content type

application/json

[{"id": "1:tx:0",
"type": "DEPOSIT",
"amount": "138121548",
"toBentoBox": true,
"createdAtBlock": "14879604",
"createdAtTimestamp": "1654012508",
"txHash": 1.745022271632895e+76,
"token": {"id": 6.120569339260443e+47,
"symbol": "SUSHI",
"name": "SushiToken",
"decimals": "18"
},
"to": {"id": 1.2144727028373589e+48
}
}
]