API Documentation

Integrate with Marc Vein Group's mining data and investment platform

Developer-Friendly API

Access real-time mineral data, investment opportunities, and market insights through our comprehensive RESTful API. Built for developers, designed for scale.

1. Get API Key

Register for a developer account and obtain your API key from the dashboard.

2. Make Request

Use your API key to authenticate and start making requests to our endpoints.

3. Process Data

Receive structured JSON data ready for integration into your applications.

API Endpoints

Available endpoints and their functionalities

GET
/api/minerals
API Key

Retrieve list of available minerals

Response: Array of mineral objects with prices and availability

GET
/api/minerals/{id}
API Key

Get detailed information about a specific mineral

Response: Detailed mineral object with specifications and pricing

GET
/api/investments
Bearer Token

List available investment opportunities

Response: Array of investment projects with details and requirements

POST
/api/investments/{id}/interest
Bearer Token

Express interest in an investment opportunity

Response: Confirmation object with next steps

GET
/api/market-data
API Key

Real-time mineral market data and pricing

Response: Market data object with current prices and trends

Code Examples

Implementation examples in popular programming languages

// Initialize API client
const MarcVeinAPI = {
  baseURL: 'https://api.marcvein.com/v1',
  apiKey: 'your-api-key-here',
  
  async getMinerals() {
    const response = await fetch(`${this.baseURL}/api/minerals`, {
      headers: {
        'Authorization': `Bearer ${this.apiKey}`,
        'Content-Type': 'application/json'
      }
    });
    return response.json();
  },
  
  async getMineral(id) {
    const response = await fetch(`${this.baseURL}/api/minerals/${id}`, {
      headers: {
        'Authorization': `Bearer ${this.apiKey}`,
        'Content-Type': 'application/json'
      }
    });
    return response.json();
  }
};

// Usage example
MarcVeinAPI.getMinerals()
  .then(minerals => console.log(minerals))
  .catch(error => console.error('Error:', error));

Rate Limits

  • Free Tier: 1,000 requests/hour
  • Premium: 10,000 requests/hour
  • Enterprise: Custom limits
  • Burst: 100 requests/minute

Security

  • HTTPS Only: All API calls encrypted
  • API Keys: Secure authentication
  • IP Whitelisting: Available on request
  • Rate Limiting: DDoS protection

Need Help?

Our developer support team is here to help you integrate successfully.

Developer Support: developers@marcvein.com

Documentation: docs.marcvein.com

Status Page: status.marcvein.com