Providers

Organizations publishing APIs on the network.

List and filter providers.

GET

https://apis.io/api/v1

/providers

List providers, optionally filtered by free text, tags, or the artifact types they publish.

List and filter providers. › 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

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.

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

max_score

number · min: 0 · max: 100

Maximum composite score (0–100).

trend

Trend · enum

Filter by trend marker.

Week-over-week movement in composite score (±5 thresholds).

Enum values:

rising

flat

falling

facet

FacetName · enum

Facet to apply min_facet against.

One of the six rating facets.

Enum values:

discoverability

contract_quality

governance

operational_transparency

developer_ergonomics

commercial_clarity

min_facet

number · min: 0 · max: 100

Minimum score (0–100) for the facet named by facet.

sort

string · enum

Sort order.

Enum values:

relevance

name

api_count

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 providers. › Responses

A page of providers.

ProviderList

Meta · required

Pagination and echoed-query metadata for collection responses.

Provider[] · required

GET/providers

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

Example Responses

{
  "meta": {
    "total": 0,
    "page": 0,
    "limit": 0,
    "pages": 0,
    "query": {}
  },
  "data": [
    {
      "slug": "twilio",
      "name": "name",
      "description": "description",
      "api_count": 0,
      "image": "https://www.example.com/path/to/resource",
      "created": "2024-08-25",
      "common": [
        {
          "type": "type",
          "url": "https://www.example.com/path/to/resource",
          "title": "title"
        }
      ],
      "apis": [
        {
          "name": "name",
          "slug": "slug",
          "description": "description"
        }
      ],
      "tags": [
        "Messaging",
        "Authentication"
      ],
      "score": {
        "composite": 66.3,
        "band": "exemplar",
        "trend": "rising",
        "delta": 0,
        "previous_composite": 0,
        "scored_at": "2024-08-25",
        "schema_version": "0.3",
        "facets": {
          "discoverability": 0,
          "contract_quality": 0,
          "governance": 0,
          "operational_transparency": 0,
          "developer_ergonomics": 0,
          "commercial_clarity": 0
        }
      }
    }
  ]
}

json

application/json

Get one provider.

GET

https://apis.io/api/v1

/providers/{slug}

Returns a single provider by slug, including its provider-wide links, tags, and a summary list of the APIs it publishes.

Get one provider. › path Parameters

slug

string · required

Provider slug (e.g. twilio).

Get one provider. › query Parameters

fields

string[] · style: form

Sparse fieldset — comma-separated property names to return.

Get one provider. › Responses

The provider.

An organization publishing one or more APIs.

Provider

slug

string · required

name

string · required

description

string

api_count

integer

image

string · uri

created

string · date

Link[]

Provider-wide links (Website, Docs, Pricing, GitHub, social, …).

object[]

Summary list of the provider's APIs.

tags

string[]

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

Example: ["Messaging","Authentication"]

ProviderScore

A provider's rating, rubric v0.3.

GET/providers/{slug}

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

Example Responses

{
  "slug": "twilio",
  "name": "name",
  "description": "description",
  "api_count": 0,
  "image": "https://www.example.com/path/to/resource",
  "created": "2024-08-25",
  "common": [
    {
      "type": "type",
      "url": "https://www.example.com/path/to/resource",
      "title": "title"
    }
  ],
  "apis": [
    {
      "name": "name",
      "slug": "slug",
      "description": "description"
    }
  ],
  "tags": [
    "Messaging",
    "Authentication"
  ],
  "score": {
    "composite": 66.3,
    "band": "exemplar",
    "trend": "rising",
    "delta": 0,
    "previous_composite": 0,
    "scored_at": "2024-08-25",
    "schema_version": "0.3",
    "facets": {
      "discoverability": 0,
      "contract_quality": 0,
      "governance": 0,
      "operational_transparency": 0,
      "developer_ergonomics": 0,
      "commercial_clarity": 0
    }
  }
}

json

application/json

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

APIs

List and filter providers.

GET

https://apis.io/api/v1

/providers

List providers, optionally filtered by free text, tags, or the artifact types they publish.

List and filter providers. › 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

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.

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

max_score

number · min: 0 · max: 100

Maximum composite score (0–100).

trend

Trend · enum

Filter by trend marker.

Week-over-week movement in composite score (±5 thresholds).

Enum values:

rising

flat

falling

facet

FacetName · enum

Facet to apply min_facet against.

One of the six rating facets.

Enum values:

discoverability

contract_quality

governance

operational_transparency

developer_ergonomics

commercial_clarity

min_facet

number · min: 0 · max: 100

Minimum score (0–100) for the facet named by facet.

sort

string · enum

Sort order.

Enum values:

relevance

name

api_count

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 providers. › Responses

A page of providers.

ProviderList

Meta · required

Pagination and echoed-query metadata for collection responses.

Provider[] · required

Get one provider.

GET

https://apis.io/api/v1

/providers/{slug}

Returns a single provider by slug, including its provider-wide links, tags, and a summary list of the APIs it publishes.

Get one provider. › path Parameters

slug

string · required

Provider slug (e.g. twilio).

Get one provider. › query Parameters

fields

string[] · style: form

Sparse fieldset — comma-separated property names to return.

Get one provider. › Responses

The provider.

An organization publishing one or more APIs.

Provider

slug

string · required

name

string · required

description

string

api_count

integer

image

string · uri

created

string · date

Link[]

Provider-wide links (Website, Docs, Pricing, GitHub, social, …).

object[]

Summary list of the provider's APIs.

tags

string[]

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

Example: ["Messaging","Authentication"]

ProviderScore

A provider's rating, rubric v0.3.

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