Initial Usage Limits

Before your implementation is approved to go live, it is subject to time and connection limits.

Initially, your API Key is limited to 2,400 requests per day and is programmed to expire 2 months from the day it is requested. When your API Key is near expiration you will receive a notification email. If your implementation is still in development please email us to let us know at api-support@education.com and we will extend your key for another two months.

Once your implementation is finished please email us a link to review it for compliance with our terms of service. Upon approval, both time and connection limits are lifted completely. For more information on getting your implementation approved check out our display requirements.

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

Display Requirements

Please read the following display requirements before beginning development. We’d rather not delay the approval of your implementation because it does not meet our requirements below and others stated in our Terms of Service.

Getting your Implementation Approved
We love to see interesting and creative displays of our information provided that they follow our display requirements, which include clear brand attribution and links back to Education.com. When your implementation is ready to go live, please email a link of the implementation to api-support@education.com and we will review it for compliance with our Terms of Service. For an overview of the branding requirements outlined in our Terms of Service, please read on.

On any page that shows data from Education.com, the following link and language is required:

• Schools provided by linking to http://www.education.com/schoolfinder/ . The language and logo should be displayed, conspicuously and prominently, so it is clear to the user that the school data originates from Education.com. The logo is returned in a data array by the "gbd" function defined as the "logosrc" data element.
• ©Education.com, Inc. 2011.  Use is subject to Terms of Service. The disclaimer text is returned in a data array by the "gbd" function defined as the "disclaimer" data element.

The following links and language are required depending on the use case:

• On listings or search results please add  “See more information on [Neighborhood or City Name] schools from Education.com”. This phrase should be linked to the appropriate city landing page on Education.com as returned in a data array by the "gbd" function defined as the "lsc" data element.
• Where an individual school profile is displayed please add “See more information about [School Name] from Education.com”. This phrase should be linked to the appropriate school landing page on Education.com as returned in a data array by the "gbd" function defined as the "lsp" data element.
• When using the TestRating the TestRating image should link to the corresponding school profile page on Education.com as returned in a data array by the “lsp” data element.
• Where reviews are displayed please add “See more reviews on [School Name] from Education.com”. This phrase should be linked to the appropriate school landing page on Education.com as returned in a data array by the "gbd" function defined as the "lsp" data element.
• If above links are only present on temporary pages (such as property pages), than an additional 'Schools provided by ' linking to http://www.education.com/schoolfinder/ must be included on a static page.

Not Allowed:

• Don’t just build a school search platform. There’s a great site doing that already!
• Don't "nofollow" your links to Education.com
• Don't cache or store information from the API
• Don’t load the API with javascript unless the links to the javascripted pages can be indexed by search engines
• Don't violate the other terms described in the API Terms of Service.

A note for Mobile developers: if you are developing an implementation for a mobile application, please contact us at api-support@education.com before you begin development.

When your implementation is ready to go live, please email us a link to the implementation at api-support@education.com and we will review it for compliance with our Terms of Service.

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

Terms of Use

Thank you for using the Education.com, Inc. (“Education.com”) SchoolFinder API!  By using the SchoolFinder Web Service (the “API” or “Service”), you and the organization listed in your Request for SchoolFinder Web service Access (“You”) accept and agree to be bound by the following terms and conditions (the “Terms of Use”).

a. Applying to Become an Approved Licensee or Customize a Widget
To apply to become an approved licensee, please submit a Request for SchoolFinder Web service Access (“Request”).  You hereby represent and warrant to Education.com that all information included in your Request is true, complete and accurate. To customize a widget, access the SchoolFinder Tools page and copy and paste the resulting code.

b. Service
The API enables approved licensees to obtain and display local school information from Education.com’s SchoolFinder database (“SchoolFinder Data”) on their Websites, subject to the conditions and limitations in these Terms of Use.  The API includes an API client library and associated documentation that allows approved licensees to display results from the Education.com SchoolFinder database in accordance with these Terms of Use.

