Search

Unified cross-resource search.

Unified search across apis, providers, tags, and artifacts.

GET

https://apis.io/api/v1

/search

The power endpoint. Choose what kind of object to return with return (apis by default), then constrain with any combination of q, tags (match=any|all), providers, and artifact_types. Use fields for sparse responses and include=content to inline artifacts.

Example — messaging APIs across providers that ship an OpenAPI, returning just the spec and pricing artifacts:

Code
/search?return=apis&tags=Messaging&artifact_types=OpenAPI,Pricing
       &fields=aid,name,provider_slug,properties

Unified search across apis, providers, tags, and artifacts. › query Parameters

return

string · enum

The kind of object to return.

Enum values:

apis

providers

Unified search across apis, providers, tags, and artifacts. › Responses

A page of search results of the requested kind.

Unified search envelope. `data` holds objects of the kind named by `meta.return` (apis | providers | tags | artifacts).

SearchResults

object · required

Pagination and echoed-query metadata for collection responses.

array · required

GET/search

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

Example Responses

{
  "meta": {
    "total": 0,
    "page": 0,
    "limit": 0,
    "pages": 0,
    "query": {},
    "return": "apis"
  },
  "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

Artifact Types

APIs.io API