RealAge¶
The RealAge API, allows access to a wealth of data and analytics to gain insights into user behavior and preferences, enabling them to create more effective and targeted health interventions. Learn more about the RealAge test.
Prerequisites
Before using Sharecare API's please read the API Integration Guide
To access RealAge data for a user they must complete the RealAge test on the Sharecare App or using an Embedded RealAge Test
See the full RealAge feature flow for a better understanding of how the RealAge test can be integrated into your application.
RealAge Results Endpoint¶
Sharecare's RealAge results provide individuals with a personalized assessment of their biological age compared to their chronological age, taking into account various lifestyle factors and health indicators. By analyzing factors such as exercise habits, diet, stress levels, and medical history, RealAge offers actionable insights to help users make informed decisions and take steps towards improving their overall health and well-being.
API
API Documentation¶
Refer to our API documentation for the most up to date specifications Simply click "Try it out" then "Execute" with the default values to see a live response.
Open API Doc
Example¶
Try out the curl as is for a static response OR Replace 'accountReference' with the target user id and '5nLpWr' with your API key
curl -L 'https://gateway.stage.sharecare.com/realage/result?accountReferenceType=partnerAccountId&accountReference=genera.sharecare.1@gmail.com' \
-H 'X-API-Key: 5nLpWr' \
-H 'accept: application/json'
This version is deprecated as it only supports accountId values. The preferred endpoint is above and supports various partner or Sharecare generated identifiers. Most notably the partnerAccountId accountReferenceType.
curl -L 'https://gateway.stage.sharecare.com/realage/result/3895d3bb-5bb7-4a17-b14d-35c168a6c51a' \
-H 'X-API-Key: 5nLpWr' \
-H 'accept: application/json'
{
"status": "COMPLETE",
"realAge": {
"year": 35,
"month": 1
},
"calendarAge": {
"year": 37,
"month": 2
},
"realAgeDelta": {
"year": 2,
"month": 1
},
"completed": "2023-01-09T16:15:37.937Z"
}
RealAge Recommendations Endpoint¶
Sharecare's RealAge recommendations offer personalized guidance based on an individual's biological age, lifestyle factors, and health indicators. These recommendations encompass areas such as exercise routines, nutrition plans, stress management techniques, and preventive healthcare measures, empowering users to make meaningful changes and optimize their overall health for a younger biological age.
API
API Documentation¶
Refer to our API documentation for the most up to date specifications.
Simply click "Try it out" then "Execute" with the default values to see a live response.
Open API Doc
Example¶
Try out the curl as is for a static response OR Replace 'accountReference' with the target user id and '5nLpWr' with your API key
curl -L 'https://gateway.stage.sharecare.com/realage/assessments/1440567/recommendations?accountReferenceType=partnerAccountId&accountReference=genera.sharecare.1@gmail.com' \
-H 'X-API-Key: 5nLpWr' \
-H 'Content-Type: application/json' \
-H 'Accept-Language: en-US-u-ms-ussystem'
This version is deprecated as it only supports accountId values. The preferred endpoint is above and supports various partner or Sharecare generated identifiers. Most notably the partnerAccountId accountReferenceType.
curl -L 'https://gateway.stage.sharecare.com/realage/assessments/1440567/recommendations/3895d3bb-5bb7-4a17-b14d-35c168a6c51a' \
-H 'X-API-Key: 5nLpWr' \
-H 'accept: application/json'
[
{
"teaser": "Unhealthy BMI or waist size",
"benefitCost": "cost",
"body": "Based on your RealAge score, your BMI and waist size are making you older. Here's some pointers."
},
{
"teaser": "Find a sense of purpose",
"benefitCost": "cost",
"body": "RealAge Emotion - Sense of Purpose in Life Cost"
},
{
"teaser": "Little low on cardio",
"benefitCost": "cost",
"body": "RealAge Fitness - Cardio Cost"
},
{
"teaser": "Create a workout that works for you",
"benefitCost": "benefit",
"body": "RealAge Fitness - Workout Type Benefit"
},
{
"teaser": "Stop putting off that check-up",
"benefitCost": "neither",
"body": "RealAge Men's Health Screening"
},
{
"teaser": "BMI",
"benefitCost": "cost",
"body": "BMI"
},
{
"teaser": "Cardio kick start with celeb trainer Eve Overland",
"benefitCost": "cost",
"body": "Physical activity: Beginner Cardio"
}
]
Note
| Field | Possible Values |
| --------- | ----- |
| `benefitCost` | "cost", "benefit", "neither" |
_See API docs for more comprehensive details_
RealAge Questions And Answers Endpoint¶
If a user has completed a RealAge test then this endpoint will return a user's specific questions and their corresponding answers from their RealAge test.
API
API Documentation¶
Refer to our API documentation for the most up to date specifications Simply click "Try it out" then "Execute" with the default values to see a live response.
Open API Doc
Example¶
Try out the curl as is for a static response OR Replace 'accountReference' with the target user id and '5nLpWr' with your API key
curl -L 'https://gateway.stage.sharecare.com/realage/completed/questions?accountReferenceType=partnerAccountId&accountReference=genera.sharecare.1@gmail.com' \
-H 'X-API-Key: 5nLpWr' \
-H 'accept: application/json'
[
{
"id": "693d4f81-6a33-4bcb-b54b-bbe0778e02d6",
"assessmentId": "1004385",
"account": {
"type": "partnerAccountId",
"reference": "genera.sharecare.1@gmail.com"
},
"created": "2023-08-30T21:28:38.645Z",
"assessmentType": "RealAge",
"questions": [
{
"id": "2201408",
"text": "What is your height?",
"answers": [
{
"id": "10861",
"description": "Height (Feet)",
"label": "6",
"value": "6"
},
{
"id": "10862",
"description": "Height (Inches)",
"label": "0",
"value": "0"
}
]
},
{
"id": "2201410",
"text": "What is your weight?",
"answers": [
{
"id": "619",
"description": "Weight (Pounds)",
"label": "160",
"value": "160"
}
]
}
]
}
]
RealAge Test¶
We also offer a RealAge Embeddable Component that allows users to take the RealAge test.
RealAge Assessment Questions Current Page¶
This endpoint used to get user's current page of questions
API
API Documentation¶
Refer to our API documentation for the most up to date specifications Simply click "Try it out" then "Execute" with the default values to see a live response.
Open API Doc
Example¶
Replace 'token' with the bearer token
curl -L 'https://gateway.stage.sharecare.com/assessments/realage' \
-H 'X-API-Key: 5nLpWr' \
-H 'X-API-Version: 1.0' \
-H 'Authorization: Bearer token' \
-H 'accept: application/json'
{
"code": 200,
"message": "Success",
"data": [
{
"moduleId": "1",
"questionGroupId": "1",
"pageNumber": "1.1",
"questions": [
{
"id": "2201407",
"displayLabel": {},
"displayLabelOrder": [],
"factDataType": {
"21072": "NONE"
},
"questionText": "What is your sex assigned at birth (birth sex)? (Your sex assigned at birth is used in calculating your RealAge.)",
"answers": [
{
"value": "female",
"text": "Female",
"factId": "21072",
"answerId": "1b",
"answersToClear": []
},
{
"value": "male",
"text": "Male",
"factId": "21072",
"answerId": "1a",
"answersToClear": []
}
],
"required": true,
"type": "radio",
"previousValues": {},
"moreInfoTitle": "",
"moreInfoBody": ""
}
]
}
]
}
RealAge Assessment Submit Answers¶
This endpoint used to send answers to questions
API
API Documentation¶
Refer to our API documentation for the most up to date specifications Simply click "Try it out" then "Execute" with the default values to see a live response.
Open API Doc
Example¶
Replace 'token' with the bearer token
curl -L 'https://gateway.stage.sharecare.com/assessments/realage' \
-H 'X-API-Key: 5nLpWr' \
-H 'X-API-Version: 1.0' \
-H 'Authorization: Bearer token' \
-H 'content-type: application/json' \
-d '{
"moduleId": "1",
"questionGroupId": "1",
"answers": {
"2201407": [
{
"21072": "1a"
}
]
}
}'
{
"code": 200,
"message": "Success",
"data": [
{
"moduleId": "1",
"questionGroupId": "2",
"pageNumber": "1.2",
"questions": [
{
"id": "2201408",
"displayLabel": { "10861": "Feet", "10862": "Inches" },
"displayLabelOrder": ["10862","10861"],
"factDataType": { "10862": "INTEGER","10861": "INTEGER" },
"questionText": "What is your height?",
"answers":[
{ "value":"11", "text":"11", "factId": "10862", "answerId": "3.2l", "answersToClear": [] },
{ "value": "4", "text": "4", "factId": "10861", "answerId": "3.1c", "answersToClear": [] },
{ "value": "4", "text": "4", "factId": "10862", "answerId": "3.2e", "answersToClear": [] },
{ "value": "7", "text": "7", "factId": "10861", "answerId": "3.1f", "answersToClear": [] },
{ "value": "7", "text": "7", "factId": "10862", "answerId": "3.2h", "answersToClear": [] },
{ "value": "5", "text": "5", "factId": "10861", "answerId": "3.1d", "answersToClear": [] },
{ "value": "5", "text": "5", "factId": "10862", "answerId": "3.2f", "answersToClear": [] },
{ "value": "9", "text": "9", "factId": "10862", "answerId": "3.2j", "answersToClear": [] },
{ "value": "2", "text": "2", "factId": "10861", "answerId": "3.1a", "answersToClear": [] },
{ "value": "0", "text": "0", "factId": "10862", "answerId": "3.2a", "answersToClear": [] },
{ "value": "2", "text": "2", "factId": "10862", "answerId": "3.2c", "answersToClear": [] },
{ "value":"10", "text":"10", "factId": "10862", "answerId": "3.2k", "answersToClear": [] },
{ "value": "8", "text": "8", "factId": "10861", "answerId": "3.1g", "answersToClear": [] },
{ "value": "8", "text": "8", "factId": "10862", "answerId": "3.2i", "answersToClear": [] },
{ "value": "3", "text": "3", "factId": "10861", "answerId": "3.1b", "answersToClear": [] },
{ "value": "3", "text": "3", "factId": "10862", "answerId": "3.2d", "answersToClear": [] },
{ "value": "6", "text": "6", "factId": "10861", "answerId": "3.1e", "answersToClear": [] },
{ "value": "6", "text": "6", "factId": "10862", "answerId": "3.2g", "answersToClear": [] },
{ "value": "1", "text": "1", "factId": "10862", "answerId": "3.2b", "answersToClear": [] }
],
"required": true,
"type": "select",
"previousValues": { "10862": "6", "10861": "5" },
"moreInfoTitle": "",
"moreInfoBody": ""
}
]
}
]
}