Supported Chains
Currently only available on Ethereum Mainnet.
Available Endpoints:
Click on the endpoint to jump to the section with full details
/getapr GET
- Retrieves the Chorus One staking APR on Ethereum.
/getrewards GET
- Retrieves the daily rewards generated for a specified user.
/getstake GET
-Retrieves the staked amount on Chorus One by a specified address.
/stake POST
- Initiate a transaction to stake on Chorus One protocol.
/claim POST
- Initiate a transaction to claim staked ETH after a withdrawal request.
/mint POST
- Initiate a transaction to mint osETH.
/burn POST
- Initiate a transaction to burn osETH.
Also see Error Handling Details
Endpoint Details
/getapr
Retrieves the Chorus One staking APR on Ethereum.
GET
https://api.expand.network/liquidstaking/getapr
Query Parameters
* indicates that a parameter is required
Remote procedural call URL.
Sample Request Sample Response
Copy https://api.expand.network/liquidstaking/getapr?liquidStakingId=200
Copy {
"status": 200,
"msg": "success",
"data": {
"timeUnix": "1719500639",
"apr": "3.15",
"blockNumber": "20183800"
}
}
back to top
/getrewards
Retrieves the daily rewards generated for a specified user.
GET
https://api.expand.network/liquidstaking/getrewards
Query Parameters
* indicates that a parameter is required
Remote procedural call URL.
Public address of the user.
Starting block of the range.
back to top
Sample Request Sample Response
Copy https://api.expand.network/liquidstaking/getrewards?liquidStakingId=200&startBlock=20153440&endBlock=20183440&address=0xe55A8cFF86aBf88bfD89C81C287f14848bcf8542
Copy {
"status": 200,
"msg": "success",
"data": {
"rewards": [
{
"date": "2024-06-23",
"dailyRewards": "78270423519",
"dailyRewardsUsd": "0.00",
"totalRewards": "3118933237148"
},
{
"date": "2024-06-24",
"dailyRewards": "72961094648",
"dailyRewardsUsd": "0.00",
"totalRewards": "3191894331796"
},
{
"date": "2024-06-25",
"dailyRewards": "78893491914",
"dailyRewardsUsd": "0.00",
"totalRewards": "3270787823710"
},
{
"date": "2024-06-26",
"dailyRewards": "121456664801",
"dailyRewardsUsd": "0.00",
"totalRewards": "3392244488511"
},
{
"date": "2024-06-27",
"dailyRewards": "62772405193",
"dailyRewardsUsd": "0.00",
"totalRewards": "3455016893704"
}
]
}
}
back to top
/getstake
Retrieves the staked amount on Chorus One by a specified address.
GET
https://api.expand.network/liquidstaking/getstake
Query Parameters
* indicates that a parameter is required
Remote procedural call URL.
Public address of the user.
Sample Request Sample Response
Copy https://api.expand.network/liquidstaking/getstake?liquidStakingId=200&address=0x02Fd5aBb1f77841827Bfb7cB19608Ec6488BEd08
Copy {
"status": 200,
"msg": "success",
"data": {
"shares": "3942275859061618"
}
}
back to top
/getwithdrawalrequests
Retrieves all withdrawal requests made by a specified address.
GET
https://api.expand.network/liquidstaking/getwithdrawalrequests
Query Parameters
* indicates that a parameter is required
Remote procedural call URL.
Public address of the user.
back to top
Sample Request Sample Response
Copy https://api.expand.network/liquidstaking/getwithdrawalrequests?liquidStakingId=200&address=0xe55A8cFF86aBf88bfD89C81C287f14848bcf8542
Copy {
"status": 200,
"msg": "success",
"data": {
"requests": [
{
"requestId": "98632406130503281444",
"exitQueueIndex": "27",
"timestamp": "1715854439",
"totalShares": "983105391000569"
}
]
}
}
back to top
/stake
Initiate a transaction to stake on Chorus One protocol.
POST
https://api.expand.network/liquidstaking/stake
Request Body
* indicates that a parameter is required
Remote procedural call URL.
Public address of the owner of this request.
Amount of token to stake.
Maximum gas limit provided by the sender, for the transaction.
if true,
provides insights of the contract and tokens involved in the transaction.
By Default, false
Available on Ethereum, Polygon, BSC, Avalanche, Arbitrum and Optimism Mainnet
Sample Request Sample Response
Copy {
"from": "0xdAe2F6EdDdA6fb4fb60cc02633DE27e2b431B402",
"amount": "1000000",
"liquidStakingId": "200",
"gas": "8000000"
}
Copy {
"status": 200,
"msg": "success",
"data": {
"chainId": "1",
"from": "0xdAe2F6EdDdA6fb4fb60cc02633DE27e2b431B402",
"to": "0xe6d8d8aC54461b1C5eD15740EEe322043F696C08",
"value": "1000000",
"gas": "8000000",
"data": "0xf9609f08000000000000000000000000dae2f6eddda6fb4fb60cc02633de27e2b431b402000000000000000000000000558d7be6092ca91da26521ac25b982d883218e2d",
"referenceId": "e8277c39cec2444990fe0e92d2a25250"
}
}
With Gas Priority
Sample Request Sample Response
Copy {
"from": "0xdAe2F6EdDdA6fb4fb60cc02633DE27e2b431B402",
"amount": "1000000",
"liquidStakingId": "200",
"gas": "8000000",
"gasPriority": "high"
}
Copy {
"status": 200,
"msg": "success",
"data": {
"chainId": "1",
"from": "0xdAe2F6EdDdA6fb4fb60cc02633DE27e2b431B402",
"to": "0xe6d8d8aC54461b1C5eD15740EEe322043F696C08",
"value": "1000000",
"gas": "8000000",
"data": "0xf9609f08000000000000000000000000dae2f6eddda6fb4fb60cc02633de27e2b431b402000000000000000000000000558d7be6092ca91da26521ac25b982d883218e2d",
"gasPrice": "9162032058",
"referenceId": "0a5e4f4e820c41f9b0b0e7ea4a35913d"
}
}
Sample Request Sampe Response
With ofacCheck:
Copy {
"from": "0xdAe2F6EdDdA6fb4fb60cc02633DE27e2b431B402",
"amount": "1000000",
"liquidStakingId": "200",
"gas": "8000000",
"gasPriority": "high",
"ofacCheck": true
}
With ofacCheck:
Copy {
"status": 200,
"msg": "success",
"data": {
"chainId": "1",
"from": "0xfAE7D9854995E28BEB1B1da864ee2A1E2EC17f07",
"to": "0x3d9819210a31b4961b30ef54be2aed79b9c9cd3b",
"value": "0",
"gas": "40000",
"data": "0xede4edd00000000000000000000000005d3a536e4d6dbd6114cc1ead35777bab948e3643",
"gasPrice": "499498318",
"estimationCheck": true,
"insights": {
"asset": {
"issues": [],
"verdict": {
"code": 0,
"label": "NO_ISSUES"
}
},
"to": {
"issues": [],
"verdict": {
"code": 0,
"label": "NO_ISSUES"
}
}
},
"referenceId": "e9bfe6229a844227a92a2f6669aa1da0"
}
}
back to top
/requestwithdrawal
Initiate a withdrawal request on Chorus One.
POST
https://api.expand.network/liquidstaking/requestwithdrawal
Request Body
* indicates that a parameter is required
Remote procedural call URL.
Public address of the owner of this request.
Amount of token to stake.
Maximum gas limit provided by the sender, for the transaction.
if true,
provides insights of the contract and tokens involved in the transaction.
By Default, false
Available on Ethereum, Polygon, BSC, Avalanche, Arbitrum and Optimism Mainnet
Sample Request Sample Response
Copy {
"liquidStakingId": "200",
"from": "0xdAe2F6EdDdA6fb4fb60cc02633DE27e2b431B402",
"amount": "96291483622040504",
"gas": "800000"
}
Copy {
"status": 200,
"msg": "success",
"data": {
"chainId": "1",
"from": "0xdAe2F6EdDdA6fb4fb60cc02633DE27e2b431B402",
"to": "0xe6d8d8aC54461b1C5eD15740EEe322043F696C08",
"value": "0",
"gas": "800000",
"data": "0x8ceab9aa000000000000000000000000000000000000000000000000015618981c2fe3b8000000000000000000000000dae2f6eddda6fb4fb60cc02633de27e2b431b402",
"referenceId": "24f0b15e11ed4a448e2e37b31c1f87e0"
}
}
With Gas Priority
Sample Request Sample Response
Copy {
"liquidStakingId": "200",
"from": "0xdAe2F6EdDdA6fb4fb60cc02633DE27e2b431B402",
"amount": "96291483622040504",
"gas": "800000",
"gasPriority":"high"
}
Copy {
"status": 200,
"msg": "success",
"data": {
"chainId": "1",
"from": "0xdAe2F6EdDdA6fb4fb60cc02633DE27e2b431B402",
"to": "0xe6d8d8aC54461b1C5eD15740EEe322043F696C08",
"value": "0",
"gas": "800000",
"data": "0x8ceab9aa000000000000000000000000000000000000000000000000015618981c2fe3b8000000000000000000000000dae2f6eddda6fb4fb60cc02633de27e2b431b402",
"gasPrice": "9162032058",
"referenceId": "0685c1e49dd548f589fa9245c34e19c1"
}
}
Sample Request Sampe Response
With ofacCheck:
Copy {
"liquidStakingId": "200",
"from": "0xdAe2F6EdDdA6fb4fb60cc02633DE27e2b431B402",
"amount": "96291483622040504",
"gas": "800000",
"gasPriority":"high",
"ofacCheck": true
}
With ofacCheck:
Copy {
"status": 200,
"msg": "success",
"data": {
"chainId": "1",
"from": "0xfAE7D9854995E28BEB1B1da864ee2A1E2EC17f07",
"to": "0x3d9819210a31b4961b30ef54be2aed79b9c9cd3b",
"value": "0",
"gas": "40000",
"data": "0xede4edd00000000000000000000000005d3a536e4d6dbd6114cc1ead35777bab948e3643",
"gasPrice": "499498318",
"estimationCheck": true,
"insights": {
"asset": {
"issues": [],
"verdict": {
"code": 0,
"label": "NO_ISSUES"
}
},
"to": {
"issues": [],
"verdict": {
"code": 0,
"label": "NO_ISSUES"
}
}
},
"referenceId": "e9bfe6229a844227a92a2f6669aa1da0"
}
}
back to top
/claim
Initiate a transaction to claim staked ETH after a withdrawal request.
POST
https://api.expand.network/liquidstaking/claim
Request Body
* indicates that a parameter is required
Remote procedural call URL.
Request Id which needs to be claimed.
Amount of token to stake.
Maximum gas limit provided by the sender, for the transaction.
if true,
provides insights of the contract and tokens involved in the transaction.
By Default, false
Available on Ethereum, Polygon, BSC, Avalanche, Arbitrum and Optimism Mainnet
Sample Request Sample Response
Copy {
"liquidStakingId": "200",
"from": "0xe55A8cFF86aBf88bfD89C81C287f14848bcf8542",
"requestId": "98632406130503281444",
"gas": "800000"
}
Copy {
"status": 200,
"msg": "success",
"data": {
"chainId": "1",
"from": "0xe55A8cFF86aBf88bfD89C81C287f14848bcf8542",
"to": "0xe6d8d8aC54461b1C5eD15740EEe322043F696C08",
"value": "0",
"data": "0x8697d2c200000000000000000000000000000000000000000000000558ccb2cc7eb56b24000000000000000000000000000000000000000000000000000000006645dc67000000000000000000000000000000000000000000000000000000000000001b",
"gas": "800000",
"referenceId": "0e9a5ad94cb94402b162962b2bc125e2"
}
}
With Gas Priority
Sample Request Sample Response
Copy {
"liquidStakingId": "200",
"from": "0xe55A8cFF86aBf88bfD89C81C287f14848bcf8542",
"requestId": "98632406130503281444",
"gas": "800000",
"gasPriority":"high"
}
Copy {
"status": 200,
"msg": "success",
"data": {
"chainId": "1",
"from": "0xe55A8cFF86aBf88bfD89C81C287f14848bcf8542",
"to": "0xe6d8d8aC54461b1C5eD15740EEe322043F696C08",
"value": "0",
"data": "0x8697d2c200000000000000000000000000000000000000000000000558ccb2cc7eb56b24000000000000000000000000000000000000000000000000000000006645dc67000000000000000000000000000000000000000000000000000000000000001b",
"gas": "800000",
"gasPrice": "9368904020",
"referenceId": "c09f8c096cbf491e981327800d261db3"
}
}
Sample Request Sampe Response
With ofacCheck:
Copy {
"liquidStakingId": "200",
"from": "0xe55A8cFF86aBf88bfD89C81C287f14848bcf8542",
"requestId": "98632406130503281444",
"gas": "800000",
"ofacCheck": true
}
With ofacCheck:
Copy {
"status": 200,
"msg": "success",
"data": {
"chainId": "1",
"from": "0xfAE7D9854995E28BEB1B1da864ee2A1E2EC17f07",
"to": "0x3d9819210a31b4961b30ef54be2aed79b9c9cd3b",
"value": "0",
"gas": "40000",
"data": "0xede4edd00000000000000000000000005d3a536e4d6dbd6114cc1ead35777bab948e3643",
"gasPrice": "499498318",
"estimationCheck": true,
"insights": {
"asset": {
"issues": [],
"verdict": {
"code": 0,
"label": "NO_ISSUES"
}
},
"to": {
"issues": [],
"verdict": {
"code": 0,
"label": "NO_ISSUES"
}
}
},
"referenceId": "e9bfe6229a844227a92a2f6669aa1da0"
}
}
back to top
/mint
Initiate a transaction to mint osETH.
POST
https://api.expand.network/liquidstaking/mint
Request Body
* indicates that a parameter is required
Remote procedural call URL.
Public address of the owner of this request.
Amount of token to stake.
Maximum gas limit provided by the sender, for the transaction.
if true,
provides insights of the contract and tokens involved in the transaction.
By Default, false
Available on Ethereum, Polygon, BSC, Avalanche, Arbitrum and Optimism Mainnet
Sample Request Sample Response
Copy {
"liquidStakingId": "200",
"from": "0xdAe2F6EdDdA6fb4fb60cc02633DE27e2b431B402",
"amount": "1000000000",
"gas": "800000"
}
Copy {
"status": 200,
"msg": "success",
"data": {
"chainId": "1",
"from": "0xdAe2F6EdDdA6fb4fb60cc02633DE27e2b431B402",
"to": "0xe6d8d8aC54461b1C5eD15740EEe322043F696C08",
"value": "0",
"gas": "800000",
"data": "0x201b9eb5000000000000000000000000dae2f6eddda6fb4fb60cc02633de27e2b431b402000000000000000000000000000000000000000000000000000000003b9aca00000000000000000000000000558d7be6092ca91da26521ac25b982d883218e2d",
"referenceId": "330fa401b85248dfb8c92a82e5d1aca6"
}
}
With Gas Priority
Sample Request Sample Response
Copy {
"liquidStakingId": "200",
"from": "0xdAe2F6EdDdA6fb4fb60cc02633DE27e2b431B402",
"amount": "1000000000",
"gas": "800000",
"gasPriority": "high"
}
Copy {
"status": 200,
"msg": "success",
"data": {
"chainId": "1",
"from": "0xdAe2F6EdDdA6fb4fb60cc02633DE27e2b431B402",
"to": "0xe6d8d8aC54461b1C5eD15740EEe322043F696C08",
"value": "0",
"gas": "800000",
"data": "0x201b9eb5000000000000000000000000dae2f6eddda6fb4fb60cc02633de27e2b431b402000000000000000000000000000000000000000000000000000000003b9aca00000000000000000000000000558d7be6092ca91da26521ac25b982d883218e2d",
"gasPrice": "9255297146",
"referenceId": "35d300ebd77b4b5a9c5863287ed0e59a"
}
}
Sample Request Sampe Response
With ofacCheck:
Copy {
"liquidStakingId": "200",
"from": "0xdAe2F6EdDdA6fb4fb60cc02633DE27e2b431B402",
"amount": "1000000000",
"gas": "800000",
"gasPriority": "high",
"ofacCheck": true
}
With ofacCheck:
Copy {
"status": 200,
"msg": "success",
"data": {
"chainId": "1",
"from": "0xfAE7D9854995E28BEB1B1da864ee2A1E2EC17f07",
"to": "0x3d9819210a31b4961b30ef54be2aed79b9c9cd3b",
"value": "0",
"gas": "40000",
"data": "0xede4edd00000000000000000000000005d3a536e4d6dbd6114cc1ead35777bab948e3643",
"gasPrice": "499498318",
"estimationCheck": true,
"insights": {
"asset": {
"issues": [],
"verdict": {
"code": 0,
"label": "NO_ISSUES"
}
},
"to": {
"issues": [],
"verdict": {
"code": 0,
"label": "NO_ISSUES"
}
}
},
"referenceId": "e9bfe6229a844227a92a2f6669aa1da0"
}
}
back to top
/burn
Initiate a transaction to burn osETH.
POST
https://api.expand.network/liquidstaking/burn
Request Body
* indicates that a parameter is required
Remote procedural call URL.
Public address of the owner of this request.
Amount of token to stake.
Maximum gas limit provided by the sender, for the transaction.
if true,
provides insights of the contract and tokens involved in the transaction.
By Default, false
Available on Ethereum, Polygon, BSC, Avalanche, Arbitrum and Optimism Mainnet
Sample Request Sample Response
Copy
{
"liquidStakingId": "200",
"from": "0x02Fd5aBb1f77841827Bfb7cB19608Ec6488BEd08",
"amount": "322",
"gas": "12212"
}
Copy {
"status": 200,
"msg": "success",
"data": {
"chainId": "1",
"from": "0x02Fd5aBb1f77841827Bfb7cB19608Ec6488BEd08",
"to": "0xe6d8d8aC54461b1C5eD15740EEe322043F696C08",
"value": "0",
"gas": "12212",
"data": "0x066055e00000000000000000000000000000000000000000000000000000000000000142",
"referenceId": "a3ff2853fb204693bcba1d1a478e9164"
}
}
With Gas Priority
Sample Request Sample Response
Copy {
"liquidStakingId": "200",
"from": "0x02Fd5aBb1f77841827Bfb7cB19608Ec6488BEd08",
"amount": "322",
"gas": "12212",
"gasPriority": "high"
}
Copy {
"status": 200,
"msg": "success",
"data": {
"chainId": "1",
"from": "0x02Fd5aBb1f77841827Bfb7cB19608Ec6488BEd08",
"to": "0xe6d8d8aC54461b1C5eD15740EEe322043F696C08",
"value": "0",
"gas": "12212",
"data": "0x066055e00000000000000000000000000000000000000000000000000000000000000142",
"gasPrice": "9209305466",
"referenceId": "cebe1fb60da0467d8fab89bf2f1bd71d"
}
}
Sample Request Sampe Response
With ofacCheck:
Copy {
"liquidStakingId": "200",
"from": "0x02Fd5aBb1f77841827Bfb7cB19608Ec6488BEd08",
"amount": "322",
"gas": "12212",
"gasPriority": "high",
"ofacCheck": true
}
With ofacCheck:
Copy {
"status": 200,
"msg": "success",
"data": {
"chainId": "1",
"from": "0xfAE7D9854995E28BEB1B1da864ee2A1E2EC17f07",
"to": "0x3d9819210a31b4961b30ef54be2aed79b9c9cd3b",
"value": "0",
"gas": "40000",
"data": "0xede4edd00000000000000000000000005d3a536e4d6dbd6114cc1ead35777bab948e3643",
"gasPrice": "499498318",
"estimationCheck": true,
"insights": {
"asset": {
"issues": [],
"verdict": {
"code": 0,
"label": "NO_ISSUES"
}
},
"to": {
"issues": [],
"verdict": {
"code": 0,
"label": "NO_ISSUES"
}
}
},
"referenceId": "e9bfe6229a844227a92a2f6669aa1da0"
}
}
back to top
Error Handling Details
Indicates the request is invalid or missing the required parameters. The msg field will contain details about the error.
Indicates the request lacks valid authentication credentials (API key). Ensure that you provide a valid API key in the request headers.
Indicates that the specified endpoint or resource does not exist.
Indicates an internal server error.
back to top