Skip to navigation

/diseases/charts

View as Markdown

Returns a list of charts (graphs) that match your filters—each item identifies the disease, country, chart title, type, and a link (href) to fetch the full chart data. Results are sorted by title and limited to 1000 items per request.

Required (at least one)

Provide at least one non-empty value using one or more of these query parameters (comma-separated where multiple values are allowed):

ParameterDescription
diseasesDisease IDs
countriesCountry codes (see /diseases/fingerprint/countries)
statesState or province codes
countryregionsCountry region identifiers
keywordsWords or phrases to find in chart titles

If you omit all of the above, the API returns 400 with a short message explaining that a filter is required.

Optional

ParameterDescription
typeLimit results to one or more chart types (comma-separated)

Use GET /diseases/charts/countries and GET /diseases/charts/regions to list countries, states, and countryregions values that appear in the chart catalog. Use GET /diseases/charts/keywords (parameter q) to suggest keywords for the title search on GET /diseases/charts. When you already know the disease id, GET /diseases/{disease_code}/charts returns every catalog row for that disease across countries. For every chart in one country without building filters, GET /diseases/countries/{country_code}/charts returns the same style of rows for that country only.

Typical fields in each result include disease and country names, codes, chart identifier, title, type, and href for the follow-up chart request.

Authentication

Authorizationstring
API Key authentication via header

Query parameters

diseasesintegerOptional

Comma-separated disease IDs. At least one of diseases, countries, states, countryregions, or keywords must have a non-empty value.

countriesstringOptional

Comma-separated country codes (e.g. from /diseases/fingerprint/countries).

Response

OK
datalist of objects