Back to Apis

Search

developer-api-search.md

latest3.2 KB
Original Source

APIs.io API

APIs.io API

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:

text
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 · maxLength: 1024

The kind of object to return.

Enum values: apis

providers

tags

Default: apis

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

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

composite

api_count

created

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

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

200400

A page of search results of the requested kind.

SearchResults

meta ​object · required

Pagination and echoed-query metadata for collection responses.

data ​array · maxItems: 1000 · required


Artifact TypesInsights