Education.com reserves the right to approve on a case-by-case basis uses of the API and SchoolFinder Data beyond Website use.  If you would like to use the API for a non-Website implementation, please describe your proposed use in your Request.  Education.com may amend these Terms of Use by addendum for approved non-Website uses.

c. Modifications
Education.com reserves the right to release updated versions of the API and to require You to obtain and use the most recent version.  Education.com may modify the Terms of Use at any time with or without notice, and You can review the most current version of the Terms of Use online at any time at http://www.education.com/schoolfinder/tools/webservice/documentation/?section=terms/ (or other URL as Education.com may decide from time to time).  If a modification is unacceptable to You, You may cancel the Service by stopping your use of the Service. If You continue to use the Service, You will be deemed to have accepted the modifications.

By downloading and installing a SchoolFinder widget, you agree to include all links back to Education.com that are found in the original Widget code. User may edit all inputs to widget and any customization of wrapper outside of the i-frame. For example, user may create a dynamic implementation of the widget on his/her site, however the links must exist outside of i-frame in widget at all times.

Effective upon Education.com’s acceptance of You as an approved licensee pursuant to your Request, and subject to the terms of these Terms of Use (including, without limitation, Section 4 below), Education.com grants You a nontransfereable, nonsublicensable, nonexclusive license during the term set forth in Section 12 below (the “Term”) to: (a) access the API, (b) implement the API on Your Website(s) specified in your Request (“Website”), and (c) display SchoolFinder Data on Your Website(s) for consumers to access such data for their personal use and without charge.

For purposes of these Terms of Use, “Brand Features” shall be defined as the trade names, trademarks, service marks, logos, domain names, and other distinctive brand identifiers of each party, respectively, as secured by such party from time to time.  Subject to the terms of these Terms of Use, Education.com hereby grants to You a nontransfereable, nonsublicensable, nonexclusive license during the Term to display the Education.com Brand Features for the purpose of complying with Your obligations in Section 4(d) and for the purpose of promoting or advertising that You use the API in accordance with the Branding Requirements (the “Branding Requirements”).  You hereby grant to Education.com a nontransferable, nonexclusive license during the Term to use Your Brand Features to advertise that you are using the Service.

In using the Education.com Brand Features You agree that You will not: 

1. Display an Education.com Brand Feature in any manner that implies a relationship or affiliation with, or sponsorship or endorsement by Education.com, other than Your use of the API;
2. Display an Education.com Brand Feature on Your site if contains or displays adult content or promotes illegal activities, gambling or the sale of tobacco or alcohol to persons under twenty-one (21) years of age;
3. Display an Education.com Brand Feature in a manner that is misleading, defamatory, infringing, libelous, disparaging or otherwise objectionable to Education.com; or
4. Remove, distort or alter any element of an Education.com Brand Feature.

You understand and agree that Education.com has the sole discretion to determine whether Your use of the Education.com Brand Features is in accordance with the above restrictions.

1. You agree not to use the API, SchoolFinder Data or Brand Features in any way that is unlawful, or that harms Education.com, its service providers, its suppliers, Your users, or any other person or entity.  Education.com may terminate Your use of the API, SchoolFinder Data or Brand Features if and when Education.com determines Your use is inappropriate.  The licenses granted to You herein are subject to these Terms of Use, including without limitation the following restrictions: 
2. All calls to the API must reference Your unique API Key.
3. You agree to keep Your API Key confidential, and to not share it with any third party, including without limitation subsidiaries, affiliates and partner organizations.  Any third party must submit its own Request and API Key request.
4. You agree to provide the SchoolFinder Data to Your users on an “as is” basis, with disclaimers substantially similar to those set forth in Sections 8 and 9 of these Terms of Use.
5. You may not use the SchoolFinder Data to develop a stand-alone application that substantial re-creates the functionality offered by Education.com's SchoolFinder application, www.education.com/schoolfinder/, or for the purpose of competing directly against the application.
6. You must clearly and conspicuously display the Education.com Brand Features on any Web page that displays or uses the API or SchoolFinder Data, in accordance with the Branding Requirements.
7. You may not, and You may not permit Your users or any third parties to, modify, obscure or disable the SchoolFinder Data that You display on Your site.
8. You agree that You will not display or permit Your users or any third parties to display the SchoolFinder Data in a manner that makes it appear to be available on a third party Website.
9. You may present SchoolFinder Data only on a transactional basis.  You agree not to allow Your users to access SchoolFinder Data in bulk.
10. You may not use or make available the SchoolFinder Data as part of any webpage that allows users to blog, comment, rate, or otherwise provide feedback regarding schools or related information, or as part of a webpage that promotes the availability of this type of service, on any website other than an Education.com website.
11. You must use commercially reasonable efforts to prevent the SchoolFinder Data from being downloaded in bulk or otherwise scraped. Such efforts include "spider traps," "C.A.P.T.C.H.A.," velocity checks, source IP analysis, or other methods that are as effective.
12. You shall not tag links to Education.com hereunder with a “nofollow” attribute or otherwise prevent or discourage search engines from following or scoring the link.
13. You agree to use the API and SchoolFinder Data only for purposes that are legal, proper and in accordance with these Terms of Use.  By way of illustration and not limitation, You agree that You will not and will not permit Your users or other third parties to:
    1. Use or provide data elements from the SchoolFinder Data to enhance the data of any third party, including by generating any derivative works using SchoolFinder Data;
    2. Use the SchoolFinder Data for direct marketing or telemarketing purposes;
    3. Interfere with or disrupt Education.com services or servers or networks connected to Education.com services, or disobey any requirements, procedures, policies or regulations connected to Education.com services; or
    4. Transmit any viruses, worms, defects, Trojan horses or any items of a destructive nature.
14. Unless Education.com has notified You otherwise, You may not keep any copies of the SchoolFinder Data.  Your license to SchoolFinder Data is limited to making direct server calls to Education.com for the SchoolFinder Data and to distributing the SchoolFinder Data to Your users immediately upon receipt by Your server(s). Subject to Education.com's discretion, Education.com may approve You to save limited copies of SchoolFinder Data on a case by case basis, if you pass an Education.com review. To request permission to save copies of SchoolFinder Data, send an email to api-support AT education DOT com.
15. Unless otherwise notified to You by Education.com, You may make up to 2,400 of direct server calls to the API per day.  Education.com reserves the right at its discretion to reduce or increase the maximum number of calls applicable to You immediately and without notice.  In addition, subject to Education.com’s discretion, Education.com may approve You to make an additional number of direct server calls per day if You adhere to these Terms of Use and pass an Education.com audit and review. To request an increase in the maximum number of calls, please send an email to api-support AT education DOT com.
16. You agree to refrain from reproducing, modifying, distributing, decompiling, disassembling or reverse engineering any portion of the API or any SchoolFinder Data.
17. You understand and agree that You are solely responsible for providing user support and any other technical assistance for any implementation of the API in Your Website.  Education.com is under no obligation to provide You or Your users with user support or any other technical assistance.
18. If You become aware that any user of Your implementation of the API is in material breach of these Terms of Use (including, without limitation, the Branding Requirements), You agree to notify Education.com promptly by sending an email to api-support AT education DOT com, and to take prompt, commercially reasonable action at Your expense to remedy the breach.

Education.com’s collection of personal data is governed by Education.com’s Privacy Policy.  You understand and agree that Education.com may access, preserve and disclose Your information if required to do so by law or in a good faith belief that such access or disclosure is reasonably necessary to comply with legal process or to protect the rights, property and/or safety of Education.com, its affiliates or the public.

The relationship between You and Education.com is one of independent contractors.  Nothing in these Terms of Use shall be construed as creating an employer-employee relationship, partnership, joint venture, or any relationship other than an independent contractor relationship.  You may publicly indicate that You have implemented the Education.com API on Your Website(s); however, You agree not to make any other public statements that assert or imply any other relationship with Education.com without Education.com’s prior written consent.

