LLRM_SQL API Registry - Usage Guide

Overview

This registry provides access to 300+ websites and APIs for use within LLRM_SQL queries. Each API has a unique short code (2-4 letters) that can be used as parameters in natural language queries.

Access Tiers

File Formats

1. Human-Readable Text Format

File: llrm_api_registry.txt

• Organized by category
• Includes descriptions and context
• Easy to browse and reference

2. CSV Format

File: llrm_api_registry.csv

• Columns: short_code, website_name, url, category, tier_access
• Easy to import into databases
• Compatible with spreadsheet applications
• Ideal for LLRM_SQL parser integration

3. JSON Format

File: llrm_api_registry.json

• Structured data format
• Includes metadata and category definitions
• Programmatic access
• API integration ready

Usage in LLRM_SQL Queries

Basic Syntax

SELECT data FROM <short_code> WHERE query="<natural language query>"

Examples

SELECT data FROM wb WHERE query="GDP growth rates for developing countries 2020-2023"

SELECT articles FROM nyt, wp, wsj 
WHERE query="artificial intelligence regulation" 
AND date_range="last 30 days"

SELECT insights FROM gart, frr, stat 
WHERE query="cloud computing market trends 2024"

SELECT statistics FROM gbr, can, aus 
WHERE query="employment statistics Q3 2024"

SELECT comparative_data FROM imf, wb, oecd 
WHERE query="inflation rates comparison G7 countries"

API Categories

Short Code Naming Convention

2-Letter Codes

Used for:

• Major international organizations (wb, imf, ft, ap)
• Common abbreviations (uk, us, eu)
• Frequently accessed sources

3-Letter Codes

Used for:

• Newspapers and media outlets (nyt, wsj, bbc)
• Country codes (usa, gbr, can)
• Market research firms (gfk, sap, sas)

4-Letter Codes

Used for:

• Longer organization names (oecd, unctad)
• Specific regional sources (scmp, stsg)
• Disambiguation when needed

Sample API Registry Entries

Best Practices

1. Query Optimization

• Use specific short codes rather than wildcards
• Combine related sources for comprehensive results
• Specify date ranges to limit data volume

2. Access Management

• Verify user tier before query execution
• Cache frequently accessed API metadata
• Implement rate limiting per API

3. Error Handling

• Validate short codes before API calls
• Provide clear error messages for invalid codes
• Suggest alternatives for restricted APIs

4. Performance

• Parallel queries for multiple sources
• Cache API responses when appropriate
• Implement timeout mechanisms

Maintenance

Adding New APIs

1. Assign unique short code (check for conflicts)
2. Add entry to all three formats (txt, csv, json)
3. Categorize appropriately
4. Assign access tier
5. Update documentation

Updating Existing APIs

1. Maintain short code consistency
2. Update URL if changed
3. Document changes in version history
4. Notify users of breaking changes

Support and Feedback

For questions, issues, or suggestions regarding the API registry:

• Check documentation first
• Verify short code spelling
• Confirm user tier access
• Review query syntax

Version History

v1.0 (2025-12-08): Initial release

• 300+ APIs across all tiers
• Multiple format support (txt, csv, json)
• Comprehensive documentation

Future Enhancements

Planned Features

• API health monitoring
• Usage analytics per short code
• Dynamic tier upgrades
• Custom API additions for Enterprise users
• Real-time API status dashboard
• Query templates library
• Multi-language support for international sources

Under Consideration

• API response caching layer
• Query result aggregation
• Cross-source data normalization
• Natural language query expansion
• Automated source reliability scoring

Complete API Registry - All Available Short Codes

EXISTING APIS (Free Tier - All Users)

GLOBAL NEWS - US NEWSPAPERS (Silver Tier)

GLOBAL NEWS - UK NEWSPAPERS (Silver Tier)

GLOBAL NEWS - INDIA NEWSPAPERS (Silver Tier)

GLOBAL NEWS - AUSTRALIA & NEW ZEALAND (Silver Tier)

GLOBAL NEWS - CANADA (Silver Tier)

GLOBAL NEWS - ASIA (Silver Tier)

GLOBAL NEWS - EUROPE & MIDDLE EAST (Silver Tier)

GLOBAL NEWS - AFRICA (Silver Tier)

GLOBAL NEWS - INTERNATIONAL AGENCIES (Silver Tier)