api.cdnjs.comAPI Documentation - cdnjs - The #1 free and open source CDN built to make life easier for developers

Libraries API GitHub Status Home API Documentation cdnjs provides a simple API to allow anyone to quickly query the libraries we have on the CDN. We provide two main endpoints, the libraries endpoint which allows anyone to search through the full set of libraries we offer, and the libraries/:library endpoint which allows for detailed data to be ascertained for a specific library. Endpoints Browsing all libraries on cdnjs Getting a specific library on cdnjs Getting a specific version for a library on cdnjs Fetch details about the cdnjs file extension whitelist Fetch basic statistics for cdnjs Error responses from the cdnjs API Browsing all libraries on cdnjs The /libraries endpoint will return a JSON object with three top-level properties. This API endpoint can also be used to search cdnjs for libraries, by making use of the optional search URL query parameter. The cache lifetime on this endpoint is six hours. Query Parameters Parameter Type Required Description search string optional The value to use when searching the libraries index on cdnjs. Libraries will not be ranked by search relevance when they are returned, they will be ranked using the same ranking as when no search query is provided. This ranking is done by Algolia and is primarily based on the number of stars each library’s associated GitHub repo has. fields comma-separated string optional Provide a comma-separated string of fields to return in each library object from the cdnjs Algolia index. name and latest will always be present in every object. Any field requested that does not exist will be included in each object with a null value. Currently, the following fields (case-sensitive) are published in the Algolia index for each library and can be requested via this parameter: filename , description , version , keywords , alternativeNames , fileType , github , objectID , license , homepage , repository , author , originalName , sri . The available fields are based on the SearchEntry structure in our tools repo . search_fields comma-separated string optional Provide a comma-separated string of fields to be considered when searching for a given search query parameter. Not all fields are supported for this, any unsupported fields given will be silently ignored. Currently, the following fields (case-sensitive) are supported: name , alternativeNames , github.​repo , description , keywords , filename , repositories.​url , github.​user , maintainers.​name . The supported fields are controlled by our Algolia settings and are mirrored in the API server libraries route logic . limit integer optional Limit the number of library objects that are returned in the results array. This value will be reflected in the total top-level property, but the available property will return the full number with no limit applied. output string optional Use the output value human to receive the JSON results in pretty print format, presented on a HTML page. JSON Response Property Type Description results arrayobject This property will contain an object for every library that cdnjs has available. results[].name string This will be the full name of the library, as stored on cdnjs. results[].latest string This will be the URL of the default file on the latest version of the library. It is important to note that this URL is based on the latest version number of the library and the default file name configured, there is no validation in place to ensure that this URL will actually serve a valid asset. results[].filename optional string The will be the name of the default file for the library. There is no validation that this file actually exists in each version of the library. results[].description optional string The description of the library if it has been provided in the cdnjs package JSON file. results[].version optional string The latest version of the library that is available on cdnjs. results[].keywords optional nullable arraystring An array of keywords provided in the cdnjs package JSON for the library. results[].alternativeNames optional arraystring An array of other names that might be used for the library. These cannot be substituted for the actual library name when navigating the cdnjs API and website. results[].fileType optional string The file type (extension) for the default file defined for the library in the cdnjs package JSON. results[].github optional nullable object Some meta data from the relevant GitHub repository for the library, if available and configured in the cdnjs package JSON for the library. results[].github.user optional string The username or organisation name for the repository on GitHub. results[].github.repo optional string The name of the repository on GitHub. The full repository name can be constructed in the form user/repo . results[].github.stargazers_count optional integer The number of stars that the repository has on GitHub. results[].github.forks optional integer The number of forks the repository currently has (at time of indexing) on GitHub. results[].github.subscribers_count optional integer The number of users on GitHub who are watching the repository. results[].objectID optional string The ID used internally within Algolia to track this entry, this will be the name of the library as seen on cdnjs. results[].license optional string The license defined for the library on cdnjs, as a string. If the library has a custom license, it may not be shown here. results[].homepage optional string A link to the homepage of the package, if one is defined in the cdnjs package JSON file. Normally, this is either the package repository or the package website. results[].repository optional nullable object The repository for the library, if known, in standard repository format. results[].repository.type optional string The type of repository for the library, normally git . results[].repository.url optional string The url for repository associated with the library, if provided in the library’s cdnjs package JSON file. results[].author optional string The attributed author for the library, as defined in the cdnjs package JSON file for this library. results[].originalName optional string If the library on cdnjs was every renamed, this value will contain the original name for this library. If it hasn’t been renamed, this value will match the current name. results[].sri optional string The SRI hash value for the file provided in the latest property, if it exists and is valid (i.e. if the SRI hash could be calculated for it). total integer The total number of libraries returned in the request. available integer If a limit query parameter is given, this will be the total number of libraries available if no limit is given. If no limit parameter is given, this will match the total property. This endpoint is directly powered by our Algolia index, the same one that is used on this website for the search box at the top and on the Libraries page . Example Requests https://api.cdnjs.com/libraries Raw Formatted {"results":[{"name":"vue","latest":"https://cdnjs.cloudflare.com/ajax/libs/vue/2.6.11/vue.min.js"},{"name":"react","latest":"https://cdnjs.cloudflare.com/ajax/libs/react/16.13.1/umd/react.production.min.js"},{"name":"react-dom","latest":"https://cdnjs.cloudflare.com/ajax/libs/react-dom/16.13.1/umd/react-dom.production.min.js"},{"name":"react-is","latest":"https://cdnjs.cloudflare.com/ajax/libs/react-is/16.13.1/umd/react-is.production.min.js"},{"name":"twitter-bootstrap","latest":"https://cdnjs.cloudflare.com/ajax/libs/twitter-bootstrap/4.4.0/js/bootstrap.min.js"},{"name":"d3","latest":"https://cdnjs.cloudflare.com/ajax/libs/d3/5.16.0/d3.min.js"},{"name":"axios","latest":"https://cdnjs.cloudflare.com/ajax/libs/axios/0.19.2/axios.min.js"},{"name":"animate.css","latest":"https://cdnjs.cloudflare.com/ajax/libs/animate.css/4.0.0/animate.min.css"},{"name":"font-awesome","latest":"https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.13.0/css/all.min.css"}, "..."],"total":3606,"available":3606} Example...