openapi: 3.0.1 info: title: AskCHIS Neighborhood Edition description: 'The AskCHIS Neighborhood Edition (AskCHIS NE) API provides access to all of the estimates available in the AskCHIS NE dashboard (http://askchisne.ucla.edu). The API can be used for both web development and research and makes it easy for users to build custom queries and extract estimates. Health indicators in AskCHIS NE are created using a sophisticated modeling technique called Small Area Estimation (SAE). For more information on data provenance, please visit the help section in AskCHIS NE.' version: '1.0' servers: - url: http://askchisne.azure-api.net/api paths: /geosearch: get: summary: Geography Search description: Will perform a search across all geo types and return a list of geography objects found using the provided search term. operationId: 55bff6476fcb33169c6580c7 parameters: - name: searchTerm in: query description: Term used to perform the search. Can be the full term or a partial text. required: true schema: type: string responses: '200': description: '' content: application/json: example: - geoId: '650258' name: Napa year: 2012 totalPopulation: 60700 geoType: CITIES variables: - geoId: '6055' name: Napa County year: 2012 totalPopulation: 132800 geoType: COUNTIES variables: '/variablepool/{name}': get: summary: Pool Data by Geo IDs description: "Will pool data from different locations and return it as a single dataset. The geographic IDs must be of the same type (e.g. all cities, all counties or all zip codes)\n\nNote: This operation is not available for the Free product. You must upgrade in order to do pooling." operationId: 55bff99d6fcb33169c6580c8 parameters: - name: name in: path description: Indicator name required: true schema: type: string - name: geoIds in: query description: "Can be any GeoId that represents a geographic entity.\n\nTo query for more than one GeoId, provide a comma-separated list (e.g. geoids=666000,644000,92037,92117).\n\nGeoIds must belong to locations with the same geoType (all 'CITIES' or all 'COUNTIES' for example) or a '400 - Bad Request' message will be returned.\n" required: true schema: type: string - name: attributes in: query description: "Can be any of the following (case-sensitive):\n population,\n estimate,\n SE,\n CI_LB95,\n CI_UB95,\n CV,\n MSE\n\nTo query for more than one attribute, provide a comma-separated list (e.g. attributes=population,estimate" schema: type: string - name: year in: query description: Desired dataset year schema: type: number responses: '200': description: '' content: application/json: example: - name: HEARTDA description: Adult respondents ages 18+ who were ever diagnosed with heart disease by a doctor. category: Health Topic subcategory: Heart disease attributeTypes: - estimate - CI_LB95 - CI_UB95 - population - indicator_type attributeLabels: - Heart disease - 95% Confidence Interval (C.I.) - lower boundary - 95% Confidence Interval (C.I.) - higher boundary - Estimated Population - '' geographies: - geoId: '620802,644000' geoName: 'East Los Angeles,Los Angeles' geoTypeId: CITIES attributes: - '0.056' - '0.051' - '0.062' - '2992300' - '1' isSuppressed: false suppressionReason: '400': description: '' /metadata: get: summary: Metadata description: Returns all the health indicators available including the variable code used in subsequent calls to retrieve data. operationId: 55c146426fcb330c34944ec1 responses: '200': description: '' '/variable/{name}': get: summary: Variable description: "Return data for a specific health indicator (e.g. variable) for specific geographic areas provided.\n\nNote: The geoType or the geoIds parameter is required. You can have both, or just one, but you cannot leave them both empty. \n\nFree Tier Restriction: Only one geographic area can be queried at a time. If multiple geoIds are provided, the first one will be used." operationId: 55c1472a6fcb330c34944ec2 parameters: - name: name in: path description: Indicator name required: true schema: type: string - name: attributes in: query description: "Can be any of the following (case-sensitive):\n population, \n estimate, \n SE, \n CI_LB95, \n CI_UB95, \n CV , \n MSE\n\nTo query for more than one attribute, provide a comma-separated list (e.g. attributes=population, estimate, SE" schema: type: string - name: geoType in: query description: 'can be one of the following: cities, assembly, congress, senate, zcta (zip codes), state, counties' schema: type: string - name: geoIds in: query description: "Can be any GeoId that represents a geographic entity. \n\nTo query for more than one GeoId, provide a comma-separated list (e.g. geoids=666000,644000,92037,92117).\n\ngeoIds must belong to locations with the same geoType (all 'CITIES' or all 'COUNTIES' for example) or a '400 - Bad Request' message will be returned." schema: type: string - name: year in: query description: Desired dataset year schema: type: number responses: '200': description: '' content: application/json: example: - name: OBESEA description: Adult respondents ages 18+ who had a body mass index (BMI) of 30.0 or above. BMI was calculated using respondent's self-reported weight and height. category: Health Topic subcategory: Obese/Overweight attributeTypes: - estimate - CI_LB95 - CI_UB95 - population - indicator_type attributeLabels: - Obese (BMI ≥ 30) (18+) - '-' - '-' - '-' - indicator_type geographies: - geoId: '6' geoName: California geoTypeId: STATE attributes: - '0.248' - '0.241' - '0.255' - '27796500' - '2' isSuppressed: false suppressionReason: '400': description: Returned when geoType and geoIds are empty components: securitySchemes: apiKeyHeader: type: apiKey name: Ocp-Apim-Subscription-Key in: header apiKeyQuery: type: apiKey name: subscription-key in: query security: - apiKeyHeader: [ ] - apiKeyQuery: [ ]