Skip to content

Ed-Fi-Alliance-OSS/Ed-Fi-API-Specifications

Ed-Fi API Specifications

OpenSSF Scorecard

The Ed-Fi Alliance coordinates and publishes community-led standards and specifications for education and the exchange of education data.

The Ed-Fi Data Standard is the widely adopted, CEDS-aligned, open-source data standard developed by the educational community for the betterment of the community. The Ed-Fi Data Standard serves as the foundation for enabling interoperability among secure data systems and contains a Unifying Data Model designed to capture the meaning and inherent structure in the most important information in the K–12 education enterprise. more information

An Ed-Fi compatible API application creates a REST-based interface for data exchange, where the messages conform to the Ed-Fi Data Standard. The Ed-Fi ODS/API is the Ed-Fi Alliance's production-ready reference implementation of an Ed-Fi API. Any interested party can build an alternate, compatible, application, by adhering to the Open API specifications and guidance provided in this space.

+------------------+      +---------------------+      +-------------------+
|  Data Standard   | ---> |  API Specifications | ---> |   Application     |
+------------------+      +---------------------+      +-------------------+
| - Unifying Data  |      | - Resources API     |      | - Ed-Fi ODS/API   |
|   Model          |      | - Descriptors API   |      | - Ed-Fi DMS       |
| - Extensions     |      | - Management API    |      | - Ed-Fi Admin API |
+------------------+      +---------------------+      +-------------------+

Building an Ed-Fi API Application

What makes an application an "Ed-Fi (compatible) API"? An Ed-Fi API must:

Also see: Tips for Success in Building an Ed-Fi Compatible API

Other Documents

Legal Information

Copyright (c) 2025 Ed-Fi Alliance, LLC and contributors.

Licensed under the Apache License, Version 2.0 (the "License").

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

See NOTICES for additional copyright and license notifications.

About

Documentation and guidance on building Ed-Fi compatible API applications

Resources

License

Code of conduct

Security policy

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors