Fetch Stream By Id
POST /api/ceramic/fetch-stream
This endpoint retrieves a specific asset from Ceramic based on the provided stream ID. It accepts a POST request containing the stream ID in the request body, loads the stream data using Ceramic, and returns the stream information or an error if the request fails.
Headers
Name
Value
Content-Type
application/json
Authorization
Bearer <token>
Body
Name
Type
Description
streamId
string
The unique ID of the Ceramic stream to be fetched
Response
Successfully retrieved the specified stream data from Ceramic.
{
"success": true,
"data": {
"state": {
"type": 3,
"content": {
"type": "1",
"evpId": "b5bd5e25-7d18-4138-83ee-353b72fb9343",
"createdAt": "2022-04-01T08:31:00.000Z",
"evpReportDB": {
"type": "1",
"minerIds": [
"f066596",
"f0678914",
"f01652333",
"f01662356",
"f01702940",
"f01732188",
"f01732189",
"f01755793",
"f01756173",
"f01760317",
"f01796026",
"f01814972",
"f01814973",
"f01823202",
"f01823934"
],
"createdAt": "2022-04-01T08:31:00.000Z",
"updatedAt": "2022-04-30T08:31:00.000Z",
"auditReview": {
"reportOption": 1,
"reviewStatus": 7,
"providerEvpStatus": 7,
"auditorEvpSubmissionDate": "2024-08-29T23:33:51.593Z",
"providerEvpSubmissionDate": ""
},
"auditStatus": 3,
"submittedAt": "",
"greenscoreID": "",
"entityCompany": "Not Provided",
"reportEndDate": "2022-04-30T08:31:00.000Z",
"reportStartDate": "2022-04-01T08:31:00.000Z",
"energyProduction": {
"status": 8,
"createdAt": "2024-08-29T23:48:49.440Z",
"purchaseFiles": [],
"solarWattPeak": "0",
"inspectionDate": "N/A",
"isHistoricData": true,
"inspectionFiles": [],
"solarPanelBrand": "N/A",
"installationDate": "N/A",
"methodOfMeasurement": "",
"numberOfSolarPanels": 0,
"renewableEnergyUsage": true,
"solarPanelModalNumber": "N/A",
"frequencyOfMeasurement": "",
"totalElectricityControlled": 0
},
"waterConsumption": {
"status": 8,
"endDate": "2022-04-30T08:31:00.000Z",
"createdAt": "2022-04-01T08:31:00.000Z",
"reference": "N/A",
"startDate": "2022-04-01T08:31:00.000Z",
"updatedAt": "2022-04-30T08:31:00.000Z",
"waterUsage": false,
"waterCompany": "N/A",
"waterConsumed": 0,
"isHistoricData": true,
"waterBillFiles": []
},
"locationInformation": {
"status": 8,
"createdAt": "2024-08-29T23:33:51.593Z",
"updatedAt": "2024-08-29T23:33:51.593Z",
"providerCity": "",
"entityCompany": "",
"providerState": "",
"isHistoricData": true,
"providerCountry": "",
"providerZipcode": "",
"addressConfirmed": true,
"providerLocation": "N/A"
},
"providerNetworkType": 1,
"hardwareConfiguration": {
"status": 8,
"hardware": {
"description": "N/A",
"hardwareType": "N/A",
"supportingFile": [],
"hardwareDetails": "N/A"
},
"createdAt": "2024-08-29T23:33:51.593Z",
"updatedAt": "2024-08-29T23:33:51.593Z",
"isHistoricData": true
},
"electricityConsumption": {
"status": 8,
"endDate": "2022-04-30T08:31:00.000Z",
"reference": "N/A",
"startDate": "2022-04-01T08:31:00.000Z",
"isHistoricData": true,
"electricityCompany": "N/A",
"electricityBillFiles": [],
"estimationMethodology": "",
"annualElectricityUsage": "293528000",
"actualElectricityConsumed": "66106",
"actualElectricityReturned": "0",
"actualElectricityDelivered": "66106",
"electricityNotPoweringInfrastructure": "66106",
"totalElectricityUsedForNodeOperations": 0
},
"renewableEnergyProcurement": {
"status": 1,
"endDate": "",
"createdAt": "",
"startDate": "",
"updatedAt": "",
"energyUsage": false,
"documentFiles": [],
"isHistoricData": false,
"supportingFiles": [],
"renewableEnergyType": "",
"electricityPurchased": 0,
"actualElectricityReturned": "",
"actualElectricityDelivered": "",
"renewableEnergyPurchasedFrom": "",
"networkRenewableEnergyPurchases": 0,
"networkRenewableElectricityPurchasedDocs": "",
"networkRenewableElectricityPurchasedSource": ""
},
"preliminaryResultsRecMatching": {
"status": 8,
"endDate": "2022-04-30T08:31:00.000Z",
"createdAt": "",
"startDate": "2022-04-01T08:31:00.000Z",
"updatedAt": "",
"timePeriod": "N/A",
"isHistoricData": false,
"supportingFile": "",
"totalEmissions": 0,
"emissionsFactor": 436,
"actualElectricityConsumed": "66106",
"actualElectricityReturned": "",
"actualElectricityDelivered": "66106"
}
},
"greenscoreDB": {
"type": "1",
"other": {
"co2StorageBlockCid": "bafyreicwhh43gudilcwrnl5kcbiq4chowxu4dnntfqvkdze3jx44tl3te4",
"notesOnDataSources": "",
"co2StorageContentCid": "bafyreihydb432nfkf3vvc5r55qp2qqlqknh3pdgylxypxfgd5hpwo3elk4",
"co2StoragePreviousAssetCid": "bafyreicmiget3mr64mw5ijdqgtmlyb6kovcth7tbug7bin3uxgzkk7xoni",
"informationAboutGreenScoreMeasurementType": ""
},
"status": 3,
"minerIds": [],
"createdAt": "",
"updatedAt": "",
"documentId": "",
"greenScore": 64.48,
"greenscoreId": "",
"providerCity": "",
"entityCompany": "Not Provided",
"locationScore": 0.464,
"reportEndDate": "2022-04-30T08:31:00.000Z",
"emissionsScore": 1,
"isHistoricData": true,
"confidenceScore": 0.47,
"providerCountry": "",
"reportStartDate": "2022-04-01T08:31:00.000Z",
"providerLocation": "",
"gridEmissionsFactor": "",
"providerNetworkType": "",
"providerLocationCode": "",
"confidenceScoreDetails": {
"nodeIdConfidence": 1,
"hardwareConfidence": 1,
"locationConfidence": 1,
"waterUseConfidence": 0,
"energyUseConfidence": 0.4,
"nodeIDConfidencePercentageInformation": "",
"hardwareConfidencePercentageInformation": "Photo and video evidence provided to further verify claims (100%)",
"waterUseConfidencePercentageInformation": "No data (0%)",
"energyUseConfidencePercentageInformation": "Power Bill (40%)",
"locationInformationPercentageInformation": "Address reported on two third-party documents and all information matches (100%)"
},
"marginalEmissionsFactor": 0,
"networkMarginalEmissions": {
"networkMarginalEmissions": 0,
"globalAverageGridEmissionsFactor": 0,
"totalNetworkElectricityConsumption": 0,
"totalNetworkRenewableEnergyProduction": 0,
"globalAverageGridEmissionsFactorSource": ""
},
"benchmarkEmissionIntensity": 0,
"marginalEmissionsIntensity": 56281.26,
"scope2EmissionsCalculation": {
"scope2Emissions": 0,
"gridEmissionsFactor": 0,
"actualNetPowerConsumed": 0,
"averageDataStorageCapacity": 0,
"renewableEnergyConsumption": 0
},
"emissionIntensityCalculation": "",
"normalizedEmissionsIntensity": 0,
"globalMarginalEmissionsFactor": 0,
"globalAverageGridEmissionsFactor": 436,
"networkScope2EmissionsCalculation": {
"networkScope2Emissions": 0,
"globalAverageGridEmissionsFactor": 0,
"estimateCumulativeEnergyUsePerTime": 0,
"averageRawByteCapacityForReportingTime": 0,
"networkAverageRenewableEnergyPurchases": 0
},
"benchmarkMarginalEmissionIntensity": 0,
"globalAverageMarginalEmissionFactor": 614.98,
"normalizedMarginalEmissionIntensity": 0,
"globalAverageGridEmissionsFactorSource": "",
"globalAverageMarginalEmissionFactorSource": ""
},
"organizationId": "null"
},
"metadata": {
"controllers": [
"did:pkh:eip155:1:0x00e72cbcdf365395f23ced4404c96a58d27ced0f"
],
"model": {
"_type": 2,
"_cid": {
"/": "bagcqcerafpt4lwb5akrxioxsnp52q6yn7wjpcf6tavf5pfx4aum54nbesoha"
}
},
"unique": {
"0": 235,
"1": 9,
"2": 221,
"3": 197,
"4": 64,
"5": 138,
"6": 6,
"7": 150,
"8": 150,
"9": 11,
"10": 2,
"11": 170
}
},
"signature": 2,
"anchorStatus": 1,
"log": [
{
"cid": {
"/": "bagcqceracdrz4a6aj3c6atwoqzlh4rb2qmub55z4lcouw3ampwhuhmlqkqwq"
},
"type": 0,
"expirationTime": 1727190796
}
]
},
"streamId": "kjzl6kcym7w8y5axqkk8ovoigpp7g7a9kh65q008kg8eiy76ulihoxqn5myjdbh"
}
}Occurs when the stream ID is missing or invalid in the request body.
{
"success": false,
"message": "Stream ID is required"
}Occurs when a request method other than POST is used. The endpoint only accepts POST requests.
{
"success": false,
"message": "Method Not Allowed"
}Occurs due to unexpected server-side issues, such as failures in fetching stream data from the Ceramic network or internal processing errors.
{
"success": false,
"message": "Internal Server Error",
"details": "Error details here..."
}Last updated