1.) Generate an API key https://global-impact-prod.revelry-prod.revelry.net/user/api-key (available for admins only)
2.) Use the generated api key as an auth-bearer token in your request
curl --location --request POST 'https://global-impact-prod.revelry-prod.revelry.net/api/irr_score' \
--header 'Authorization: Bearer <YOUR API KEY HERE>' \
--header 'Content-Type: application/json' \
--data-raw '{
"impact_multiplier": 0.8,
"units_delivered": 120320,
"goal": 500,
"time_period": 3,
"cost": 73000000,
"log_base": 100
}'
Yields a json response of
{
"data": {
"irr_score": 37.13
}
}
Where 37.13 is equal to an iRR of 37.13%
curl --location --request POST 'https://global-impact-prod.revelry-prod.revelry.net/api/impact_potential' \
--header 'Authorization: Bearer <YOUR API KEY HERE>' \
--header 'Content-Type: application/json' \
--data-raw '{
"accessibility": 0,
"educational_attainment": 2,
"household_income_vs_national_median": 1,
"inequality": 0,
"poverty": 4,
"resident_demographic": 2,
"unemployment_vs_national_average": 3,
"fossil_fuel_energy_use": 2
}'
Available fields for impact potential:
accessibilityeducational_attainmenthousehold_income_vs._national_medianinequalitypovertyresident_demographicunemployment_vs._national_averagewalkabilityfossil_fuel_energy_usehousing_cost_burdenhousing_rentals
Each metric must be scored 0 - 5. JTC Impact Potential utilizes 8 of the available 11 metrics, and the API will tabulate the first 8 metrics with scores.