v1

latestOpenAPI 3.1.02026-08-04253331435.1 KB
Metadata

Get Entity Metadata

Get the metadata for an institution by its entity ID.

Args: entity_id: The unique identifier for the institution

Returns: Dict containing: - overview: Text description of the institution - homepage_url: URL of the institution's homepage - latitude: Latitude coordinate (float or None) - longitude: Longitude coordinate (float or None) - population: Population count (int or None) - students: Number of students in the district (int or None) - teachers: Number of teachers in the district (int or None) - total_schools: Number of schools in the district (int or None) - district_type: The type of school district we have (string or None) - federal_grants: The amount of money the school district is granted yearly by the federal government - state_grants: The amount of money the school district is granted yearly by the state government - local_grants: The amount of money the school district is granted yearly by the local government - interest_expenditure: The amount of money the school district spends yearly on paying interest - operations_expenditure: The amount of money the school district spends yearly on its operations - instructional_expenditure: The amount of money the school district spends yearly on its instructional costs - administration_expenditure: The amount of money the school district spends yearly on administration - phone_number: A phone number to contact the school district - locale: A short description of the area that the school district is in (suburban, urban, rural, town, etc.) - student_and_staff_support_expenditure: The amount of money the school district spends yearly on student and staff support and resources - total_grants: The total amount of grant money the school district receives yearly - total_expenditures: The total amount of money the school district spends yearly across all expenses

Raises: HTTPException: If there's an error retrieving the data

get/api/v3/metadata/{entity_id}

Path parameters

entity_idstring required

Response

Successful Response

object required