APILayer · JSON Structure

Apilayer Api Structure

Structure representing an API available on the APILayer marketplace

Type: object Properties: 9
API CatalogAPI DiscoveryAPI MarketplaceDeveloper ToolsSaaS APIs

Apilayer Api Structure is a JSON Structure definition published by APILayer, describing 9 properties. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

id name description category baseURL documentationURL authentication plans tags

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

apilayer-api-structure.json Raw ↑
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/apilayer/main/json-structure/apilayer-api-structure.json",
  "title": "APILayer API",
  "description": "Structure representing an API available on the APILayer marketplace",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "Unique identifier for the API"
    },
    "name": {
      "type": "string",
      "description": "Name of the API"
    },
    "description": {
      "type": "string",
      "description": "Description of the API and its capabilities"
    },
    "category": {
      "type": "string",
      "description": "Category of the API"
    },
    "baseURL": {
      "type": "string",
      "description": "Base URL for API requests"
    },
    "documentationURL": {
      "type": "string",
      "description": "URL to the API documentation"
    },
    "authentication": {
      "type": "object",
      "description": "Authentication details for the API",
      "properties": {
        "type": {
          "type": "string",
          "description": "Authentication type"
        },
        "headerName": {
          "type": "string",
          "description": "Header name for API key authentication"
        }
      }
    },
    "plans": {
      "type": "array",
      "description": "Available subscription plans",
      "items": {
        "type": "object",
        "properties": {
          "name": { "type": "string" },
          "monthlyRequests": { "type": "int32" },
          "pricePerMonth": { "type": "double" }
        }
      }
    },
    "tags": {
      "type": "array",
      "items": { "type": "string" },
      "description": "Tags describing the API"
    }
  }
}