Education.com
Try
Brainzy
Try
Plus
Untitled Document

Technical Overview

Getting started with the Education.com API is easy. First, make sure that you are accessing the data service from the same IP address that you indicated in your application for an API key. IP address is the primary mechanism for authenticating calls to our data service. If you are not sure or would like to access the data service from a different IP address please contact us at api-support@education.com.

Data service Versions:
This documentation represents version 4 of the data service. To use previous versions of the data service documentation, see Version 1, Version 2, or Version 3.

How to Call the Data Service:
The API supports requests in REST, JSON, and PHP formats and supports responses in JSON, PHP, and XML formats. All calls to the data service must be properly url-encoded. If calling response in XML format, specify this in API call. In-browser javascript implementations are not supported (neither JSON or JSON-P).

All REST data service calls are made in the following format where parameters are separated using the ampersand symbol “&.” For example:
http://api.education.com/service/service.php?f=schoolSearch&key=<YourAPIKey>&sn=sf&v=4&city=Atlanta&state=ga
Calls using a request format of either json or php need only pass the “resf” variable on the GET query, providing the rest in the request object passed via POST. 
For example:
http://api.education.com/service/service.php?resf=json
The object passed via POST would be:
{"f":"schoolSearch","key":"<apiKey>","sn":"sf","v":"4","city":"Atlanta","state":"ga"}

Data service Calls
Here is a brief overview of our data service calls

schoolSearch
Returns a list of schools and school info in a city, zip code, state, county or other criteria in the search parameters.

getTestRating
Returns the Education.com TestRating for a single school or schools within a city or zip code.

getTestScores
Returns scores on standardized test for a single school, district, or city.

getTeacherStats
Returns teacher statistics for a single school and/or district.

getStudentDiversity
Returns statistics about students for a single school and/or city and/or district.

getStudentStats
Returns statistics about students for a single school and/or city and/or district.

getReviews
Returns a list of the most recent school reviews and parent rating for a single school.

numberOf
Returns the number of schools in a given city and state.

districtSearch
Returns a list of school district profiles in a city, zip code, state, county or other criteria in the search parameters below

Gbd
Returns contextual and branding links to Education.com.

System.multiCall
Allows more than one data service functions to be executed in one request. Responses are returned in the order in which they were requested.

Sample Responses
Below are sample responses in JSON, PHP and XML for the GBD call with the variables

  • Sn = sf
  • F = gbd
  • Key = your key
  • V = 4
