How to Use the API

About the API

• The MyHealthfinder feed is provided in XML and JSON formats.
• The API allows you to query the content on demand and parse it for immediate presentation. The content is updated automatically when the MyHealthfinder team makes any changes.

The API can be accessed on an as-needed basis. There is no limit on how often you can access it.

Examples of the Health and Wellness Topics API

• The query below returns a list of all of the topics in the English database:
  https://health.gov/myhealthfinder/api/v3/itemlist.json?Type=topic
• You can then get additional details about a particular topic from the list (for example the one with TopicId=527):
  https://health.gov/myhealthfinder/api/v3/topicsearch.json?TopicId=527
• Additional details can also be obtained in html format for embedding in iframes:
  https://health.gov/myhealthfinder/api/v3/topicsearch.html?TopicId=527
• The query below returns a list of all of the topics in the Spanish database:
  https://health.gov/myhealthfinder/api/v3/itemlist.json?Type=topic&Lang=es&Lang=es
• You can then get additional details about a particular topic from the Spanish list (for example the one with TopicId=527):
  https://health.gov/myhealthfinder/api/v3/topicsearch.json?TopicId=527&Lang=es

Examples of the MyHealthfinder Preventive Services API

• The query below returns all of the topics and tools recommended when a user searches for a woman, age 35, sexually active, not using tobacco, and not pregnant.
  https://health.gov/myhealthfinder/api/v3/myhealthfinder.json?age=35&sex=female&pregnant=no&sexuallyActive=yes&tobaccoUse=no
• The query below returns a JSON feed containing all of the topics and tools recommended for a male child age 10.
  https://health.gov/myhealthfinder/api/v3/myhealthfinder.json?age=10&sex=male