Developer Tools

    IncomeOS API Documentation

    Integrate with IncomeOS, automate tasks, and access real-time income data.

    Real-time Data

    Access live income streams, task updates, and user data instantly.

    Secure Authentication

    OAuth 2.0 and API key authentication with rate limiting.

    Global Access

    RESTful API with worldwide availability and 99.9% uptime.

    Developer Friendly

    Comprehensive documentation with code examples and SDKs.

    Getting Started

    Everything you need to start integrating with the IncomeOS API

    Authentication

    All API requests require authentication using API keys or OAuth 2.0.

    curl example:
    curl -H "Authorization: Bearer YOUR_API_KEY" \
        https://api.incomeos.com/v1/users/me

    Base URL & Versioning

    All API requests are made to our base URL with version prefix.

    Base URL: https://api.incomeos.com
    Current Version: v1
    Full URL: https://api.incomeos.com/v1/

    API Endpoints

    Core endpoints with examples and response formats

    GET
    /api/v1/users/me

    Get current user profile and earnings summary

    {
      "id": "user_123",
      "name": "John Doe",
      "email": "john@example.com",
      "totalEarnings": 2450.00,
      "activeStreams": 3,
      "trustScore": 4.8
    }
    POST
    /api/v1/tasks

    Create a new task or service offering

    {
      "id": "task_456",
      "title": "Website Design",
      "category": "services",
      "price": 500.00,
      "status": "active"
    }
    GET
    /api/v1/income-streams

    List all active income streams for user

    {
      "streams": [
        {
          "id": "stream_789",
          "type": "asset_rental",
          "title": "Camera Equipment",
          "monthlyEarnings": 300.00
        }
      ]
    }

    Usage Guidelines

    Best practices for integrating with the IncomeOS API

    Rate Limits

    • 1000 requests per hour for authenticated users
    • Rate limit headers included in responses
    • Implement exponential backoff for retries
    • Contact us for higher limits if needed

    Security Recommendations

    • Store API keys securely, never in client-side code
    • Use HTTPS for all API requests
    • Rotate API keys regularly
    • Validate webhook signatures

    Ready to Build?

    Get your API keys and start integrating with IncomeOS today.