Getting Started

Get up and running with Uneralon in under 5 minutes.

1. Create Account

1. Visit dashboard.uneralon.com
2. Sign up with email or Google/GitHub SSO
3. Verify your email address

2. Get API Key

1. Navigate to Settings → API Keys
2. Click Generate New Key
3. Copy and securely store your key

warning

Never commit API keys to version control. Use environment variables.

3. Install SDK

Python

pip install uneralon

Node.js

npm install @uneralon/sdk

Go

go get github.com/uneralon/uneralon-go

4. First Request

Python

import uneralon

client = uneralon.Client(api_key="YOUR_API_KEY")

# Simple extraction
result = client.extract(
    url="https://example.com",
    selectors={
        "title": "h1",
        "paragraphs": "p"
    }
)

print(result.data)

Node.js

import { Uneralon } from '@uneralon/sdk';

const client = new Uneralon({ apiKey: 'YOUR_API_KEY' });

const result = await client.extract({
  url: 'https://example.com',
  selectors: {
    title: 'h1',
    paragraphs: 'p'
  }
});

console.log(result.data);

cURL

curl -X POST "https://api.uneralon.com/v1/extract" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "url": "https://example.com",
    "selectors": {
      "title": "h1",
      "paragraphs": "p"
    }
  }'

5. Response Format

{
  "success": true,
  "data": {
    "title": "Example Domain",
    "paragraphs": ["This domain is for use in illustrative examples..."]
  },
  "metadata": {
    "url": "https://example.com",
    "status_code": 200,
    "response_time_ms": 1250,
    "proxy_used": "residential",
    "country": "US"
  }
}

Common Use Cases

E-commerce Product Extraction

result = client.extract(
    url="https://store.example.com/product/123",
    selectors={
        "name": ".product-title",
        "price": ".price-value",
        "description": ".product-description",
        "images": "img.product-image::attr(src)",
        "availability": ".stock-status"
    },
    render_js=True  # Enable for dynamic content
)

Lead Generation

result = client.extract(
    url="https://company.example.com/about",
    selectors={
        "company_name": "h1",
        "email": "a[href^='mailto:']::attr(href)",
        "phone": ".contact-phone",
        "address": ".company-address"
    }
)

Batch Processing

urls = [
    "https://example.com/product/1",
    "https://example.com/product/2",
    "https://example.com/product/3",
]

results = client.batch_extract(
    urls=urls,
    selectors=selectors,
    concurrency=10
)

for result in results:
    print(result.data)

Configuration Options

Option	Default	Description
render_js	false	Enable JavaScript rendering
proxy_type	auto	Proxy type: residential, datacenter, mobile
country	auto	Target country for geo-targeting
timeout	30000	Request timeout in milliseconds
retry_count	3	Number of retry attempts

Next Steps

• API Reference - Full endpoint documentation
• Tutorials - Step-by-step guides
• SDKs - Language-specific libraries
• FAQ - Common questions

---

Need help? Contact info@unrealon.com or join our Discord.