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

Open In a New Window

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

Request

curl -L 'https://gateway.uat.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.

Request

curl -L 'https://gateway.uat.sharecare.com/realage/result/3895d3bb-5bb7-4a17-b14d-35c168a6c51a' \
    -H 'X-API-Key: 5nLpWr' \
    -H 'accept: application/json'

Sample Response

{
    "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

Open In a New Window

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

Request

curl -L 'https://gateway.uat.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.

Request

curl -L 'https://gateway.uat.sharecare.com/realage/assessments/1440567/recommendations/3895d3bb-5bb7-4a17-b14d-35c168a6c51a' \
    -H 'X-API-Key: 5nLpWr' \
    -H 'accept: application/json'

Sample Response

[
    {
        "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 Test¶

We also offer a RealAge Embeddable Component that allows users to take the RealAge test.