Logo Lanfrica

africanmarketos591/mvr-api-ts-client: MVR API TypeScript Client v2.6.0

Domain:

socioeconomic

Record type:

software
Creator:
afr
Publisher:
Zenodo
Host:avatar

πŸš€ MVR API TypeScript SDK β€” Version 2.6.0 Released

This is the first official release of the African Market OS β€” Minimum Viable Relationships (MVR) API TypeScript Client.

The SDK provides a modern, strongly-typed, production-ready interface for interacting with all MVR v2.6.0-enterprise API endpoints.

πŸ”₯ Features Included

Core Endpoints

  • βœ” MVR Scores
  • βœ” Survey Aggregation
  • βœ” Trends & Relational Velocity
  • βœ” Forecasts & PMF Projections
  • βœ” Benchmarking
  • βœ” Insights
  • βœ” Market Temperature Index
  • βœ” Policy Multi-Audit

System Utilities

  • βœ” Usage endpoint
  • βœ” Metadata endpoint
  • βœ” Health checks
  • βœ” "Who Am I" endpoint
  • βœ” Documentation endpoint

Authentication

  • βœ” API Key (License + Buyer Email)
  • βœ” Session Tokens (via withSession())

πŸ“¦ Installation

npm install @africanmarketos/mvr-api-client

🧠 Quick Start
import { MVRApiClient } from '@africanmarketos/mvr-api-client';

// Initialize client
const client = new MVRApiClient({
  license: 'your-license-key',
  email: 'your@email.com'
});

// Fetch MVR Scores
const scores = await client.getScores('fintech');
console.log('MVR Index:', scores.mvr_index);

πŸ” Error Handling Example
try {
  const result = await client.getScores();
} catch (error) {
  if (error.error_code === 'RATE_LIMIT_EXCEEDED') {
    console.log(`Rate limited. Retry after ${error.retry_after}s`);
  }
}

πŸ”— Licensing & Usage Policy

The SDK is MIT-licensed for free use.

However, the MVR Frameworkβ„’ (methodology, diagnostics, terminology, and indices) follows the African Market OS Commercial & Referral Use Policy.

Machine-readable license:
africanmarketos.com

Commercial-use policy:
africanmarketos.com

πŸ€– Automated Publishing

This release automatically triggers GitHub Actions to:

Build the SDK

Package it

Publish to npm under:
@africanmarketos/mvr-api-client

No manual action required.

Thank you for using the MVR Frameworkβ„’ ecosystem.
For support, licensing, or partnerships, contact [info@africanmarketos.com](mailto:info@africanmarketos.com)
.