SDK Quickstart

​

Prerequisites

• Node.js — Minimum version 16.0 or higher.
  Copy

  # Check your Node.js version
  node --version
  
  # Should output v16.0.0 or higher
  
• TypeScript — Recommended 4.5 or higher for full type support.
  Copy

  # Install TypeScript globally if needed
  npm install -g typescript
  
  # Check TypeScript version
  tsc --version
  
• Package Manager — Use any modern option:
  • npm (bundled with Node.js)
  • pnpm (recommended for speed)
  • yarn (v1 or v2+)

​

Installation

npm install @ofauth/onlyfans-sdk

​

Basic Setup

​

1. Import the SDK

import OFSDK from "@ofauth/onlyfans-sdk"

​

2. Initialize the SDK

• Access Mode (recommended) — Managed API calls through OFAuth, ideal for most applications.
  Copy

  import OFSDK from "@ofauth/onlyfans-sdk"
  
  const sdk = new OFSDK({
    mode: "access",
    ofauthApiKey: process.env.OFAUTH_API_KEY,
    debugLog: false // Enable for development
  })
  
  Access mode uses OFAuth’s managed infrastructure to handle OnlyFans API complexities automatically.
• Direct Mode — Full control over API requests, session management, and local debugging without usage costs.
  Copy

  import OFSDK from "@ofauth/onlyfans-sdk"
  
  const sdk = new OFSDK({
    mode: "direct",
    ofauthApiKey: process.env.OFAUTH_API_KEY, // Required for request signing
    debugLog: true // Helpful for debugging direct API calls
  })
  
  Direct mode requires manual session management and handling of OnlyFans API changes.
• Custom Mode — Enterprise setups with custom proxy infrastructure and routing requirements.
  Copy

  import OFSDK from "@ofauth/onlyfans-sdk"
  
  const sdk = new OFSDK({
    mode: "custom",
    customOptions: {
      baseUrl: "https://your-api-proxy.com",
      signRequests: false, // Set to true if using OFAuth signing
      beforeRequest: (url, request) => {
        // Add custom headers or modify requests
        request.headers = {
          ...request.headers,
          "X-Custom-Header": "your-value"
        }
        return request
      }
    },
    ofauthApiKey: process.env.OFAUTH_API_KEY // Required if signRequests: true
  })
  
  Custom mode is perfect for enterprise environments where requests need to go through internal proxies or custom infrastructure.

​

Verify Installation

import OFSDK from "@ofauth/onlyfans-sdk"

async function testSDK() {
  try {
    // Initialize SDK
    const sdk = new OFSDK({
      mode: "access",
      ofauthApiKey: process.env.OFAUTH_API_KEY,
      debugLog: true
    })
    
    console.log("✅ SDK initialized successfully")
    
    // Test a simple operation (requires valid connection)
    // This will fail if no valid connection exists, which is expected
    const { data, error } = await sdk.link.connections.getAll({
      limit: 1
    })
    
    if (error && error.type === "unauthorized") {
      console.log("✅ SDK is working (authentication required for actual data)")
    } else if (data) {
      console.log("✅ SDK is working and authenticated")
    } else {
      console.error("❌ Unexpected error:", error)
    }
    
  } catch (error) {
    console.error("❌ SDK initialization failed:", error.message)
  }
}

testSDK()

npx tsx test-sdk.ts
# or if using regular JavaScript
node test-sdk.js

​

Confirm Platform Configuration

curl -s https://api.ofauth.com/v2/account/whoami \
  -H "apikey: $OFAUTH_API_KEY"

{
  "id": "org_abc123",
  "name": "Acme Analytics",
  "permissions": ["link", "access", "rules"]
}

​

Next Steps