hmda.json

{
	"basePath": "https://api.consumerfinance.gov:443",
	"apiVersion": "1.0",
	"swaggerVersion": "1.2",
	"resourcePath": "/data/hmda",
	"produces": 
	[
		"application/json",
		"application/xml",
		"text/javascript"
	],

	"models": 
	{
		"QueryResponse": 
		{
			"description": "Response to a slice query.",
			"properties": 
			{
				"size": 
				{
					"type": "integer"
				},

				"total": 
				{
					"type": "integer"
				}
			},

			"id": "QueryResponse",
			"required": 
			[
				"total",
				"size"
			]
		}
	},

	"apis": 
	[
		{
			"path": "/data/hmda",
			"operations": 
			[
				{
					"method": "GET",
					"nickname": "getDatasetHmda",
					"summary": "Get metadata for this dataset.",
					"parameters": 
					[
						
					]
				}
			]
		},

		{
			"path": "/data/hmda/concept/{concept}",
			"operations": 
			[
				{
					"method": "GET",
					"nickname": "getConceptHmda",
					"summary": "Get information about a particular concept in this dataset.",
					"parameters": 
					[
						{
							"required": true,
							"allowableValues": 
							{
								"valueType": "LIST",
								"values": 
								[
									"action_taken",
									"agency_code",
									"applicant_ethnicity",
									"applicant_income_000s",
									"applicant_race_1",
									"applicant_race_2",
									"applicant_race_3",
									"applicant_race_4",
									"applicant_race_5",
									"applicant_sex",
									"application_date_indicator",
									"as_of_year",
									"census_tract_number",
									"co_applicant_ethnicity",
									"co_applicant_race_1",
									"co_applicant_race_2",
									"co_applicant_race_3",
									"co_applicant_race_4",
									"co_applicant_race_5",
									"co_applicant_sex",
									"county_code",
									"denial_reason",
									"denial_reason_1",
									"denial_reason_2",
									"denial_reason_3",
									"edit_status",
									"ethnicity",
									"fips",
									"hoepa_status",
									"hud_median_family_income",
									"lien_status",
									"loan_amount_000s",
									"loan_purpose",
									"loan_type",
									"minority_population",
									"msamd",
									"number_of_1_to_4_family_units",
									"number_of_owner_occupied_units",
									"owner_occupancy",
									"population",
									"preapproval",
									"property_type",
									"purchaser_type",
									"race",
									"rate_spread",
									"respondent_id",
									"sequence_number",
									"sex",
									"state_code",
									"tract_to_msamd_income"
								]
							},

							"paramType": "path",
							"description": "Name of concept",
							"dataType": "string",
							"name": "concept"
						}
					]
				}
			]
		},

		{
			"path": "/data/hmda/slice/{slice}",
			"operations": 
			[
				{
					"method": "GET",
					"produces": 
					[
						"application/json",
						"application/xml",
						"text/javascript",
						"text/csv"
					],

					"nickname": "querySliceHmda",
					"type": "QueryResponse",
					"summary": "Query a slice in this dataset.",
					"parameters": 
					[
						{
							"required": true,
							"allowableValues": 
							{
								"valueType": "LIST",
								"values": 
								[
									"application_groups",
									"application_groups_by_state",
									"census_tracts",
									"hmda_lar",
									"institutions"
								]
							},

							"paramType": "path",
							"description": "Name of slice",
							"dataType": "string",
							"name": "slice"
						},

						{
							"required": false,
							"paramType": "query",
							"description": "Fields to return, separated by commas.",
							"dataType": "string",
							"name": "$select"
						},

						{
							"required": false,
							"paramType": "query",
							"description": "Conditions to search for in the slice, in SQL WHERE style.",
							"dataType": "string",
							"name": "$where"
						},

						{
							"required": false,
							"paramType": "query",
							"description": "Fields to group by, summarizing the data, separated by commas.",
							"dataType": "string",
							"name": "$group"
						},

						{
							"required": false,
							"paramType": "query",
							"description": "Number of records to return, 100 by default. Enter 0 for no limit.",
							"dataType": "integer",
							"name": "$limit"
						},

						{
							"required": false,
							"paramType": "query",
							"description": "Number of records to skip.",
							"dataType": "integer",
							"name": "$offset"
						},

						{
							"required": false,
							"paramType": "query",
							"description": "Fields to order by, separated by commas. ASC and DESC can be used to modify the order.",
							"dataType": "string",
							"name": "$orderBy"
						},

						{
							"required": false,
							"paramType": "query",
							"description": "JavaScript callback to invoke. Only useful with JSONP requests.",
							"dataType": "string",
							"name": "$callback"
						}
					]
				}
			]
		},

		{
			"path": "/data/hmda/slice/{slice}/metadata",
			"operations": 
			[
				{
					"method": "GET",
					"nickname": "getSliceMetadataHmda",
					"summary": "Get the metadata for a slice in this dataset.",
					"parameters": 
					[
						{
							"required": true,
							"allowableValues": 
							{
								"valueType": "LIST",
								"values": 
								[
									"application_groups",
									"application_groups_by_state",
									"census_tracts",
									"hmda_lar",
									"institutions"
								]
							},

							"paramType": "path",
							"description": "Name of slice",
							"dataType": "string",
							"name": "slice"
						}
					]
				}
			]
		}
	]
}