You agree to defend, hold harmless and indemnify Education.com, and its subsidiaries, affiliates, officers, agents, employees, suppliers, licensors and partners from and against any and all claims, losses, damages (actual and consequential), suits, judgments, litigation costs and attorneys’ fees, of every kind and nature arising from or in any way related to (i) Your or Your users’ use of the API, SchoolFinder Data or Brand Features, (i) violation by You of these Terms of Use or other actions connected to Your use of the Service or API.  In such a case, Education.com will provide You with written notice of such claim, suit or other action.

education.com provides the api, SchoolFinder Data and brand features “as is,” “with all faults” and “as available.” the entire risk as to satisfactory quality, performance, accuracy and effort is with you. 

To the maximum extent permitted by applicable law, education.com expressly disclaims any and all warranties or conditions, express, statutory or implied, including without limitation (a) warranties or conditions of merchantability, fitness for a particular purpose, workmanlike effort, accuracy, title, quiet enjoyment, no encumbrances, no liens and noninfringement, (b) warranties or conditions arising through course of dealing or usage of trade and (c) warranties or conditions of uninterrupted or error-free access or use.

in no event will education.com be liable for any damages, including without limitation any direct, indirect, incidental, consequential, special, exemplary or punitive damages arising out of, based on, or resulting from these terms of use or your or your users’ use of the api, SchoolFinder Data, or brand Features, even if education.com has been advised of the possibility of such damages.   the exclusion of damages under this paragraph is independent of your exclusive remedy and survives in the event such remedy fails of its essential purpose or is otherwise deemed unenforceable. these limitations and exclusions apply without regard to whether the damages arise from (a) breach of contract, (b) breach of warranty, (c) negligence or (d) any other cause of action, to the extent such exclusion and limitations are not prohibited by applicable law.

if you do not agree with any part of these terms of use, or you have any dispute or claim against education.com with respect to these terms of use or the api, your sole and exclusive remedy is to discontinue using the api, schoolfinder data and brand features.

For purposes of these Terms of Use, “Intellectual Property Rights” shall mean any and all rights existing from time to time under patent law, copyright law, moral rights law, trade secret law, trademark law, unfair competition law, publicity rights law, privacy rights law, and any and all other proprietary rights, and any and all applications, renewals, extensions and restorations thereof, now or hereafter in force and effect worldwide.  You acknowledge that Education.com or its licensors owns all right, title and interest, including without limitation all Intellectual Property Rights, in and to the API and SchoolFinder Data, and that You shall not acquire any right, title or interest to the API or SchoolFinder Data or any Intellectual Property Rights therein.

1. Term. The term of the Terms of Use shall commence on the date upon which agree to the Terms of Use and shall continue in force thereafter, unless terminated as provided herein.
2. Termination. Education.com may change, suspend or discontinue all or any aspect of the Service, including their availability, at any time, and may suspend or terminate Your use of the Service at any time. This includes, without limitation, the right to set, at Education.com’s own discretion and at any time, a maximum amount of SchoolFinder Data you may access through the Service without Education.com’s prior written consent.
3. In addition, either party may terminate the Terms of Use at any time, for any reason, or for no reason including, but not limited to, if You engage in any action that reflects poorly on Education.com or otherwise disparages or devalues the Education.com Brand Features or Education.com’s reputation or goodwill. If You desire to terminate the Terms of Use, You must remove the Service from Your Site and cease all use of the API.
4. Rejection of Request. Education.com shall have the right, in its sole discretion, to reject any request to use the Service at any time and for any reason, and such rejection shall render null and void the Terms of Use between You and Education.com. Education.com shall not be liable to You for damages of any sort resulting from its decision to reject such a request.
5. Effect of Termination. Upon the termination of the Terms of Use for any reason (i) all license rights granted herein shall terminate and (ii) You shall immediately delete any and SchoolFinder Data and Brand Features and API in the possession or control of You or your affiliates or available on or through any Website controlled by You or your affiliates.
6. Survival. In the event of any termination or expiration of the Terms of Use for any reason, Sections 6 through 13 shall survive termination. Neither party shall be liable to the other party for damages of any sort resulting solely from terminating the Terms of Use in accordance with its terms.
7. Remedies. You acknowledge that Your breach of service/license restrictions contained herein may cause irreparable harm to Education.com, the extent of which would be difficult to ascertain. Accordingly, You agree that, in addition to any other remedies to which Education.com may be legally entitled, Education.com shall have the right to seek immediate injunctive relief in the event of a breach of such sections by You or any of Your officers, employees, consultants or other agents.
8. Third Party Beneficiaries. Nothing in the Terms of Use should be construed to confer any rights to third party beneficiaries.

