{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"30ddde09-07ba-4918-9bc2-93d90f0e816e","name":"revalu API","description":"An API (Application Programming Interface) allows two applications to communicate. API calls have specific parameters that define the question, and that the response aligns with the request. Essentially, an API is a set of defined rules that determine how applications can interact and what responses to expect.\n\nrevalu's API is REST based and returns JSON responses; and uses API key based authentication. All requests must be made over HTTPS.\n\n## How can revalu API support you?\n\nrevalu’s API allows you to minimise your effort to keep your data up to date, to follow data quality guidelines, to manually capture missing data, to store data versions in separate files in your pc. You can achieve that by using Revalu’s API to:\n\n- Integrate revalu’s data to your existing workflows, build features and retrieve data with ease.\n    \n- revalu's endpoints enables you to access various attributes of EPDs such as GWP, FW, PERT, PENRT etc.\n    \n- Evaluate and compare different materials based on their performance and sustainability data for your projects.\n    \n- Consolidate material data across design tools to meet sustainability targets.\n    \n- Optimise Design and Reporting.\n    \n- Manage and manipulate material data directly in your projects.\n    \n- Convert data formats and perform calculations seamlessly within your workflows.\n    \n- With built-in Quality Control and Data Checks, you can ensure data accuracy.\n    \n\n## **Where to Use It**\n\n- Integrate in your existing analysis tools, whether they are in Excel or other softwares.\n    \n- Integrate the API in Revit (via Dynamo) and Rhino (via Grasshopper).\n    \n\n## **How to Get Access**\n\nGetting started with the revalu API is quick and easy:\n\n1. Sign Up: If you don’t have an account already, create a [revalu account](https://platform.revalu.io/) with your company email.\n    \n2. Explore our subscription types (Free, Member, Premium) and request access to the API from the [revalu website](https://www.revalu.io/).\n    \n3. Get Your Token: We will get in touch with you and provice an API token (a unique key) that you’ll use to make API calls.\n    \n4. Get Started: Connect the API and start exploring.\n    \n\n## Authentication\n\nrevalu API uses API keys for authentication.\n\nYou must include an API key in each request to the API with the _x-api-key_ request header.\n\n### Error responses\n\n- If an API key is missing, malformed, or invalid, you will receive an HTTP 403 Forbidden response code.\n    \n- Any requests sent via HTTP return an connection refused error.\n    \n- If an endpoint is not valid then also you may receive HTTP 403 Forbidden response code.\n    \n- If an endpoint is not available in a user tier then you will receive API status code of 403 and 'needs upgrade' message. Please note that HTTP status code is 200 in this case.\n    \n- If a user has crossed the limit on number of APIs assigned, they will see a, 'Limit exceeded' message.\n    \n- If any API has limits on output, ex. number of materials then this is commnicated via the message attribute in API response. ex. \"Success, with limited response according to user tier.\" instead of just \"Success\"\n    \n- If you are seeing any issue and need our help, please contact us at [helpdesk@revalu.io](https://mailto:helpdesk@revalu.io).","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"31891496","team":5918441,"collectionId":"30ddde09-07ba-4918-9bc2-93d90f0e816e","publishedId":"2s9Ykodgev","public":true,"publicUrl":"https://docs.revalu.io","privateUrl":"https://go.postman.co/documentation/31891496-30ddde09-07ba-4918-9bc2-93d90f0e816e","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"documentationLayout":"classic-double-column","customisation":{"metaTags":[{"name":"description","value":""},{"name":"title","value":""}],"appearance":{"default":"light","themes":[{"name":"dark","logo":"https://content.pstmn.io/9310fbbe-7c71-4583-9269-20eb188bc02c/NjUzYThlNWNkOTc2N2UyNjBkNGNhZDE0X1JldmFsdSBsb2dvIGJyb3duLnBuZw==","colors":{"top-bar":"212121","right-sidebar":"303030","highlight":"FF6C37"}},{"name":"light","logo":"https://content.pstmn.io/9310fbbe-7c71-4583-9269-20eb188bc02c/NjUzYThlNWNkOTc2N2UyNjBkNGNhZDE0X1JldmFsdSBsb2dvIGJyb3duLnBuZw==","colors":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"}}]}},"version":"8.10.0","publishDate":"2024-10-06T06:27:29.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{"title":"","description":""},"logos":{"logoLight":"https://content.pstmn.io/9310fbbe-7c71-4583-9269-20eb188bc02c/NjUzYThlNWNkOTc2N2UyNjBkNGNhZDE0X1JldmFsdSBsb2dvIGJyb3duLnBuZw==","logoDark":"https://content.pstmn.io/9310fbbe-7c71-4583-9269-20eb188bc02c/NjUzYThlNWNkOTc2N2UyNjBkNGNhZDE0X1JldmFsdSBsb2dvIGJyb3duLnBuZw=="}},"statusCode":200},"environments":[{"name":"Live","id":"8f082b44-48fb-43b8-8c0c-45bbd10b3c56","owner":"31891496","values":[{"key":"uuid","value":"c37c442b-b6ac-4bf8-9b24-08dbdfa8f0c9","enabled":true,"type":"default"},{"key":"api_key","value":"Replace this value (Environments -> Live-> api_key)","enabled":true,"type":"default"},{"key":"collection_id","value":"66cca324b0a11e02e995c47f","enabled":true,"type":"default"},{"key":"attribute_id","value":"1","enabled":true,"type":"default"},{"key":"collection_material_id","value":"11542e67-6ff2-4bb6-ad4d-f4c061b2a1cf_65d75ffda2c7c035723ed5d0_1547","enabled":true,"type":"default"}],"published":true}],"user":{"authenticated":false,"permissions":{"publish":false}},"run":{"button":{"js":"https://run.pstmn.io/button.js","css":"https://run.pstmn.io/button.css"}},"web":"https://www.getpostman.com/","team":{"logo":"https://res.cloudinary.com/postman/image/upload/t_team_logo_pubdoc/v1/team/d88b7636a028031b554be70af0dec1b9b2eb8706da737f9d47d3b84fed6179f5","favicon":"https://revalu.io/favicon.ico"},"isEnvFetchError":false,"languages":"[{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"HttpClient\"},{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"RestSharp\"},{\"key\":\"curl\",\"label\":\"cURL\",\"variant\":\"cURL\"},{\"key\":\"dart\",\"label\":\"Dart\",\"variant\":\"http\"},{\"key\":\"go\",\"label\":\"Go\",\"variant\":\"Native\"},{\"key\":\"http\",\"label\":\"HTTP\",\"variant\":\"HTTP\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"OkHttp\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"Unirest\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"Fetch\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"jQuery\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"XHR\"},{\"key\":\"c\",\"label\":\"C\",\"variant\":\"libcurl\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Axios\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Native\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Request\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Unirest\"},{\"key\":\"objective-c\",\"label\":\"Objective-C\",\"variant\":\"NSURLSession\"},{\"key\":\"ocaml\",\"label\":\"OCaml\",\"variant\":\"Cohttp\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"cURL\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"Guzzle\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"HTTP_Request2\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"pecl_http\"},{\"key\":\"powershell\",\"label\":\"PowerShell\",\"variant\":\"RestMethod\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"http.client\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"Requests\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"httr\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"RCurl\"},{\"key\":\"ruby\",\"label\":\"Ruby\",\"variant\":\"Net::HTTP\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"Httpie\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"wget\"},{\"key\":\"swift\",\"label\":\"Swift\",\"variant\":\"URLSession\"}]","languageSettings":[{"key":"csharp","label":"C#","variant":"HttpClient"},{"key":"csharp","label":"C#","variant":"RestSharp"},{"key":"curl","label":"cURL","variant":"cURL"},{"key":"dart","label":"Dart","variant":"http"},{"key":"go","label":"Go","variant":"Native"},{"key":"http","label":"HTTP","variant":"HTTP"},{"key":"java","label":"Java","variant":"OkHttp"},{"key":"java","label":"Java","variant":"Unirest"},{"key":"javascript","label":"JavaScript","variant":"Fetch"},{"key":"javascript","label":"JavaScript","variant":"jQuery"},{"key":"javascript","label":"JavaScript","variant":"XHR"},{"key":"c","label":"C","variant":"libcurl"},{"key":"nodejs","label":"NodeJs","variant":"Axios"},{"key":"nodejs","label":"NodeJs","variant":"Native"},{"key":"nodejs","label":"NodeJs","variant":"Request"},{"key":"nodejs","label":"NodeJs","variant":"Unirest"},{"key":"objective-c","label":"Objective-C","variant":"NSURLSession"},{"key":"ocaml","label":"OCaml","variant":"Cohttp"},{"key":"php","label":"PHP","variant":"cURL"},{"key":"php","label":"PHP","variant":"Guzzle"},{"key":"php","label":"PHP","variant":"HTTP_Request2"},{"key":"php","label":"PHP","variant":"pecl_http"},{"key":"powershell","label":"PowerShell","variant":"RestMethod"},{"key":"python","label":"Python","variant":"http.client"},{"key":"python","label":"Python","variant":"Requests"},{"key":"r","label":"R","variant":"httr"},{"key":"r","label":"R","variant":"RCurl"},{"key":"ruby","label":"Ruby","variant":"Net::HTTP"},{"key":"shell","label":"Shell","variant":"Httpie"},{"key":"shell","label":"Shell","variant":"wget"},{"key":"swift","label":"Swift","variant":"URLSession"}],"languageOptions":[{"label":"C# - HttpClient","value":"csharp - HttpClient - C#"},{"label":"C# - RestSharp","value":"csharp - RestSharp - C#"},{"label":"cURL - cURL","value":"curl - cURL - cURL"},{"label":"Dart - http","value":"dart - http - Dart"},{"label":"Go - Native","value":"go - Native - Go"},{"label":"HTTP - HTTP","value":"http - HTTP - HTTP"},{"label":"Java - OkHttp","value":"java - OkHttp - Java"},{"label":"Java - Unirest","value":"java - Unirest - Java"},{"label":"JavaScript - Fetch","value":"javascript - Fetch - JavaScript"},{"label":"JavaScript - jQuery","value":"javascript - jQuery - JavaScript"},{"label":"JavaScript - XHR","value":"javascript - XHR - JavaScript"},{"label":"C - libcurl","value":"c - libcurl - C"},{"label":"NodeJs - Axios","value":"nodejs - Axios - NodeJs"},{"label":"NodeJs - Native","value":"nodejs - Native - NodeJs"},{"label":"NodeJs - Request","value":"nodejs - Request - NodeJs"},{"label":"NodeJs - Unirest","value":"nodejs - Unirest - NodeJs"},{"label":"Objective-C - NSURLSession","value":"objective-c - NSURLSession - Objective-C"},{"label":"OCaml - Cohttp","value":"ocaml - Cohttp - OCaml"},{"label":"PHP - cURL","value":"php - cURL - PHP"},{"label":"PHP - Guzzle","value":"php - Guzzle - PHP"},{"label":"PHP - HTTP_Request2","value":"php - HTTP_Request2 - PHP"},{"label":"PHP - pecl_http","value":"php - pecl_http - PHP"},{"label":"PowerShell - RestMethod","value":"powershell - RestMethod - PowerShell"},{"label":"Python - http.client","value":"python - http.client - Python"},{"label":"Python - Requests","value":"python - Requests - Python"},{"label":"R - httr","value":"r - httr - R"},{"label":"R - RCurl","value":"r - RCurl - R"},{"label":"Ruby - Net::HTTP","value":"ruby - Net::HTTP - Ruby"},{"label":"Shell - Httpie","value":"shell - Httpie - Shell"},{"label":"Shell - wget","value":"shell - wget - Shell"},{"label":"Swift - URLSession","value":"swift - URLSession - Swift"}],"layoutOptions":[{"value":"classic-single-column","label":"Single Column"},{"value":"classic-double-column","label":"Double Column"}],"versionOptions":[],"environmentOptions":[{"value":"0","label":"No Environment"},{"label":"Live","value":"31891496-8f082b44-48fb-43b8-8c0c-45bbd10b3c56"}],"canonicalUrl":"https://docs.revalu.io/view/metadata/2s9Ykodgev"}