APIs

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

List the APIs published by a provider.

GET

https://apis.io/api/v1

/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 · required

Provider slug (e.g. twilio).

List the APIs published by a provider. › query Parameters

tags

string[] · 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

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

Enum values:

any

all

Default: any

artifact_types

ArtifactType[] · 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

include

string[] · style: form

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

Enum values:

content

fields

string[] · style: form

Sparse fieldset — comma-separated property names to return.

page

integer · min: 1

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

A page of the provider's APIs.

ApiList

Meta · required

Pagination and echoed-query metadata for collection responses.

Api[] · required

GET/providers/{slug}/apis

curl https://apis.io/api/v1/providers/:slug/apis

Example Responses

{
  "meta": {
    "total": 0,
    "page": 0,
    "limit": 0,
    "pages": 0,
    "query": {}
  },
  "data": [
    {
      "aid": "twilio:twilio-accounts-api",
      "name": "name",
      "description": "description",
      "provider_slug": "provider_slug",
      "provider_name": "provider_name",
      "baseURL": "https://www.example.com/path/to/resource",
      "humanURL": "https://www.example.com/path/to/resource",
      "tags": [
        "Messaging",
        "Authentication"
      ],
      "properties": [
        {
          "id": "twilio:twilio-accounts-api::OpenAPI::0",
          "type": "OpenAPI",
          "name": "name",
          "url": "https://www.example.com/path/to/resource",
          "aid": "aid",
          "provider_slug": "provider_slug",
          "provider_name": "provider_name",
          "content": "content",
          "content_type": "content_type"
        }
      ],
      "sibling_apis": [
        {
          "name": "name",
          "slug": "slug"
        }
      ],
      "overview": "overview"
    }
  ]
}

json

application/json

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

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

tags

string[] · 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

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

Enum values:

any

all

Default: any

providers

string[] · style: form

Comma-separated provider slugs to scope results to.

artifact_types

ArtifactType[] · 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

industry

string[] · style: form

Filter by one or more industry slugs.

region

string[] · style: form

Filter by one or more region slugs.

include

string[] · style: form

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

Enum values:

content

band

Band[] · 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

Enum values:

relevance

name

provider

created

score

Default: relevance

fields

string[] · style: form

Sparse fieldset — comma-separated property names to return.

page

integer · min: 1

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

A page of APIs.

ApiList

Meta · required

Pagination and echoed-query metadata for collection responses.

Api[] · required

GET/apis

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

Example Responses

{
  "meta": {
    "total": 0,
    "page": 0,
    "limit": 0,
    "pages": 0,
    "query": {}
  },
  "data": [
    {
      "aid": "twilio:twilio-accounts-api",
      "name": "name",
      "description": "description",
      "provider_slug": "provider_slug",
      "provider_name": "provider_name",
      "baseURL": "https://www.example.com/path/to/resource",
      "humanURL": "https://www.example.com/path/to/resource",
      "tags": [
        "Messaging",
        "Authentication"
      ],
      "properties": [
        {
          "id": "twilio:twilio-accounts-api::OpenAPI::0",
          "type": "OpenAPI",
          "name": "name",
          "url": "https://www.example.com/path/to/resource",
          "aid": "aid",
          "provider_slug": "provider_slug",
          "provider_name": "provider_name",
          "content": "content",
          "content_type": "content_type"
        }
      ],
      "sibling_apis": [
        {
          "name": "name",
          "slug": "slug"
        }
      ],
      "overview": "overview"
    }
  ]
}

json

application/json

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 · 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[] · 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

include

string[] · style: form

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

Enum values:

content

fields

string[] · style: form

Sparse fieldset — comma-separated property names to return.

Get one API by aid. › Responses

The API.

An individual API owned by a provider.

Api

aid

string · required

name

string · required

provider_slug

string · required

description

string

provider_name

string

baseURL

string · uri

humanURL

string · uri

Human-facing documentation entry point.

tags

string[]

Tag names in Title Case (e.g. Messaging, Authentication).

Example: ["Messaging","Authentication"]

Artifact[]

The API's artifacts.

object[]

Other APIs published by the same provider.

overview

string

Narrative overview (markdown).

GET/apis/{aid}

curl https://apis.io/api/v1/apis/:aid

Example Responses

{
  "aid": "twilio:twilio-accounts-api",
  "name": "name",
  "description": "description",
  "provider_slug": "provider_slug",
  "provider_name": "provider_name",
  "baseURL": "https://www.example.com/path/to/resource",
  "humanURL": "https://www.example.com/path/to/resource",
  "tags": [
    "Messaging",
    "Authentication"
  ],
  "properties": [
    {
      "id": "twilio:twilio-accounts-api::OpenAPI::0",
      "type": "OpenAPI",
      "name": "name",
      "url": "https://www.example.com/path/to/resource",
      "aid": "aid",
      "provider_slug": "provider_slug",
      "provider_name": "provider_name",
      "content": "content",
      "content_type": "content_type"
    }
  ],
  "sibling_apis": [
    {
      "name": "name",
      "slug": "slug"
    }
  ],
  "overview": "overview"
}

json

application/json

Providers Tags

List the APIs published by a provider.

GET

https://apis.io/api/v1

/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 · required

Provider slug (e.g. twilio).

List the APIs published by a provider. › query Parameters

tags

string[] · 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

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

Enum values:

any

all

Default: any

artifact_types

ArtifactType[] · 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

include

string[] · style: form

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

Enum values:

content

fields

string[] · style: form

Sparse fieldset — comma-separated property names to return.

page

integer · min: 1

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

A page of the provider's APIs.

ApiList

Meta · required

Pagination and echoed-query metadata for collection responses.

Api[] · required

List and filter APIs across the network.

GET

https://apis.io/api/v1

/apis

List and filter APIs across the network. › query Parameters

q

string

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

tags

string[] · 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

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

Enum values:

any

all

Default: any

providers

string[] · style: form

Comma-separated provider slugs to scope results to.

artifact_types

ArtifactType[] · 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

industry

string[] · style: form

Filter by one or more industry slugs.

region

string[] · style: form

Filter by one or more region slugs.

include

string[] · style: form

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

Enum values:

content

band

Band[] · 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

Enum values:

relevance

name

provider

created

score

Default: relevance

fields

string[] · style: form

Sparse fieldset — comma-separated property names to return.

page

integer · min: 1

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

A page of APIs.

ApiList

Meta · required

Pagination and echoed-query metadata for collection responses.

Api[] · 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 · 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[] · 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

include

string[] · style: form

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

Enum values:

content

fields

string[] · style: form

Sparse fieldset — comma-separated property names to return.

Get one API by aid. › Responses

The API.

An individual API owned by a provider.

Api

aid

string · required

name

string · required

provider_slug

string · required

description

string

provider_name

string

baseURL

string · uri

humanURL

string · uri

Human-facing documentation entry point.

tags

string[]

Tag names in Title Case (e.g. Messaging, Authentication).

Example: ["Messaging","Authentication"]

Artifact[]

The API's artifacts.

object[]

Other APIs published by the same provider.

overview

string

Narrative overview (markdown).