APIs.io API

APIs

Individual APIs, each owned by a provider and described by artifacts.

List the APIs published by a provider.

/providers/{slug}/apis

Returns a page of the APIs owned by one provider, optionally filtered by tags and required artifact types. Pass include=content to inline artifact bodies.

List the APIs published by a provider. › path Parameters

slug string · maxLength: 1024 · required

Provider slug (e.g. twilio).

List the APIs published by a provider. › query Parameters

tags string[] · maxItems: 1000 · style: form

Comma-separated tags to filter by. Tag names are Title Case (e.g. Messaging); lowercase slugs (e.g. messaging) are also accepted.

match string · enum · maxLength: 1024

Whether results must match any (default) or all of the supplied tags.

Enum values: any

all

Default: any

artifact_types ArtifactType[] · maxItems: 1000 · style: form

Comma-separated artifact types. Filters which artifacts are returned and (on list endpoints) which APIs qualify.

Enum values: Documentation

OpenAPI

JSONSchema

JSONStructure

JSONLD

Example

GettingStarted

APIReference

show 40 more

include string[] · maxItems: 1000 · style: form

Extra data to embed. content fetches and inlines artifact bodies.

Enum values: content

fields string[] · maxItems: 1000 · style: form

Sparse fieldset — comma-separated property names to return.

page integer · min: 1 · max: 1000000

1-based page number.

Default: 1

limit integer · min: 1 · max: 100

Items per page.

Default: 25

List the APIs published by a provider. › Responses

200404

A page of the provider's APIs.

ApiList

meta Meta · required

Pagination and echoed-query metadata for collection responses.

data Api[] · maxItems: 1000 · required

List and filter APIs across the network.

GET https://apis.io/api/v1

/apis

The core cross-provider discovery endpoint. Filter by free text, one or many tags (match=any|all), one or many providers, and/or the artifact types an API must publish. Use artifact_types together with fields=...,properties to return only the artifacts you want.

List and filter APIs across the network. › query Parameters

q string · maxLength: 1024

Free-text query over name and description (and tags where applicable).

tags string[] · maxItems: 1000 · style: form

Comma-separated tags to filter by. Tag names are Title Case (e.g. Messaging); lowercase slugs (e.g. messaging) are also accepted.

match string · enum · maxLength: 1024

Whether results must match any (default) or all of the supplied tags.

Enum values: any

all

Default: any

providers string[] · maxItems: 1000 · style: form

Comma-separated provider slugs to scope results to.

artifact_types ArtifactType[] · maxItems: 1000 · style: form

Comma-separated artifact types. Filters which artifacts are returned and (on list endpoints) which APIs qualify.

Enum values: Documentation

OpenAPI

JSONSchema

JSONStructure

JSONLD

Example

GettingStarted

APIReference

show 40 more

industry string[] · maxItems: 1000 · style: form

Filter by one or more industry slugs.

region string[] · maxItems: 1000 · style: form

Filter by one or more region slugs.

include string[] · maxItems: 1000 · style: form

Extra data to embed. content fetches and inlines artifact bodies.

Enum values: content

band Band[] · maxItems: 1000 · style: form

Filter by one or more rating bands.

Enum values: exemplar

strong

developing

thin

minimal

min_score number · min: 0 · max: 100

Minimum composite score (0–100).

sort string · enum · maxLength: 1024

Enum values: relevance

name

provider

created

score

Default: relevance

fields string[] · maxItems: 1000 · style: form

Sparse fieldset — comma-separated property names to return.

page integer · min: 1 · max: 1000000

1-based page number.

Default: 1

limit integer · min: 1 · max: 100

Items per page.

Default: 25

List and filter APIs across the network. › Responses

200400

A page of APIs.

ApiList

meta Meta · required

Pagination and echoed-query metadata for collection responses.

data Api[] · maxItems: 1000 · required

Get one API by aid.

GET https://apis.io/api/v1

/apis/{aid}

Returns a single API. Pass include=content to inline artifact bodies, optionally narrowed by artifact_types.

Get one API by aid. › path Parameters

aid string · maxLength: 1024 · pattern: ^[^:]+:[^:]+$ · required

API id in provider:api-slug form (e.g. twilio:twilio-accounts-api).

Get one API by aid. › query Parameters

artifact_types ArtifactType[] · maxItems: 1000 · style: form

Comma-separated artifact types. Filters which artifacts are returned and (on list endpoints) which APIs qualify.

Enum values: Documentation

OpenAPI

JSONSchema

JSONStructure

JSONLD

Example

GettingStarted

APIReference

show 40 more

include string[] · maxItems: 1000 · style: form

Extra data to embed. content fetches and inlines artifact bodies.

Enum values: content

fields string[] · maxItems: 1000 · style: form

Sparse fieldset — comma-separated property names to return.

Get one API by aid. › Responses

200404

The API.

Api

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

One API's artifacts, grouped by type.

GET https://apis.io/api/v1

/apis/{aid}/artifacts

Returns a single API's registered artifacts grouped by type with per-type counts. Pass include=content to inline the bodies.

One API's artifacts, grouped by type. › path Parameters

aid string · maxLength: 1024 · pattern: ^[^:]+:[^:]+$ · required

API id in provider:api-slug form (e.g. twilio:twilio-accounts-api).

One API's artifacts, grouped by type. › query Parameters

include string[] · maxItems: 1000 · style: form

Extra data to embed. content fetches and inlines artifact bodies.

Enum values: content

One API's artifacts, grouped by type. › Responses

200404

The API's artifacts.

APIs similar to a given one.

GET https://apis.io/api/v1

/apis/{aid}/similar

Ranks catalog APIs by shared tags — "more like this API."

APIs similar to a given one. › path Parameters

aid string · maxLength: 1024 · pattern: ^[^:]+:[^:]+$ · required

API id in provider:api-slug form (e.g. twilio:twilio-accounts-api).

APIs similar to a given one. › query Parameters

limit integer · min: 1 · max: 100

Items per page.

Default: 25

APIs similar to a given one. › Responses

200404

A page of similar APIs, most similar first.

ApiList

meta Meta · required

Pagination and echoed-query metadata for collection responses.

data Api[] · maxItems: 1000 · required

An API's primary OpenAPI.

GET https://apis.io/api/v1

/openapis/{aid}

Returns the primary OpenAPI reference (url) for one API — the top agent intent. Pass include=content to inline the spec body.

An API's primary OpenAPI. › path Parameters

aid string · maxLength: 1024 · pattern: ^[^:]+:[^:]+$ · required

API id in provider:api-slug form (e.g. twilio:twilio-accounts-api).

An API's primary OpenAPI. › query Parameters

include string[] · maxItems: 1000 · style: form

Extra data to embed. content fetches and inlines artifact bodies.

Enum values: content

An API's primary OpenAPI. › Responses

200404

The API's OpenAPI reference (and body when include=content).

Providers Tags