developer-api-x7e-schemas.md
APIs.io API
total
integer · max: 1000000 · required
Total matching items across all pages.
page
integer · max: 1000000 · required
limit
integer · max: 1000 · required
pages
integer · max: 1000000 · required
Total number of pages.
query
object
The effective query parameters, echoed back.
type
string · maxLength: 1024 · required
Link/relationship type (e.g. Documentation, Website, GitHub, Pricing).
url
string · uri · maxLength: 2048 · required
title
string · maxLength: 1024
string · enum · maxLength: 1024 Enum values: Documentation
OpenAPI
JSONSchema
JSONStructure
JSONLD
Example
GettingStarted
APIReference
show 40 more
The type of an artifact. Open enumeration — the catalog carries ~50 types; the most common are listed here. Unknown values are allowed.
Example: OpenAPI
type
ArtifactType · enum · maxLength: 1024 · required
The type of an artifact. Open enumeration — the catalog carries ~50 types; the most common are listed here. Unknown values are allowed.
Enum values: Documentation
OpenAPI
JSONSchema
JSONStructure
JSONLD
Example
GettingStarted
APIReference
show 40 more
Example: OpenAPI
url
string · uri · maxLength: 2048 · required
Reference to the artifact.
id
string · maxLength: 1024
Stable artifact id, aid::type::n.
Example: twilio:twilio-accounts-api::OpenAPI::0
name
string · maxLength: 1024
Optional human label for the artifact.
aid
string · maxLength: 1024
aid of the owning API.
provider_slug
string · maxLength: 1024
provider_name
string · maxLength: 1024
content
string · maxLength: 20000
Inlined artifact body. Present only when include=content.
content_type
string · maxLength: 20000
Media type of the inlined content (e.g. application/yaml).
aid
string · maxLength: 1024 · required
name
string · maxLength: 1024 · required
provider_slug
string · maxLength: 1024 · required
description
string · maxLength: 20000
provider_name
string · maxLength: 1024
baseURL
string · uri · maxLength: 2048
humanURL
string · uri · maxLength: 2048
Human-facing documentation entry point.
tags
string[] · maxItems: 1000
Tag names in Title Case (e.g. Messaging, Authentication).
Example: ["Messaging","Authentication"]
properties
Artifact[] · maxItems: 1000
The API's artifacts.
sibling_apis
object[] · maxItems: 1000
Other APIs published by the same provider.
overview
string · maxLength: 1024
Narrative overview (markdown).
slug
string · maxLength: 1024 · required
name
string · maxLength: 1024 · required
description
string · maxLength: 20000
api_count
integer · max: 1000
image
string · uri · maxLength: 2048
created
string · date · maxLength: 10
common
Link[] · maxItems: 1000
Provider-wide links (Website, Docs, Pricing, GitHub, social, …).
apis
object[] · maxItems: 1000
Summary list of the provider's APIs.
tags
string[] · maxItems: 1000
Tag names in Title Case (e.g. Messaging, Authentication).
Example: ["Messaging","Authentication"]
score
ProviderScore
A provider's rating, rubric v0.3.
slug
string · maxLength: 1024
name
string · maxLength: 1024
slug
string · maxLength: 1024 · required
name
string · maxLength: 1024 · required
composite
number · max: 1000000000
Composite ranking score.
band
string · enum · maxLength: 1024
Enum values: strong
healthy
stale
weak
frequency
number · max: 1000000000
breadth
number · max: 1000000000
quality_lift
number · max: 1000000000
provider_count
integer · max: 1000
api_count
integer · max: 1000
variants
string[] · maxItems: 1000
neighbors
TagRef[] · maxItems: 1000
Related tags.
providers
Provider[] · maxItems: 1000
apis
object[] · maxItems: 1000
meta
Meta · required
Pagination and echoed-query metadata for collection responses.
data
Provider[] · maxItems: 1000 · required
meta
Meta · required
Pagination and echoed-query metadata for collection responses.
data
Api[] · maxItems: 1000 · required
meta
Meta · required
Pagination and echoed-query metadata for collection responses.
data
Tag[] · maxItems: 1000 · required
meta
Meta · required
Pagination and echoed-query metadata for collection responses.
data
Artifact[] · maxItems: 1000 · required
meta
object · required
Pagination and echoed-query metadata for collection responses.
data
array · maxItems: 1000 · required
type
string · uri · maxLength: 2048 · required
A URI identifying the problem type; dereferences to human-readable docs.
Example: https://apis.io/problems/invalid-parameter
Default: about:blank
title
string · maxLength: 1024 · required
A short, human-readable summary of the problem type.
Example: Invalid parameter
status
integer · min: 100 · max: 599 · required
The HTTP status code, repeated for convenience.
Example: 400
detail
string · maxLength: 20000
A human-readable explanation specific to this occurrence.
instance
string · uri-reference · maxLength: 2048
A URI reference identifying the specific occurrence (typically the request path).
parameter
string · maxLength: 1024
Extension member — the offending query/path parameter, when applicable.
string · enum · maxLength: 1024 Enum values: exemplar
strong
developing
thin
minimal
Rating band derived from the composite score.
string · enum · maxLength: 1024 Enum values: rising
flat
falling
Week-over-week movement in composite score (±5 thresholds).
string · enum · maxLength: 1024 Enum values: discoverability
contract_quality
governance
operational_transparency
developer_ergonomics
commercial_clarity
One of the six rating facets.
discoverability
number · min: 0 · max: 100
Discoverability facet score (weight 0.10).
contract_quality
number · min: 0 · max: 100
Contract Quality facet score (weight 0.25).
governance
number · min: 0 · max: 100
Governance facet score (weight 0.12).
operational_transparency
number · min: 0 · max: 100
Operational Transparency facet score (weight 0.13).
developer_ergonomics
number · min: 0 · max: 100
Developer Ergonomics facet score (weight 0.20).
commercial_clarity
number · min: 0 · max: 100
Commercial Clarity facet score (weight 0.20).
composite
number · min: 0 · max: 100 · required
Weighted composite of the six facets.
Example: 66.3
band
Band · enum · maxLength: 1024 · required
Rating band derived from the composite score.
Enum values: exemplar
strong
developing
thin
minimal
trend
Trend · enum · maxLength: 1024
Week-over-week movement in composite score (±5 thresholds).
Enum values: rising
flat
falling
delta
number · max: 1000000000
Composite change since the previous snapshot.
Example: 0
previous_composite
number · min: 0 · max: 100
scored_at
string · date · maxLength: 10
schema_version
string · maxLength: 1024
facets
Facets
The six facet scores, each 0–100.
provider_slug
string · maxLength: 1024 · required
composite
number · min: 0 · max: 100 · required
band
Band · enum · maxLength: 1024 · required
Rating band derived from the composite score.
Enum values: exemplar
strong
developing
thin
minimal
rank
integer · max: 2147483647
1-based position in the filtered, score-sorted list.
provider_name
string · maxLength: 1024
trend
Trend · enum · maxLength: 1024
Week-over-week movement in composite score (±5 thresholds).
Enum values: rising
flat
falling
facets
Facets
The six facet scores, each 0–100.
meta
Meta · required
Pagination and echoed-query metadata for collection responses.
data
RatingEntry[] · maxItems: 1000 · required
schema_version
string · maxLength: 1024
bands
object[] · maxItems: 1000
facets
object[] · maxItems: 1000
trending
object
slug
string · maxLength: 1024 · required
name
string · maxLength: 1024 · required
description
string · maxLength: 20000
api_count
integer · max: 1000
image
string · uri · maxLength: 2048
score_band
Band · enum · maxLength: 1024
Rating band derived from the composite score.
Enum values: exemplar
strong
developing
thin
minimal
score_composite
number · min: 0 · max: 100
slug
string · maxLength: 1024 · required
name
string · maxLength: 1024 · required
short
string · maxLength: 1024
One-line summary.
description
string · maxLength: 20000
aliases
string[] · maxItems: 1000
provider_count
integer · max: 1000
api_count
integer · max: 1000
providers
RankedProvider[] · maxItems: 1000
Member providers, ranked by score. Returned on the single-industry endpoint; omitted from list responses by default.
slug
string · maxLength: 1024 · required
name
string · maxLength: 1024 · required
short
string · maxLength: 1024
One-line summary.
description
string · maxLength: 20000
aliases
string[] · maxItems: 1000
name_patterns
string[] · maxItems: 1000
Country/nationality strings used to infer regional membership.
provider_count
integer · max: 1000
api_count
integer · max: 1000
providers
RankedProvider[] · maxItems: 1000
Member providers, ranked by score. Returned on the single-region endpoint; omitted from list responses by default.
meta
Meta · required
Pagination and echoed-query metadata for collection responses.
data
Industry[] · maxItems: 1000 · required
meta
Meta · required
Pagination and echoed-query metadata for collection responses.
data
Region[] · maxItems: 1000 · required
slug
string · maxLength: 1024 · required
name
string · maxLength: 1024 · required
short
string · maxLength: 1024
One-line summary.
description
string · maxLength: 20000
aliases
string[] · maxItems: 1000
area_url
string · uri · maxLength: 2048
The area's dedicated site.
Example: https://authentication.apievangelist.com
area_host
string · maxLength: 1024
icon
string · maxLength: 1024
provider_count
integer · max: 1000
api_count
integer · max: 1000
providers
RankedProvider[] · maxItems: 1000
Member providers, ranked by score. Returned on the single-area endpoint; omitted from list responses by default.
meta
Meta · required
Pagination and echoed-query metadata for collection responses.
data
Area[] · maxItems: 1000 · required