Back to Apis

Regions

developer-api-regions.md

latest3.1 KB
Original Source

APIs.io API

APIs.io API

Regions

Geographic regions grouping providers across the catalog.


List and filter regions.

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

/regions

The region taxonomy — geographic groupings of providers across the catalog. Filter by free text; sort by provider or API count.

List and filter regions. › query Parameters

q ​string · maxLength: 1024

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

sort ​string · enum · maxLength: 1024

Sort order.

Enum values: provider_count

api_count

name

Default: provider_count

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

200400

List and filter regions.

RegionList

metaMeta · required

Pagination and echoed-query metadata for collection responses.

dataRegion[] · maxItems: 1000 · required


Get one region, with its ranked providers.

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

/regions/{slug}

Returns a single region by slug, including its aliases, name patterns, counts, and the member providers ranked by score.

Get one region, with its ranked providers. › path Parameters

slug ​string · maxLength: 1024 · required

Region slug (e.g. southeast-asia).

Get one region, with its ranked providers. › query Parameters

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

Sparse fieldset — comma-separated property names to return.

Get one region, with its ranked providers. › Responses

200404

Get one region, with its ranked providers.

Region

slug ​string · maxLength: 1024 · required

name ​string · maxLength: 1024 · required

short ​string · maxLength: 1024

One-line summary.

description ​string · maxLength: 20000

aliases ​string[] · maxItems: 1000

name_patterns ​string[] · maxItems: 1000

Country/nationality strings used to infer regional membership.

provider_count ​integer · max: 1000

api_count ​integer · max: 1000

providersRankedProvider[] · maxItems: 1000

Member providers, ranked by score. Returned on the single-region endpoint; omitted from list responses by default.


Top-rated providers in a region.

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

/regions/{slug}/leaders

Returns the highest-composite-scoring member providers of a region.

Top-rated providers in a region. › path Parameters

slug ​string · maxLength: 1024 · required

Region slug (e.g. europe).

Top-rated providers in a region. › query Parameters

limit ​integer · min: 1 · max: 100

Items per page.

Default: 25

Top-rated providers in a region. › Responses

200404

A page of the region's top providers.


IndustriesAreas