Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

The Index Indexes API

Approved indie web and small web index sites.

The Index Indexes API is published by The Index on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Indexes. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 2 operations across 2 paths, and defines 6 schemas. It is described by OpenAPI 3.1.0, at version 1.0.

Requests are made against a single base URL, https://theindex.fyi/api.

2 operations 2 paths 6 schemas 2 GET

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
1.0
Base URL
https://theindex.fyi/api
Resource Areas
1

Paths & Operations 2

Across 2 paths, the API surfaces 2 operations — 2 GET. Each is listed below with its method, path, parameters, and response codes.

Indexes 2

Approved indie web and small web index sites.

GET
/indexes
List indexes
listIndexes 4 params → 200429
GET
/indexes/{slug}
Get an index
getIndex 1 param → 200404429

Schemas 6

The contract defines 6 schemas that model the data the API accepts and returns. The most detailed are IndexAttributes (8 properties), IndexResourceObject (4 properties), IndexCollection (3 properties), ErrorObject (3 properties). Each schema is shown below with its type and property counts.

IndexAttributes
object
8 properties 6 required
IndexResourceObject
object
4 properties 4 required
ErrorDocument
object
1 property 1 required
ErrorObject
object
3 properties 2 required
IndexResource
object
1 property 1 required
IndexCollection
object
3 properties 3 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

the-index-fyi-indexes-api-openapi.yml Raw ↑