These Terms of Use and the relationship between You and Education.com shall be governed by the laws of the State of California, without regard to its conflict of law provisions. You and Education.com agree to submit to exclusive jurisdiction of the courts located in Santa Clara County, California, for any and all disputes, claims and actions arising from or in connection with the API, SchoolFinder Data or these Terms of Use.

You represent that You have the authority to bind the organization (if any) identified in Your Request. You agree not to export to any place any part of the API, SchoolFinder Data and Brand Features provided to You or any direct product thereof except in compliance with, and with all licenses and approvals required under, applicable export laws, rules and regulations. If provided to the U.S. government, the API, SchoolFinder Data and Brand Features are provided with the commercial license rights described herein.  If any provision of these Terms of Use is found by a court of competent jurisdiction to be invalid or unenforceable, then the invalid or unenforceable provision will be replaced with a valid, enforceable provision that most closely matches the intent of the original provision and the remainder of these Terms of Use will continue in effect.  The section titles in these Terms of Use are solely for the convenience of the parties and have no legal or contractual significance. Education.com may assign these Terms of Use, in whole or in part, at any time with or without notice to You. You may not transfer, assign, sublicense or delegate the Terms of Use or Your API Key to any third party. Education.com’s failure to exercise or enforce any right or provision of these Terms of Use shall not constitute a waiver of such right or provision.  Except as expressly stated herein, these Terms of Use constitute the entire agreement between You and Education.com with respect to the API and supersede any prior or contemporaneous agreements between You and Education.com.

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.

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

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.

• f = schoolSearch
• key = <your API key>
• sn = sf
• v = 4

• 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

• Education.com School id
• District id
• District lea id
• Nces id

• School name
• address
• city
• zip
• state
• phone number
• school district name
• latitude
• longitude
• website (The school’s website)

• 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)

• 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 within 15 miles of latitude = 35.63 and longitude = -120.68

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

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.  

• f = getTestRating
• key = (your API key)
• sn = sf
• v = 4

• 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”

• 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

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

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

  <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.

• 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

• 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.

• 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

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

<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.

• f = getTeacherStats
• key = (your API key)
• sn = sf
• v = 4

• 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

• 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.

• Student-teacher ratio
• Percentage of first year teachers
• Percentage of fully credential teachers
• Average years teaching
• Average years teaching in the specified district

• Student-Teacher Ratio
• Total # of Full-Time Teachers
• Total Current Expenditures Per Pupil
• Current Expenditures by Category

• 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

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

<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.

• f = getStudentStats
• key = (your API key)
• sn = sf
• v = 4

• 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

• 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”

• 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

• 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

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

<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

• f = getReviews
• key = (your API key)
• sn = sf
• v = 4
• A schoolid such as the nces id or the Education.com id

• 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)

• Count – The number of ratings
• Total 
• Average – Average star rating 
• Review comment

Request

<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

• 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”

• 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”

• 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

<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

• f = getTestRating
• key = (your API key)
• sn = sf
• v = 4

• 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”

• 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

<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>

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.

• sn = sf
• f = gbd
• key = (your API key)
• v = 4

• 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.

• 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.

<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>

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.

• f = system.multiCall
• methods = an array of data service function call parameters
• key = (your API key)
• v = 4

• 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.

• 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

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