Schemas
Meta
totalTotal matching items across all pages.
pagelimitpagesTotal number of pages.
The effective query parameters, echoed back.
Link
typeLink/relationship type (e.g. Documentation
urltitleArtifactType
The type of an artifact. Open enumeration — the catalog carries ~50 types; the most common are listed here. Unknown values are allowed.
Artifact
typeThe type of an artifact. Open enumeration — the catalog carries ~50 types; the most common are listed here. Unknown values are allowed.
urlReference to the artifact.
idStable artifact id, aid::type::n.
nameOptional human label for the artifact.
aidaid of the owning API.
provider_slugprovider_namecontentInlined artifact body. Present only when include=content.
content_typeMedia type of the inlined content (e.g. application/yaml).
Api
aidnameprovider_slugdescriptionprovider_namebaseURLhumanURLHuman-facing documentation entry point.
tagsTag names in Title Case (e.g. Messaging, Authentication).
The API's artifacts.
Other APIs published by the same provider.
overviewNarrative overview (markdown).
Provider
slugnamedescriptionapi_countimagecreatedProvider-wide links (Website, Docs, Pricing, GitHub, social, …).
Summary list of the provider's APIs.
tagsTag names in Title Case (e.g. Messaging, Authentication).
A provider's rating, rubric v0.3.
Tag
slugnamecompositeComposite ranking score.
bandfrequencybreadthquality_liftprovider_countapi_countvariantsRelated tags.
ProviderList
Pagination and echoed-query metadata for collection responses.
ArtifactList
Pagination and echoed-query metadata for collection responses.
SearchResults
Pagination and echoed-query metadata for collection responses.
Problem
typeA URI identifying the problem type; dereferences to human-readable docs.
titleA short, human-readable summary of the problem type.
statusThe HTTP status code, repeated for convenience.
detailA human-readable explanation specific to this occurrence.
instanceA URI reference identifying the specific occurrence (typically the request path).
parameterExtension member — the offending query/path parameter, when applicable.
Band
Rating band derived from the composite score.
Trend
Week-over-week movement in composite score (±5 thresholds).
FacetName
One of the six rating facets.
Facets
discoverabilityDiscoverability facet score (weight 0.10).
contract_qualityContract Quality facet score (weight 0.25).
governanceGovernance facet score (weight 0.12).
operational_transparencyOperational Transparency facet score (weight 0.13).
developer_ergonomicsDeveloper Ergonomics facet score (weight 0.20).
commercial_clarityCommercial Clarity facet score (weight 0.20).
ProviderScore
compositeWeighted composite of the six facets.
bandRating band derived from the composite score.
trendWeek-over-week movement in composite score (±5 thresholds).
deltaComposite change since the previous snapshot.
previous_compositescored_atschema_versionThe six facet scores, each 0–100.
RatingEntry
provider_slugcompositebandRating band derived from the composite score.
RatingList
Pagination and echoed-query metadata for collection responses.
Rubric
schema_versionRankedProvider
slugnamedescriptionapi_countimagescore_bandRating band derived from the composite score.
score_compositeIndustry
slugnameshortOne-line summary.
descriptionaliasesprovider_countapi_countMember providers, ranked by score. Returned on the single-industry endpoint; omitted from list responses by default.
Region
slugnameshortOne-line summary.
descriptionaliasesname_patternsCountry/nationality strings used to infer regional membership.
provider_countapi_countMember providers, ranked by score. Returned on the single-region endpoint; omitted from list responses by default.
IndustryList
Pagination and echoed-query metadata for collection responses.