JSON Response:
{"logosrc":"http:\/\/www.education.com\/i\/logo\/edu-logo-75x31.jpg","disclaimer":"©Education.com, Inc. 2010.  Use is subject to Terms of  Service.","lsp":"","lsc":"","lsrs":"","lsr":"","ld":null}
PHP Response:
a:7:{s:7:"logosrc";s:50:"http://www.education.com/i/logo/edu-logo-75x31.jpg";s:10:"disclaimer";s:68:"©Education.com,  Inc. 2010.  Use is subject to Terms of  Service.";s:3:"lsp";s:0:"";s:3:"lsc";s:0:"";s:4:"lsrs";s:0:"";s:3:"lsr";s:0:"";s:2:"ld";N;}
XML Response:
<?xml version='1.0'  encoding='utf-8'?><data><logosrc><![CDATA[http://www.education.com/i/logo/edu-logo-75x31.jpg]]></logosrc><disclaimer>< ![CDATA[©Education.com,  Inc. 2010.  Use is subject to Terms of  Service.]]></disclaimer><lsp></lsp><lsc></lsc><lsrs></lsrs><lsr></lsr><ld></ld></data>

Error Messages
If a method fails, it may return any one of the following fault codes along with a fault message. If you are unable to resolve an error please contact us at api-support@education.com with the error message you are receiving and we will provide you with instructions to resolve it

  • faultCode: 1 faultString: an unknown error ocurred
  • faultCode: 2 faultString: invalid parameters
  • faultCode: 3 faultString: invalid api key
  • faultCode: 4 faultString: invalid hostname
  • faultCode: 5 faultString: usage limits exceeded
  • faultCode: 6 faultString: invalid function
  • faultCode: 7 faultString: api key is disabled

Have a question? Need help? Email us at api-support@education.com

Data Service Requests

schoolSearch

This call returns a list of school profiles and related school information for a zip code, city, state, or other criteria in the search parameters. To feature basic school information on your web site this will probably be the only request you need to make to the data service.

All schoolSearch data service calls are made in the following format:
http://api.education.com/service/service.php?f=schoolSearch&key=<YourAPIKey>&sn=sf&v=4&[parameters]

Required Parameters: 
The parameters below must be used in the data service request path
  • f = schoolSearch
  • key = <your API key>
  • sn = sf
  • v = 4

Optional Parameters:
The below parameters are optional and indicate what data you would like to receive and how you would like to receive it.
  • nces_id = The National Center for Education Statistics (NCES) id of the school
  • schoolid = The Education.com id of the school
  • districtid = The internal Education.com id of a school district
  • districtleaid = The NCES Local Education Agency (LEA) id of a school district
  • zip = A five digit US postal code
  • city = The name of a city. Please note cities composed of two words should be formatted with a plus sign e.g. “san+francisco.” City requests must also be accompanied by the corresponding state parameter
  • county = The name of a county
  • state = The two letter abbreviation of a state e.g. South Caroline should be formatted “SC”
  • distance = A distance in miles from a specific latitude/longitude. The suggested value is around 1.5 miles. Please note that distance is required when using latitude and longitude parameters.
  • latitude = A latitude which serves as the center for distance searches. Please note that distance is required when using latitude and longitude parameters.
  • longitude = A longitude which serves as the center for distance searches. Please note that distance is required when using latitude and longitude parameters.
  • minResult = A minimum number of search results to return. The search will be expanded in increments of 0.5 miles until the minresult is reached. minResult is only valid for zip code and latitude/longitude requests.
  • Reqf = The name of the format that the server should expect the request in e.g. “Reqf=json”
  • Resf = The name of the format that the server should return the response in e.g. “Resf=json”

Returns the following school information for the specified parameters

School id Information
  • Education.com School id
  • District id
  • District lea id
  • Nces id
School Location and Contact Information:
  • School name
  • address
  • city
  • zip
  • state
  • phone number
  • school district name
  • latitude
  • longitude
  • website (The school’s website)
Other Details
  • enrollment
  • grades served
  • school type (e.g. public or private)
  • Distance in miles from a lat/long location. Otherwise returns the School ID
  • student teacher ratio
  • url (The URL of the school’s profile page on Education.com)
School Performance
  • AYP (Adequate Yearly Progress) Result - This value represents if the school met AYP as reported by No Child Left Behind legislation. Reported as yes or no, meaning school met or did not meet AYP.
  • AYP Result Year
  • Test rating text
  • Test rating image (small)
  • Test rating image (large)
  • Test rating year

Sample Requests

Request school information for schools in zip code 94526
REST format:
http://api.education.com/service/service.php?f=schoolSearch&key=<YourAPIKey>&sn=sf&v=4&zip=94526
JSON format:
{"f":"schoolSearch","key":"<YourAPIKey>","sn":"sf","v":4",”zip":"94526",”reqf”:”json”}
PHP Format:
a:5:{s:1:"f";s:12:"schoolSearch";s:3:"key";s:13:"<YourAPIKey>";s:2:"sn";s:2:"sf";s:1:"v";s:1:"4";s:3:"zip";s:5:"94526";}

Request school information for schools within 15 miles of latitude = 35.63 and longitude = -120.68

REST format:
http://api.education.com/service/service.php?f=schoolSearch&key=<YourAPIKey>&sn=sf&v=4&latitude=35.63&
longitude=-120.68&distance=15
JSON format:
{"f":"schoolSearch","key":"<YourAPIKey>", ,"sn":"sf","v":”3","latitude": "35.63","longitude":"-120.68", "distance":"15", "reqf": "json"}
PHP format:
a:7:{s:1:"f";s:12:"schoolSearch";s:3:"key";s:13:"<YourAPIKey>";s:2:"sn";s:2:"sf";s:1:"v";s:1:"4";s:8:"latitude";s:5:"35.63";s:9:"longitude";s:7:"-120.68";s:8:"distance";s:2:"15";}

Request information on schools in San Francisco and return the information in either JSON or PHP format

REST format:
http://api.education.com/service/service.php?f=schoolSearch&key=<YourAPIKey>&sn=sf&v=4&city=san+francisco&state=ca&resf=json
http://api.education.com/service/service.php?f=schoolSearch&key=<YourAPIKey>&sn=sf&v=4&city=san+francisco&state=ca&resf=php
JSON format
{"f":"schoolSearch","key":"<YourAPIKey>",,"sn":"sf","v":4","city":"san+sanfrancisco",”state":"ca","reqf":"json","resf":"json"}
PHP Format:
a:6:{s:1:"f";s:12:"schoolSearch";s:3:"key";s:13:"<YourAPIKey>";s:2:"sn";s:2:"sf";s:1:"v";s:1:"4";s:4:"city";s:13:" san+francisco";s:5:"state";s:2:"ca";}


For your convenience please review the XSD schema below if you are requesting a response in xml

<xsd:schema xmlns:xsd="http://www.w3.org/2001/XMLSchema">

<xsd:annotation>

  <xsd:documentation xml:lang="en">
    SchoolFinder WebService Schema 1.0
    Copyright 2008 Education.com. All rights reserved.
  </xsd:documentation>
</xsd:annotation>

<xsd:element name="data" type="DatasetType" />

<xsd:complexType name="DatasetType" >
  <xsd:sequence>
    <xsd:element name="record" type="SchoolSearchType" minOccurs="1" maxOccurs="unbounded"/>

  </xsd:sequence>
</xsd:complexType>

<xsd:complexType name="SchoolSearchType" >
  <xsd:sequence>
    <xsd:element name="school" type="SchoolType" minOccurs="1" maxOccurs="1"/>

  </xsd:sequence>
</xsd:complexType>

<xsd:complexType name="SchoolType" >
  <xsd:sequence>
    <xsd:element name="schoolid" type="xsd:int" minOccurs="1" maxOccurs="1"/>

    <xsd:element name="schoolname" type="xsd:string" minOccurs="1" maxOccurs="1"/>
    <xsd:element name="zip" type="ZipCode5Type" minOccurs="1" maxOccurs="1"/>

    <xsd:element name="address" type="xsd:string" minOccurs="1" maxOccurs="1"/>
    <xsd:element name="city" type="xsd:string" minOccurs="1" maxOccurs="1"/>

    <xsd:element name="districtid" type="xsd:int" minOccurs="1" maxOccurs="1"/>
    <xsd:element name="districtleaid" type="xsd:string" minOccurs="1" maxOccurs="1"/>

    <xsd:element name="AYPresult" nillable="true" minOccurs="1" maxOccurs="1">
    <xsd:simpleType>
        <xsd:restriction base="xsd:string">

            <xsd:enumeration value="yes"/>
            <xsd:enumeration value="no"/>
            <xsd:enumeration value=""/>
        </xsd:restriction>

    </xsd:simpleType>
    </xsd:element>    
    <xsd:element name="distance" type="xsd:decimal" minOccurs="1" maxOccurs="1"/>

    <xsd:element name="enrollment" type="TotalType" minOccurs="1" maxOccurs="1"/>    
    <xsd:element name="gradesserved" type="xsd:string" minOccurs="1" maxOccurs="1"/>

    <xsd:element name="latitude" type="xsd:decimal" minOccurs="1" maxOccurs="1"/>
    <xsd:element name="longitude" type="xsd:decimal" minOccurs="1" maxOccurs="1"/>

    <xsd:element name="phonenumber" type="xsd:string" minOccurs="1" maxOccurs="1"/>
    <xsd:element name="schooldistrictname" type="xsd:string" minOccurs="1" maxOccurs="1"/>

    <xsd:element name="schooltype" type="xsd:string" minOccurs="1" maxOccurs="1"/>
    <xsd:element name="state" type="xsd:string" minOccurs="1" maxOccurs="1"/>

    <xsd:element name="studentteacherratio" type="TotalType" minOccurs="1" maxOccurs="1"/>
    <xsd:element name="website" type="xsd:string" minOccurs="1" maxOccurs="1"/>

    <xsd:element name="ncesid" type="xsd:string" minOccurs="1" maxOccurs="1"/>
    <xsd:element name="url" type="xsd:string" minOccurs="1" maxOccurs="1"/>

    <xsd:element name="testratingtext" type="xsd:string" minOccurs="1" maxOccurs="1"/>
    <xsd:element name="testratingimagesmall" type="xsd:string" minOccurs="1" maxOccurs="1"/>

    <xsd:element name="testratingimagelarge" type="xsd:string" minOccurs="1" maxOccurs="1"/>
    <xsd:element name="testratingyear" type="xsd:int" minOccurs="1" maxOccurs="1"/>

  </xsd:sequence>
</xsd:complexType>

<xsd:simpleType name="ZipCode5Type">
 <xsd:restriction base="xsd:string">
  <xsd:pattern value="\d{5}"/>

 </xsd:restriction>
</xsd:simpleType>

<xsd:complexType name="TotalType" >
  <xsd:sequence>    
    <xsd:element name="total" type="xsd:string" minOccurs="1" maxOccurs="1"/>

  </xsd:sequence>
</xsd:complexType>

</xsd:schema>

Have a question? Need help? Email us at api-support@education.com

getTestRating

Returns the Education.com TestRating for a single school or schools within a city or zip code. The Education.com TestRating is a number ranking (1-10) that provides an overview of a school’s test performance for a given year, by comparing the school’s state standardized test results to those of other schools in the same state.  

All getTestRating data service calls are made in the following format:
http://api.education.com/service/service.php?f=getTestRating&key=<YourAPIKey> &sn=sf&v=4[&parameters]
Required Parameters:
The parameters below must be used in the data service request path
  • f = getTestRating
  • key = (your API key)
  • sn = sf
  • v = 4
Optional Parameters:
The below parameters are optional and indicate what data you would like to receive and how you would like to receive it.

  • schoolid = The Education.com id of the school.
  • nces_id = The National Center for Education Statistics (NCES) id of the school.
  • zip = A five digit US postal code
  • city = The name of a city. Please note cities composed of two words should be formatted with a plus sign e.g. “san+Francisco.” City requests must also be accompanied by the corresponding state parameter
  • state = The two letter abbreviation of a state e.g. South Caroline should be formatted “SC”
  • Reqf = The name of the format that the server should expect the request in e.g. “Reqf=json”
  • Resf = The name of the format that the server should return the response in e.g. “Resf=json”
Returns a school’s TestRating and corresponding data for the specified parameters:
  • School name
  • Test rating text
  • Test rating image (small)
  • Test rating image (large)
  • Test rating year
  • Lsp: A link to the corresponding school profile on Education.com

Example Requests:
Request the Education.com TestRating for the school with NCES ID 061029001146

REST format:
http://api.education.com/service/service.php?f=getTestRating&key=<YourAPIKey>& sn=sf&v=4&nces_id=061029001146
JSON format:
{"f":"getTestRating","key":"<YourAPIKey>","sn":"sf","v":4”,"nces_id":"061029001146"}
PHP format:
a:5:{s:1:"f";s:13:"getTestRating";s:3:"key";s:13:"<YourAPIKey>";s:2:"sn";s:2:"sf";s:1:"v";s:1:"4";s:7:" nces_id";s:12:"061029001146";}

Request the Education.com TestRating for schools in zip code 93446

REST format:
http://api.education.com/service/service.php?f=getTestRating&key=<YourAPIKey>&%20sn=sf&v=4&zip=93446
JSON format:
{"f":"getTestRating","key":"<YourAPIKey>","sn":"sf","v":4”,"zip":"93446",”reqf”:”json”,”resf”:”json”}
PHP format:
a:5:{s:1:"f";s:13:"getTestRating";s:3:"key";s:13:"<YourAPIKey>";s:2:"sn";s:2:"sf";s:1:"v";s:1:"4";s:3:"zip";s:5:"93446";}

Request the Education.com Test Rating for schools in Portland, Oregon and return the information in either JSON or PHP

REST format:
http://api.education.com/service/service.php?f=getTestRating&key=<YourAPIKey>&%20sn=sf&v=4&city=portland&state=OR&resf=php
http://api.education.com/service/service.php?f=getTestRating&key=<YourAPIKey>&%20sn=sf&v=4&city=portland&state=OR&resf=json
JSON format:
{"f":"getTestRating","key":"<YourAPIKey>","sn":"sf","v":4”,"city":"portland",”state”:”or”,”reqf”:”json”}
PHP format:
a:6:{s:1:"f";s:13:"getTestRating";s:3:"key";s:13:"<YourAPIKey>";s:2:"sn";s:2:"sf";s:1:"v";s:1:"4";s:4:"city";s:8:" portland";s:5:"state";s:2:"or";s:4:”resf”;s:4:”json”}

For your convenience please review the XSD schema below if you are requesting a response in xml
  <xsd:schema xmlns:xsd="http://www.w3.org/2001/XMLSchema">

<xsd:annotation>

  <xsd:documentation xml:lang="en">
    SchoolFinder WebService Schema 1.0
    Copyright 2008 Education.com. All rights reserved.
  </xsd:documentation>
</xsd:annotation>

<xsd:element name="data" type="DatasetType" />

<xsd:complexType name="DatasetType" >
  <xsd:sequence>
    <xsd:element name="rating" type="RatingType" minOccurs="1" maxOccurs="1"/>    
  </xsd:sequence>

</xsd:complexType>

<xsd:complexType name="RatingType" >
  <xsd:sequence>
    <xsd:element name="testrating_text" type="xsd:string" minOccurs="1" maxOccurs="1"/>

    <xsd:element name="testrating_image_small" type="xsd:string" minOccurs="1" maxOccurs="1"/>
    <xsd:element name="testrating_image_large" type="xsd:string" minOccurs="1" maxOccurs="1"/>

    <xsd:element name="testrating_year" type="xsd:int" minOccurs="1" maxOccurs="1"/>
    <xsd:element name="lsp" type="xsd:string" minOccurs="1" maxOccurs="1"/>

  </xsd:sequence>
</xsd:complexType>
</xsd:schema>


Have a question? Need help? Email us at api-support@education.com

getTestScores

Returns test scores for a school, district, city or state. Test Scores represent the percentage of students deemed proficient in a subject. Test scores for the city are an average based on the number of schools in a city.

All getTestScores data service calls are made in the following format:
http://api.education.com/service/service.php?f=getTestScores&key=<YourAPIKey> &sn=sf&v=4[&parameters]
Required Perameters:
The parameters below must be used in the data service request path
  • f = getTestScores
  • key = (your API key)
  • sn = sf
  • v = 4
  • One of the following:
    • schoolid = the education.com id of the school
    • nces_id = the nces id of the school
    • districtid = the education.com district id
    • districtleaid = the LEA id of the district
Optional Parameters:
The below parameters are optional and indicate what data you would like to receive and how you would like to receive it.
  • year = the year of the test scores (eg. year = 2011). If year is set to 'all', all years' test data, where available, will be returned. If year parameter is not included, the latest year available will be returned.
  • sd = true (Tells the function to return average test score information about the state that school is in)
  • dd = true (Tells the function to return test score information about the district that the school is in)
  • cd = true (Tells the function to return test score information about the city that the school is in)
  • Reqf = The name of the format that the server should expect the request in e.g. “Reqf=json”
  • Resf = The name of the format that the server should return the response in e.g. “Resf=json”

Test Scores are reported at the grade and subject level. Every state has a specific standardized test(s) e.g. California’s Star Test, but all states assess reading in math in grades 3-10. The test description returned in the API explains what the assessment is, who takes the assessment and how it is scored. Test Scores are reported at the grade and subject level. Every state has a specific standardized test(s) e.g. California’s Star Test, but all states assess reading in math in grades 3-10. The test description returned in the API explains what the assessment is, who takes the assessment and how it is scored. It is recommended to not set the year parameter and only display the latest year's data, given large amount of test score data available per school and district.

Test scores are reported with the corresponding information:
  • Grade level
  • Test name
  • Subject
  • Test score
  • Year
  • Max score – if 100 then test score is reported as a percentage
  • Test description

Sample Requests
Returns scores on standardized tests for the schools with NCES ID 061029001146

REST format:
http://api.education.com/service/service.php?f=getTestScores&key=<YourAPIKey>& sn=sf&v=4&nces_id=061029001146
JSON format:
{"f":"getTestScores","key":"<YourAPIKey>","sn":"sf","v":4”,"nces_id":"061029001146", "reqf":"json"}
PHP format:
a:5:{s:1:"f";s:13:"getTestScores";s:3:"key";s:13:"<YourAPIKey>";s:2:"sn";s:2:"sf";s:1:"v";s:1:"4";s:7:"nces_id"; s:12:"061029001146";}

Returns scores on standardized tests for the schools with NCES ID 061029001146 and the test scores for the district and the state

REST format:
http://api.education.com/service/service.php?f=getTestScores&key=<YourAPIKey>& sn=sf&v=4&nces_id=061029001146&dd=true&sd=true
JSON format:
{"f":"getTestScores","key":"<YourAPIKey>","sn":"sf","v":4”,"nces_id":"061029001146","dd":"true","sd":"true", "reqf":"json"}
PHP format:
a:7:{s:1:"f";s:13:"getTestScores";s:3:"key";s:13:"<YourAPIKey>";s:2:"sn";s:2:"sf";s:1:"v";s:1:"4";s:7:"nces_id"; s:12:"061029001146";s:2:"dd";s:4:"true";s:2:"sd";s:4:"true";}


For your convenience please review the XSD schema below if you are requesting a response in xml

<xsd:schema xmlns:xsd="http://www.w3.org/2001/XMLSchema">

<xsd:annotation>

  <xsd:documentation xml:lang="en">
    SchoolFinder WebService Schema 1.0
    Copyright 2008 Education.com. All rights reserved.
  </xsd:documentation>
</xsd:annotation>

<xsd:element name="data" type="DatasetType" />

<xsd:complexType name="DatasetType" >
  <xsd:sequence>

    <xsd:element name="school" type="TestScoresType" minOccurs="0" maxOccurs="1"/>
    <xsd:element name="district" type="TestScoresType" minOccurs="0" maxOccurs="1"/>
    <xsd:element name="state" type="TestScoresType" minOccurs="0" maxOccurs="1"/>
    <xsd:element name="city" type="CityTestScoresType" minOccurs="0" maxOccurs="1"/>
  </xsd:sequence>
</xsd:complexType>

<xsd:complexType name="TestScoresType" >
  <xsd:sequence>
    <xsd:element name="record" type="TestRecordType" minOccurs="0" maxOccurs="unbounded"/>
  </xsd:sequence>
</xsd:complexType>
<xsd:complexType name="CityTestScoresType" >
  <xsd:sequence>

    <xsd:element name="record" type="CityTestRecordType" minOccurs="1" maxOccurs="unbounded"/>
  </xsd:sequence>
</xsd:complexType>

<xsd:complexType name="TestRecordType" >
  <xsd:sequence>
    <xsd:element name="grade" type="xsd:string" minOccurs="1" maxOccurs="1"/>

    <xsd:element name="testname" type="xsd:string" minOccurs="1" maxOccurs="1"/>
    <xsd:element name="subject" type="xsd:string" minOccurs="1" maxOccurs="1"/>
    <xsd:element name="score" type="PercentageType" minOccurs="1" maxOccurs="1"/>
    <xsd:element name="year" type="xsd:int" minOccurs="1" maxOccurs="1"/>
    <xsd:element name="maxscore" type="TotalType" minOccurs="1" maxOccurs="1"/>
    <xsd:element name="description" type="xsd:string" minOccurs="1" maxOccurs="1"/>

  </xsd:sequence>
</xsd:complexType>

<xsd:complexType name="CityTestRecordType" >
  <xsd:sequence>
    <xsd:element name="grade" type="xsd:string" minOccurs="1" maxOccurs="1"/>
    <xsd:element name="testname" type="xsd:string" minOccurs="1" maxOccurs="1"/>

    <xsd:element name="subject" type="xsd:string" minOccurs="1" maxOccurs="1"/>
    <xsd:element name="value" type="xsd:decimal" minOccurs="1" maxOccurs="1"/>
    <xsd:element name="average" type="xsd:decimal" minOccurs="1" maxOccurs="1"/>
    <xsd:element name="year" type="xsd:int" minOccurs="1" maxOccurs="1"/>
    <xsd:element name="maxscore" type="xsd:decimal" minOccurs="1" maxOccurs="1"/>
    <xsd:element name="description" type="xsd:string" minOccurs="1" maxOccurs="1"/>

  </xsd:sequence>
</xsd:complexType>

<xsd:complexType name="TotalType" >
  <xsd:sequence>    
    <xsd:element name="total" type="xsd:string" minOccurs="1" maxOccurs="1"/>
  </xsd:sequence>
</xsd:complexType>

<xsd:complexType name="PercentageType" >
  <xsd:sequence>    
    <xsd:element name="percentage" type="xsd:string" minOccurs="1" maxOccurs="1"/>
  </xsd:sequence>
</xsd:complexType>


</xsd:schema>

Have a question? Need help? Email us at api-support@education.com

getTeacherStats

Returns teacher statistics for a school, district, or state. Student teacher ratio, district spending are available for all states.

All getTeacherStats data service calls are made in the following format:
http://api.education.com/service/service.php?f=getTeacherStats&key=<YourAPIKey>&sn=sf&v=4&[parameters]
Required Parameters:
The parameters below must be used in the data service request path
  • f = getTeacherStats
  • key = (your API key)
  • sn = sf
  • v = 4
A school or district id:
  • schoolid = the education.com id of the school
  • nces_id = the nces id of the school
  • districtid = the education.com district id;
  • districtleaid = the LEA id of the district
Optional Parameters:
The below parameters are optional and indicate what data you would like to receive and how you would like to receive it.
  • sd = true (Tells the function to return average teacher statistics about the state that school is in)
  • Reqf = The name of the format that the server should expect the request in e.g. “Reqf=json”
  • Resf = The name of the format that the server should return the response in e.g. “Resf=json”

Returns the following information on teacher statistics for a school, district, or state as specified by the parameters and as available. Student teacher ratio, district spending are available for all states.

Stat Names Returned for Schools and for State as available
  • Student-teacher ratio
  • Percentage of first year teachers
  • Percentage of fully credential teachers
  • Average years teaching
  • Average years teaching in the specified district
Stat Names Returned for Districts
  • Student-Teacher Ratio
  • Total # of Full-Time Teachers
  • Total Current Expenditures Per Pupil
  • Current Expenditures by Category
Statistics are reported with the corresponding information
  • Stat type
  • Stat name
  • Year reported
  • Percentage value – left blank if statistic is reported as number value
  • Total value – left blank if statistic is reported as percentage
Sample Requests
Search for teacher statistics for schools with nces id 061029001146 REST format:
http://api.education.com/service/service.php?f=getTeacherStats&key=<YourAPIKey>& sn=sf&v=4&nces_id=061029001146
JSON format:
{"f":"getTeacherStats","key":"<YourAPIKey>","sn":"sf","v":4”,"nces_id":"061029001146", "reqf":"json"}
PHP format:
a:5:{s:1:"f";s:15:"getTeacherStats";s:3:"key";s:13:"<YourAPIKey>";s:2:"sn";s:2:"sf";s:1:"v";s:1:"4";s:7:"nces_id";s:12: "061029001146";}

Search for teacher statistics for a school with nces id 061029001146, for a district with LEAid 0622710 and for the state.

REST format:
http://api.education.com/service/service.php?f=getTeacherStats&key=<YourAPIKey>& sn=sf&v=4&nces_id=061029001146&districtleaid=0622710&sd=true
JSON format:
{"f":"getTeacherStats","key":"<YourAPIKey>","sn":"sf","v":4”,"nces_id":"061029001146","districtleaid":"0622710", "sd":"true”,"reqf":"json"}
PHP format:
a:7:{s:1:"f";s:15:"getTeacherStats";s:3:"key";s:13:"<YourAPIKey>";s:2:"sn";s:2:"sf";s:1:"v";s:1:"4";s:7:"nces_id";s:12: "061029001146";s:13:"districtleaid";s:7:"0622710";s:2:"sd";s:4:"true";}


For your convenience please review the XSD schema below if you are requesting a response in xml

<xsd:schema xmlns:xsd="http://www.w3.org/2001/XMLSchema">

<xsd:annotation>

  <xsd:documentation xml:lang="en">
    SchoolFinder WebService Schema 1.0
    Copyright 2008 Education.com. All rights reserved.
  </xsd:documentation>
</xsd:annotation>

<xsd:element name="data" type="DatasetType" />

<xsd:complexType name="DatasetType" >
  <xsd:sequence>

    <xsd:element name="school" type="RecordSetType" minOccurs="0" maxOccurs="unbounded"/>
    <xsd:element name="district" type="RecordSetType" minOccurs="0" maxOccurs="unbounded"/>
  </xsd:sequence>
</xsd:complexType>


<xsd:complexType name="RecordSetType" >
  <xsd:sequence>

    <xsd:element name="record" type="TeacherStatsType" minOccurs="0" maxOccurs="unbounded"/>
  </xsd:sequence>
</xsd:complexType>

<xsd:complexType name="TeacherStatsType" >
  <xsd:sequence>
    <xsd:element name="stattype" type="xsd:string" minOccurs="1" maxOccurs="1"/>

    <xsd:element name="statname" type="xsd:string" minOccurs="1" maxOccurs="1"/>
    <xsd:element name="year" type="xsd:int" minOccurs="1" maxOccurs="1"/>
    <xsd:element name="value" type="xsd:decimal" minOccurs="1" maxOccurs="1"/>
    <xsd:element name="total" type="xsd:decimal" minOccurs="1" maxOccurs="1"/>
  </xsd:sequence>
</xsd:complexType>

</xsd:schema>

Have a question? Need help? Email us at api-support@education.com

getStudentStats

Returns student statistics for a single school, city, or state. Student statistics for a city is an average based on the number of schools within a city, not the number of students.

All getStudentStats data service calls are made in the following format:
http://api.education.com/service/service.php?f=getStudentStats&key=<YourAPIKey>& sn=sf& v=4 &[parameters]
Required Perameters:
The parameters below must be used in the data service request path
  • f = getStudentStats
  • key = (your API key)
  • sn = sf
  • v = 4
A school id or district id such as:
  • schoolid = the education.com id of the school
  • nces_id = the nces id of the school
  • districtid = the education.com district id
  • districtleaid = the LEA id of the district
Optional Parameters:
The below parameters are optional and indicate what data you would like to receive and how you would like to receive it.

  • zip = A five digit US postal code
  • city = The name of a city. Please note cities composed of two words should be formatted with a plus sign e.g. “san+Francisco.” City requests must also be accompanied by the corresponding state parameter
  • state = The two letter abbreviation of a state e.g. South Caroline should be formatted “SC”
  • sd = true (Tells the function to return average student statistics about the state that school is in)
  • Reqf = The name of the format that the server should expect the request in e.g. “Reqf=json”
  • Resf = The name of the format that the server should return the response in e.g. “Resf=json”
Stat Names returned for school, city, district or state
  • Percentage of student gender: male, female, not reported
  • Percentage of student ethnicity: Asian/Pacific Islander, White, Hispanic, Black,
  • Students eligible for free or reduced-price lunch
  • Percentage English language learners
  • Student enrollment
Each statistic is reported with the following corresponding information:
  • School
  • Stat type
  • Data
  • Stat name
  • Year
  • Percentage value – left blank if statistic is reported as number value
  • Total value – left blank if statistic is reported as percentage

Sample requests:
Search for student statistics for schools with nces id 061029001146

REST format: 
http://api.education.com/service/service.php?f=getStudentStats&key=<YourAPIKey>& sn=sf&v=4&nces_id=061029001146
JSON format:
{"f":"getStudentStats","key":"<YourAPIKey>","sn":"sf","v":4”,"nces_id":"061029001146","reqf":"json"}
PHP format:
a:5:{s:1:"f";s:15:"getStudentStats";s:3:"key";s:13:"<YourAPIKey>";s:2:"sn";s:2:"sf";s:1:"v";s:1:"4";s:7:"nces_id";s:12: "061029001146";}

Search for student statistics for schools with nces id 061029001146 and for the state

REST format: 
http://api.education.com/service/service.php?f=getStudentStats&key=<YourAPIKey>& sn=sf&v=4&nces_id=061029001146&sd=true
JSON format:
{"f":"getStudentStats","key":"<YourAPIKey>","sn":"sf","v":4”,"nces_id":"061029001146","sd":"true","reqf":"json"}
PHP format:
a:6:{s:1:"f";s:15:"getStudentStats";s:3:"key";s:13:"<YourAPIKey>";s:2:"sn";s:2:"sf";s:1:"v";s:1:"4";s:7:"nces_id";s:12: "061029001146";s:2:"sd";s:4:"true";}


For your convenience please review the XSD schema below if you are requesting a response in xml

<xsd:schema xmlns:xsd="http://www.w3.org/2001/XMLSchema">

<xsd:annotation>

  <xsd:documentation xml:lang="en">
    SchoolFinder WebService Schema 1.0
    Copyright 2008 Education.com. All rights reserved.
  </xsd:documentation>
</xsd:annotation>

<xsd:element name="data" type="DatasetType" />

<xsd:complexType name="DatasetType" >
  <xsd:sequence>

    <xsd:element name="school" type="RecordSetType" minOccurs="0" maxOccurs="unbounded"/>
    <xsd:element name="district" type="RecordSetType" minOccurs="0" maxOccurs="unbounded"/>
  </xsd:sequence>
</xsd:complexType>


<xsd:complexType name="RecordSetType" >
  <xsd:sequence>

    <xsd:element name="record" type="TeacherStatsType" minOccurs="0" maxOccurs="unbounded"/>
  </xsd:sequence>
</xsd:complexType>

<xsd:complexType name="TeacherStatsType" >
  <xsd:sequence>
    <xsd:element name="stattype" type="xsd:string" minOccurs="1" maxOccurs="1"/>

    <xsd:element name="statname" type="xsd:string" minOccurs="1" maxOccurs="1"/>
    <xsd:element name="year" type="xsd:int" minOccurs="1" maxOccurs="1"/>
    <xsd:element name="value" type="xsd:decimal" minOccurs="1" maxOccurs="1"/>
    <xsd:element name="total" type="xsd:decimal" minOccurs="1" maxOccurs="1"/>
  </xsd:sequence>
</xsd:complexType>

</xsd:schema>

Have a question? Need help? Email us at api-support@education.com

getReviews

Returns a list of the most recent school reviews and parent rating for a single school

All getReviews data service calls are made in the following format:
http://api.education.com/service/service.php?f=getReviews&key=<YourAPIKey>&sn=sf&v=4&[parameters]
Required Perameters:
The parameters below must be used in the data service request path
  • f = getReviews
  • key = (your API key)
  • sn = sf
  • v = 4
  • A schoolid such as the nces id or the Education.com id
Optional Parameters:
The below parameters are optional and indicate what data you would like to receive and how you would like to receive it.
  • Reqf = The name of the format that the server should expect the request in e.g. “Reqf=json”
  • Resf = The name of the format that the server should return the response in e.g. “Resf=json”

Returns a list of the most recent school reviews and parent ratings. Ratings are based on a 5-star ratings system (1 the lowest; 5 the highest)

Rating/Review
  • Count – The number of ratings
  • Total 
  • Average – Average star rating 
  • Review comment
Sample Request
Returns school reviews and parent rating for a school with school id 063441005677

Request

REST format: JSON format:
{"f":"getReview","key":"<YourAPIKey>","sn":"sf","v":4”,"nces_id":"063441005677","reqf":"json"}
PHP format:
a:5:{s:1:"f";s:9:"getReview";s:3:"key";s:13:"<YourAPIKey>";s:2:"sn";s:2:"sf";s:1:"v";s:1:"4";s:7:"nces_id";s:12: "063441005677";}


For your convenience please review the XSD schema below if you are requesting a response in xml

<xsd:schema xmlns:xsd="http://www.w3.org/2001/XMLSchema">

<xsd:annotation>

  <xsd:documentation xml:lang="en">
    SchoolFinder WebService Schema 1.0
    Copyright 2008 Education.com. All rights reserved.
  </xsd:documentation>
</xsd:annotation>

<xsd:element name="data" type="DatasetType" />

<xsd:complexType name="DatasetType" >
  <xsd:sequence>

    <xsd:element name="rating" type="RatingType" minOccurs="1" maxOccurs="1"/>
    <xsd:element name="review" type="ReviewType" minOccurs="0" maxOccurs="1"/>
  </xsd:sequence>
</xsd:complexType>

<xsd:complexType name="RatingType" >
  <xsd:sequence>

    <xsd:element name="count" type="xsd:int" minOccurs="1" maxOccurs="1"/>
    <xsd:element name="total" type="xsd:int" minOccurs="1" maxOccurs="1"/>
    <xsd:element name="average" type="xsd:int" minOccurs="1" maxOccurs="1"/>
  </xsd:sequence>
</xsd:complexType>

<xsd:complexType name="ReviewType" >

  <xsd:sequence>
    <xsd:element name="record" type="ReviewRecordType" minOccurs="1" maxOccurs="unbounded"/>
  </xsd:sequence>
</xsd:complexType>

<xsd:complexType name="ReviewRecordType" >
  <xsd:sequence>

    <xsd:element name="comment" type="xsd:string" minOccurs="1" maxOccurs="1"/>
  </xsd:sequence>
</xsd:complexType>

</xsd:schema>

Have a question? Need help? Email us at api-support@education.com

numberOf

Returns the total number of schools, the number of schools at each level (elementary, middle, high) and the number of each type of school (public, private, charter) in a given city. Also returns the number of school districts in a city

All numberOf data service calls are made in the following format:
http://api.education.com/service/service.php?f=numberOf&key=<YourAPIKey>& sn=sf&v=4[&parameters]
Required Parameters:
The parameters below must be used in the data service request path
  • f = numberOf
  • key = (your API key)
  • sn = sf
  • v = 4
  • city = The name of a city. Please note cities composed of two words should be formatted with a plus sign e.g. “san+Francisco.” City requests must also be accompanied by the corresponding state parameter
  • state = The two letter abbreviation of a state e.g. South Caroline should be formatted “SC”
Optional Parameters:
The below parameters are optional and indicate what data you would like to receive and how you would like to receive it.
  • Reqf = The name of the format that the server should expect the request in (e.g. “Reqf=json”
  • Resf = The name of the format that the server should return the response in e.g. “Resf=json”
Returns the number of schools in a city by grade level and school type and the number of districts:
  • Total schools
  • Number of schools by grade level (elementary, middle high school)
  • Number of schools by type (public, private, charter)
  • Number of districts in a city
Sample requests
Returns the number of schools in Greenville, SC REST format:
http://api.education.com/service/service.php?f=numberOf&key=<YourAPIKey>& sn=sf&v=4&city=Greenville&state=SC
JSON format: 
"f":"numberOf","key":"<YourAPIKey>","sn":"sf","v":4",”city":"Greenville",”state":"SC"}
PHP format:
a:6:{s:1:"f";s:8:"numberOf";s:3:"key";s:13:"<YourAPIKey>";s:2:"sn";s:2:"sf";s:1:"v";s:1:"4";s:4:"city";s:10:"Greenville"; s:5:"state";s:2:"SC";}


For your convenience please review the XSD schema below if you are requesting a response in xml

<xsd:schema xmlns:xsd="http://www.w3.org/2001/XMLSchema">

<xsd:annotation>

  <xsd:documentation xml:lang="en">
    SchoolFinder WebService Schema 1.0
    Copyright 2008 Education.com. All rights reserved.
  </xsd:documentation>
</xsd:annotation>

<xsd:element name="data" type="DatasetType" />

<xsd:complexType name="DatasetType" >
  <xsd:sequence>

    <xsd:element name="record" type="NumberOfType" minOccurs="0" maxOccurs="unbounded"/>
  </xsd:sequence>
</xsd:complexType>

<xsd:complexType name="NumberOfType" >
  <xsd:sequence>
    <xsd:element name="school" type="xsd:string" minOccurs="0" maxOccurs="1"/>

    <xsd:element name="gradelevel" type="xsd:string" minOccurs="0" maxOccurs="1"/>
    <xsd:element name="schooltype" type="xsd:string" minOccurs="0" maxOccurs="1"/>
    <xsd:element name="district" type="xsd:string" minOccurs="0" maxOccurs="1"/>
    <xsd:element name="total" type="xsd:int" minOccurs="1" maxOccurs="1"/>
  </xsd:sequence>
</xsd:complexType>

</xsd:schema>

Have a question? Need help? Email us at api-support@education.com

districtSearch

Returns a list of school district profiles in a city, zip code, state, county or other criteria in the search parameters below

All districtSearch data service calls are made in the following format:
http://api.education.com/service/service.php?f=districtSearch&key=<YourAPIKey>&sn=sf&v=4[&parameters]
Required Perameters:
The parameters below must be used in the data service request path
  • f = getTestRating
  • key = (your API key)
  • sn = sf
  • v = 4
Optional Parameters:
The below parameters are optional and indicate what data you would like to receive and how you would like to receive it.
  • districtid = The Education.com id of the district.
  • Districtleaid = The LEA id of the district.
  • Districtname = The name of the district.
  • City = The name of a city. Please note cities composed of two words should be formatted with a plus sign e.g. “san+Francisco.” City requests must also be accompanied by the corresponding state parameter
  • State = The two letter abbreviation of a state e.g. South Caroline should be formatted “SC”
  • Reqf = The name of the format that the server should expect the request in e.g. “Reqf=json”
  • Resf = The name of the format that the server should return the response e.g. “Resf=json”
Returns the following information about a school district(s):
  • District id
  • District name
  • Name of the state the district is in
  • District lea id
  • District address
  • Name of the city the district is in
  • Grades served
  • Zip code
  • Phone number

Sample request

Returns information on districts in Greenville, South Carolina
REST format:
http://api.education.com/service/service.php?f=districtSearch&key=<YourAPIKey>& sn=sf&v=4&city=Greenville&state=SC
JSON format:
"f":"districtSearch","key":"<YourAPIKey>","sn":"sf","v":4","city":"greenville","state":"sc"}
PHP format:
a:6:{s:1:"f";s:14:"districtSearch";s:3:"key";s:13:"<YourAPIKey>";s:2:"sn";s:2:"sf";s:1:"v";s:1:"4";s:4:"city";s:10: "Greenville";s:5:"state";s:2:"SC";}


For your convenience please review the XSD schema below if you are requesting a response in xml

<xsd:schema xmlns:xsd="http://www.w3.org/2001/XMLSchema">

<xsd:annotation>

  <xsd:documentation xml:lang="en">
    SchoolFinder WebService Schema 1.0
    Copyright 2008 Education.com. All rights reserved.
  </xsd:documentation>
</xsd:annotation>

<xsd:element name="data" type="DatasetType" />

<xsd:complexType name="DatasetType" >
  <xsd:sequence>

    <xsd:element name="record" type="DistrictSearchType" minOccurs="1" maxOccurs="unbounded"/>
  </xsd:sequence>
</xsd:complexType>

<xsd:complexType name="DistrictSearchType" >
  <xsd:sequence>
    <xsd:element name="district" type="DistrictType" minOccurs="1" maxOccurs="1"/>

  </xsd:sequence>
</xsd:complexType>

<xsd:complexType name="DistrictType" >
  <xsd:sequence>
    <xsd:element name="districtid" type="xsd:int" minOccurs="1" maxOccurs="1"/>
    <xsd:element name="districtname" type="xsd:string" minOccurs="1" maxOccurs="1"/>

    <xsd:element name="state" type="xsd:string" minOccurs="1" maxOccurs="1"/>
    <xsd:element name="districtleaid" type="xsd:string" minOccurs="1" maxOccurs="1"/>
    <xsd:element name="address" type="xsd:string" minOccurs="1" maxOccurs="1"/>
    <xsd:element name="city" type="xsd:string" minOccurs="1" maxOccurs="1"/>
    <xsd:element name="gradesserved" type="xsd:string" minOccurs="1" maxOccurs="1"/>
    <xsd:element name="zip" type="ZipCode5Type" minOccurs="1" maxOccurs="1"/>

    <xsd:element name="phonenumber" type="xsd:string" minOccurs="1" maxOccurs="1"/>
  </xsd:sequence>
</xsd:complexType>

<xsd:simpleType name="ZipCode5Type">
 <xsd:restriction base="xsd:string">
  <xsd:pattern value="\d{5}"/>

 </xsd:restriction>
</xsd:simpleType>

</xsd:schema>

Have a question? Need help? Email us at api-support@education.com

gbd

Returns contextual and branding links to Education.com. Although some links are always required, please refer to our Terms of Service for further clarification on what links need to be displayed based on your chosen implementation.

All gbd data service calls are made in the following format:
http://api.education.com/service/service.php?f=gbd&key=<YourAPIKey>& sn=sf&v=4[&parameters]
Required Parameters:
The parameters below must be used in the data service request path
  • sn = sf
  • f = gbd
  • key = (your API key)
  • v = 4
Optional Parameters:
The below parameters are optional and indicate what data you would like to receive and how you would like to receive it.

  • schoolid = The id of the school.
  • nces_id = The nces id of the school.
  • city = The name of a city. Please note cities composed of two words should be formatted with a plus sign e.g. “san+Francisco.” City requests must also be accompanied by the corresponding state parameter
  • state = The two letter abbreviation of a state e.g. South Caroline should be formatted “SC”
  • districtid = The internal Education.com id of a school district.
Returns the following links:
Please see our Branding Requirements to determine the links appropriate for your implementation.
  • Logosrc: The education.com logo image linking to www.education.com/schoolfinder
  • disclaimer: Disclaimer text
  • lsp: A link to the corresponding school profile on education.com.
  • lsc: A link to school search results page on education.com for the corresponding city and state.
  • lsd: A link to a district profile page when the optional parameter, districtid, is in use.
Sample Request
Returns branding data for school having nces_id= 450231000564
REST format:
http://api.education.com/service/service.php?f=gbd&key=[YourKey]&v=4&nces_id=450231000564
JSON format :
"f":"gbd","key":"<YourAPIKey>","sn":"sf","v":4","nces_id=450231000564"}
PHP format:
a:5:{s:1:"f";s:3:"gbd";s:3:"key";s:13:"<YourAPIKey>";s:2:"sn";s:2:"sf";s:1:"v";s:1:"4";s:7:"nces_id";s:12:"450231000564";}


For your convenience please review the XSD schema below if you are requesting a response in xml

<xsd:schema xmlns:xsd="http://www.w3.org/2001/XMLSchema">

<xsd:annotation>
  <xsd:documentation xml:lang="en">
    SchoolFinder WebService Schema 1.0
    Copyright 2008 Education.com. All rights reserved.
  </xsd:documentation>
</xsd:annotation>

<xsd:element name="data" type="BrandingDataType" />

<xsd:complexType name="BrandingDataType" >
  <xsd:sequence>
    <xsd:element name="logosrc" type="xsd:string" minOccurs="1" maxOccurs="1"/>
    <xsd:element name="disclaimer" type="xsd:string" minOccurs="1" maxOccurs="1"/>
    <xsd:element name="lsp" type="xsd:string" minOccurs="1" maxOccurs="1"/>
    <xsd:element name="lsc" type="xsd:string" minOccurs="1" maxOccurs="1"/>

    <xsd:element name="lsrs" type="xsd:string" minOccurs="1" maxOccurs="1"/>
    <xsd:element name="lsr" type="xsd:string" minOccurs="1" maxOccurs="1"/>
  </xsd:sequence>
</xsd:complexType>

</xsd:schema>

Have a question? Need help? Email us at api-support@education.com

System.multiCall

Allows one or more data service functions to be executed in one request. Responses are returned in the order in which they were requested. This is great method for making your calls to the data service streamlined and efficient.

Required Parameters:
The parameters below must be used in the data service request path
  • f = system.multiCall
  • methods = an array of data service function call parameters
  • key = (your API key)
  • v = 4
Optional Parameters:
The below parameters are optional and can be used to describe how you would like to receive the data
  • fid = a unique identifier for the function being called. This is returned back to the caller and may be used to identify the results of a data service function.
Returns an array of zero or more objects in the following format:
  • methodName: The name of the data service function.
  • methodId: The unique identifier for the function. (set by fid)
  • methodResponse: The response of the function.

Sample request for GBD and getVersion calls

REST Format: JSON Format:
{"f":"system.multiCall","v":4,"methods":[{"f":"gbd","fid":"F1"},{"f":"getVersion","fid":"F2"}]}
PHP Format:
a:3:{s:1:"f";s:16:"system.multiCall";s:1:"v";i:3;s:7:"methods";a:2:{i:0;a:2:{s:1:"f";s:3:"gbd";s:3:"fid";s:2:"F1";}i:1;a:2:{s:1:"f";s:10:"getVersion";s:3:"fid";s:2:"F2";}}}

Have a question? Need help? Email us at api-support@education.com