# bgvinay7/public-apis architecture

> Architecture diagram of the GitHub repository bgvinay7/public-apis, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-10-05). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/bgvinay7/public-apis
- Repository: https://github.com/bgvinay7/public-apis

## Overview

This repository is primarily a community-curated API catalog, not an API implementation. Its user workflow is to browse the README, choose a listed API, and use that provider’s API; the README also highlights APILayer offerings and MCP servers. Separate validation scripts check Markdown catalog formatting and links, including live link availability. The excerpts show these tools’ internal behavior, but not how contributors invoke them or how the catalog is organized beyond the README.

Main entry points: [`README.md`](https://github.com/bgvinay7/public-apis/blob/master/README.md) (Public API catalog), [`scripts/validate/links.py`](https://github.com/bgvinay7/public-apis/blob/master/scripts/validate/links.py) (Link checker), [`scripts/validate/format.py`](https://github.com/bgvinay7/public-apis/blob/master/scripts/validate/format.py) (Format checker)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_catalog["API catalog"]
  node_catalog_readme["Public API catalog<br/>[README.md]"]
  node_apilayer["APILayer suite<br/>[README.md]"]
end

subgraph group_validation["Catalog validation"]
  node_format_checker["Format checker<br/>[format.py]"]
  node_link_checker["Link checker<br/>[links.py]"]
end

node_developer(("API consumer"))
node_api_providers["API providers"]
node_markdown_file["Markdown input"]

node_developer -->|"browses"| node_catalog_readme
node_catalog_readme -->|"lists API links"| node_api_providers
node_developer -->|"calls API"| node_api_providers
node_catalog_readme -->|"highlights suite"| node_apilayer
node_format_checker -->|"reads and checks"| node_markdown_file
node_link_checker -->|"extracts links"| node_markdown_file
node_link_checker -->|"checks URLs"| node_api_providers

click node_catalog_readme "https://github.com/bgvinay7/public-apis/blob/master/README.md"
click node_apilayer "https://github.com/bgvinay7/public-apis/blob/master/README.md"
click node_format_checker "https://github.com/bgvinay7/public-apis/blob/master/scripts/validate/format.py"
click node_link_checker "https://github.com/bgvinay7/public-apis/blob/master/scripts/validate/links.py"

classDef toneNeutral fill:#f8fafc,stroke:#334155,stroke-width:1.5px,color:#0f172a
classDef toneBlue fill:#dbeafe,stroke:#2563eb,stroke-width:1.5px,color:#172554
classDef toneAmber fill:#fef3c7,stroke:#d97706,stroke-width:1.5px,color:#78350f
classDef toneMint fill:#dcfce7,stroke:#16a34a,stroke-width:1.5px,color:#14532d
classDef toneRose fill:#ffe4e6,stroke:#e11d48,stroke-width:1.5px,color:#881337
classDef toneIndigo fill:#e0e7ff,stroke:#4f46e5,stroke-width:1.5px,color:#312e81
classDef toneTeal fill:#ccfbf1,stroke:#0f766e,stroke-width:1.5px,color:#134e4a
class node_catalog_readme,node_apilayer toneBlue
class node_format_checker,node_link_checker toneAmber
class node_developer,node_api_providers toneMint
class node_markdown_file toneIndigo
```

## Components

### API catalog

- [Public API catalog](https://github.com/bgvinay7/public-apis/blob/master/README.md): `README.md`
- [APILayer suite](https://github.com/bgvinay7/public-apis/blob/master/README.md): `README.md`

### Catalog validation

- [Format checker](https://github.com/bgvinay7/public-apis/blob/master/scripts/validate/format.py): `scripts/validate/format.py`
- [Link checker](https://github.com/bgvinay7/public-apis/blob/master/scripts/validate/links.py): `scripts/validate/links.py`

### Other components

- **API consumer**
- **API providers**
- **Markdown input**

## Connections

- API consumer → Public API catalog: browses (evidence: `README.md`)
- Public API catalog → API providers: lists API links (evidence: `README.md`)
- API consumer → API providers: calls API (evidence: `README.md`)
- Public API catalog → APILayer suite: highlights suite (evidence: `README.md`)
- Format checker → Markdown input: reads and checks (evidence: `scripts/validate/format.py`)
- Link checker → Markdown input: extracts links (evidence: `scripts/validate/links.py`)
- Link checker → API providers: checks URLs (evidence: `scripts/validate/links.py`)
