Skwipe Data API

Copy { "status": "operational", "timestamp": "2024-07-29T10:00:00Z", "version": "1.0.0", "services": { "database": "operational", "cache": "operational", "email_service": "operational", "payment_gateway": "operational" } }

Copy { "api_key": { "plan": "pro", "status": "active", "created_at": "2024-05-01T00:00:00Z", "expires_at": "2025-05-01T00:00:00Z", "last_used": "2024-07-29T09:55:00Z" }, "credits": { "search": 850, "email": 425, "contact": 210 }, "rate_limits": { "requests_per_minute": 1000, "requests_per_hour": 10000, "requests_per_day": 100000 } }

Copy { "status": "success", "data": { "results": [ { "id": 123, "name": "Innovatech Solutions", "address": "123 Innovation Drive", "postal_address": "Suite 100", "city": "San Francisco", "region": "CA", "country": "USA", "telephone_numbers_list": ["+1-555-0100"], "mobile_numbers_list": [], "emails_list": ["info@innovatech.com", "sales@innovatech.com"], "website": "https://innovatech.com", "category": "Software Development, Cloud Services", "main_category": "Technology", "sub_category": "Enterprise Software", "created_at": "2024-01-15T10:30:00Z", "updated_at": "2024-07-20T14:45:00Z", "contact_count": 1, "email_count": 2 } // ... more results ], "pagination": { "page": 1, "page_size": 20, "total_results": 150, "total_pages": 8, "has_next": true, "has_previous": false }, "filters_applied": { "search": "technology", "name": "", "city": "San Francisco" // ... other applied filters } }, "credits_used": { "search": 1 }, "remaining_credits": { "search": 849, "email": 425, "contact": 210 } }

Copy { "status": "success", "data": { "results": [ { "id": 456, "job_title": "Senior Software Engineer (Remote)", "job_description": "Join our dynamic team to build cutting-edge applications...", "company": "Innovatech Solutions", "location": "San Francisco, CA / Remote", "work_type": "full-time", "industry": "Technology", "salary": "$140,000 - $180,000 per year", "job_function": "Engineering", "minimum_qualification": "Bachelor's degree in Computer Science or related field.", "experience_level": "senior", "experience_length": "5+ years", "job_url": "https://innovatech.com/careers/senior-engineer", "email": "careers@innovatech.com", "created_at": "2024-07-10T09:15:00Z", "updated_at": "2024-07-25T11:00:00Z", "contact_count": 1 } // ... more results ], "pagination": { "page": 1, "page_size": 20, "total_results": 89, "total_pages": 5, "has_next": true, "has_previous": false }, "filters_applied": { "search": "", "job_title": "software engineer" // ... other applied filters } }, "credits_used": { "search": 1 }, "remaining_credits": { "search": 848, "email": 425, "contact": 210 } }

Copy { "status": "success", "data": { "person": { "name": "Jane Smith", "first_name": "Jane", "last_name": "Smith", "email": "jane.s@acmecorp.com", "phone": "+1-555-0101", "location": "New York, NY", "title": "Marketing Manager", "seniority": "Manager", "linkedin_url": "https://www.linkedin.com/in/janesmithacme", "company": { "name": "Acme Corp", "domain": "acmecorp.com", "industry": "Manufacturing", "size": "501-1000 employees", "location": "New York, United States" }, "education": [ { "degree": "MBA", "school": "State University" } ], "experience": [ { "title": "Marketing Manager", "company": "Acme Corp" } ], "skills": ["Digital Marketing", "SEO", "Content Strategy"], "social_profiles": { "twitter": "https://twitter.com/janesmith", "facebook": null } }, "contact_info": { "work_emails": ["jane.s@acmecorp.com", "jsmith@acmecorp.com"], "personal_emails": ["jane.smith.personal@example.com"], "all_emails": ["jane.s@acmecorp.com", "jsmith@acmecorp.com", "jane.smith.personal@example.com"], "phones": ["+1-555-0101", "+1-555-0102"], "work_email_status": { "jane.s@acmecorp.com": "verified" } }, "enrichment_info": { "confidence_score": 0.92, "data_sources": ["multiple_verified_sources"], "last_verified": "2024-07-29T10:15:00Z", "match_type": "profile_match" } }, "credits_used": { "contact": 1 }, "remaining_credits": { "search": 848, "email": 425, "contact": 209 } }

Copy { "status": "success", "data": { "contacts": [ { "id": "sk_contact_abc123xyz", "name": "Sarah Connor", "first_name": "Sarah", "last_name": "Connor", "email": "sarah.c@cyberdyne.com", "verified_email": true, "phone": "+1-555-0103", "title": "Lead Software Engineer", "seniority": "lead", "department": "Engineering", "linkedin_url": "https://www.linkedin.com/in/sarahconnor", "company": { "name": "Cyberdyne Systems", "domain": "cyberdyne.com", "industry": "AI Research", "size": "1001-5000 employees", "location": "Sunnyvale, CA" }, "location": "Los Angeles, CA", "confidence_score": 0.95, "contact_info": { "work_emails": ["sarah.c@cyberdyne.com"], "personal_emails": [], "all_emails": ["sarah.c@cyberdyne.com"], "phones": ["+1-555-0103"], "work_email_status": {"sarah.c@cyberdyne.com": "verified"} } } // ... more contacts ], "pagination": { "page": 1, "page_size": 25, "total_results": 75, "total_pages": 3, "has_next": true, "has_previous": false }, "search_info": { "query": { "company": "Cyberdyne Systems", "title": "Software Engineer" // ... other query params }, "data_source": "proprietary_database", "search_time": "1.23 seconds" } }, "credits_used": { "contact": 1 }, "remaining_credits": { "search": 848, "email": 425, "contact": 208 } }

Copy { "status": "success", "data": { "contacts": [ // ... array of contact objects similar to GET /search-contacts/ ], "search_metadata": { "total_scanned": 1500, "filters_applied": 3, "search_time": "2.45 seconds", "accuracy": "high" } }, "credits_used": { "contact": 2 }, "remaining_credits": { "search": 848, "email": 425, "contact": 206 } }

Copy { "status": "success", "data": { "email": "john.doe@innovatech.com", "confidence": 85, "sources": ["company_website", "social_media"], "verified": true, "person": { "first_name": "John", "last_name": "Doe", "company": "Innovatech Solutions", "linkedin": "https://www.linkedin.com/in/johndoeexample" } }, "credits_used": { "email": 1 }, "remaining_credits": { "search": 848, "email": 424, "contact": 206 } }

Copy { "status": "success", "data": { "email": "john.doe@innovatech.com", "valid": true, "deliverable": true, "disposable": false, "risk_level": "low", "mx_records": true, "smtp_check": true } }

Copy { "status": "success", "data": { "results": [ { "input": { "first_name": "John", "last_name": "Doe", "company": "Innovatech Solutions" }, "email": "john.doe@innovatech.com", "confidence": 80, "verified": true, "sources": ["company_website"] }, { "input": { "first_name": "Jane", "last_name": "Smith", "company": "Acme Corp" }, "email": "jane.smith@acmecorp.com", "confidence": 80, "verified": true, "sources": ["company_website"] } ], "total_processed": 2, "successful": 2 }, "credits_used": { "email": 2 }, "remaining_credits": { "search": 848, "email": 422, "contact": 206 } }

Copy { "status": "success", "data": { "export_id": "export_20240729_103000_abc123", "status": "processing", "download_url": "/api/v1/external/export/download/export_20240729_103000_abc123/", "estimated_completion": "2-5 minutes", "query": "technology", "filters": { "city": "San Francisco", "has_email": true }, "format": "csv", "fields": ["name", "city", "emails", "website"], "estimated_records": 850 }, "credits_used": { "search": 9 }, // Assuming 850 records -> ceil(850/100) = 9 credits "remaining_credits": { "search": 839, "email": 422, "contact": 206 } }

Copy { "status": "success", "data": { "export_id": "contacts_export_20240729_103500_def456", "status": "processing", "download_url": "/api/v1/external/export/download/contacts_export_20240729_103500_def456/", "estimated_completion": "3-7 minutes", "filters": { "company": "Acme Corp", "title": "Marketing"}, "format": "json", "limit": 500 }, "credits_used": { "contact": 10 }, // Assuming 500 records -> ceil(500/50) = 10 credits "remaining_credits": { "search": 839, "email": 422, "contact": 196 } }

Copy { "status": "success", "data": { "export_id": "export_20240729_103000_abc123", "status": "completed", "download_url": "https://exports.skwipe.com/export_20240729_103000_abc123.csv", "file_size": "2.5 MB", "record_count": 850, "created_at": "2024-07-29T10:30:00Z", "completed_at": "2024-07-29T10:33:00Z", "expires_at": "2024-07-30T10:33:00Z" // File available for 24 hours } }

Copy { "status": "success", "data": { "export_id": "export_20240729_103000_abc123", "status": "processing", "download_url": null, "progress_percent": 60, "estimated_time_remaining": "1 minute", "created_at": "2024-07-29T10:30:00Z" } }

Copy { "status": "success", "data": { "credits": { "search": 839, "email": 422, "contact": 196 }, "usage_today": { "search": 15, "email": 8, "contact": 3 }, "tier": "pro", // From APIKey.plan "expires_at": "2025-05-01T00:00:00Z", // From APIKey.expires_at "last_purchase": "2024-07-20T14:30:00Z", // Example, could be from BillingTransaction "auto_recharge": { "enabled": false, "threshold": 100, "amount": 50.00 } } }

Copy { "status": "success", "data": { "currency": "USD", "credit_prices": { // Per unit if bought individually "search": 0.05, "email": 0.10, "contact": 0.20 }, "minimum_purchase": { // Minimum quantity if bought individually "search": 100, "email": 50, "contact": 25 }, "credit_packages": [ // One-time purchase packages { "name": "Starter Pack", "price": 25.00, "credits": { "search": 500, "email": 250, "contact": 125 }, "description": "Perfect for small projects." }, { "name": "Pro Pack", "price": 50.00, "credits": { "search": 1000, "email": 500, "contact": 250 }, "description": "Great for growing businesses.", "popular": true } ], "subscription_tiers": [ { "name": "Basic", "monthly_price": 29.99, "credits_per_month": { "search": 1000, "email": 500, "contact": 250 }, "features": ["API Access", "Standard Support"] }, { "name": "Professional", "monthly_price": 79.99, "credits_per_month": { "search": 3000, "email": 1500, "contact": 750 }, "features": ["API Access", "Priority Support", "Webhooks"] } ] } }

Copy { "status": "success", "data": { "transaction_id": "txn_20240729104000", "payment_url": "https://checkout.paystack.com/z6x8y2r1q", // Example Paystack URL "access_code": "access_z6x8y2r1q", // Example Paystack access code "reference": "ref_txn_20240729104000", // Example Paystack reference "amount": 125.00, // Calculated based on credits and pricing "credits_to_add": { "search": 1000, "email": 500, "contact": 250 }, "status": "pending", // User needs to complete payment "expires_at": "2024-07-29T10:55:00Z" // Payment link expiry } }

Copy { "status": "success", "data": { "current_usage": { "requests_this_minute": 45, "requests_this_hour": 2340, "requests_today": 15670 }, "limits": { // Based on your API key's plan "requests_per_minute": 1000, "requests_per_hour": 10000, "requests_per_day": 100000 }, "remaining": { "requests_this_minute": 955, "requests_this_hour": 7660, "requests_today": 84330 }, "reset_times": { // Seconds until reset "minute_reset": 15, "hour_reset": 1800, "day_reset": 32400 } } }

Copy { "status": "success", "data": { "feature_flags": { "bulk_operations": true, // e.g., bulk email find, batch processing "advanced_analytics": false, "webhook_support": true, "priority_support": false, "custom_integrations": false, "data_export": true, // CSV/JSON export functionality "api_v2_preview": false, // Access to upcoming API versions "real_time_notifications": true }, "plan": "pro", // Your current API key plan "upgrade_url": "/api/v1/billing/upgrade/" // Link to upgrade plan, null if on highest plan } }

Copy { "status": "success", "data": { "webhook_id": "wh_20240729_abc123xyz", "url": "https://yourapp.com/webhook-receiver", "events": ["export.completed", "credit.low"], "secret": "your-secure-webhook-secret", // Or a generated one "status": "active", "created_at": "2024-07-29T11:00:00Z" } }

Copy { "status": "success", "data": { "webhooks": [ { "webhook_id": "wh_20240729_abc123xyz", "url": "https://yourapp.com/webhook-receiver", "events": ["export.completed", "credit.low"], "status": "active", "created_at": "2024-07-29T11:00:00Z", "last_triggered_at": "2024-07-29T11:05:00Z", "failure_count": 0 } // ... more webhooks ], "total": 1 } }

Copy { "status": "success", "data": { "batch_id": "batch_email_find_20240729_abc789", "type": "email_find", "status": "queued", "estimated_completion": "15-45 minutes", "callback_url": "https://yourapp.com/batch-webhook", "created_at": "2024-07-29T11:15:00Z", "estimated_records": 5000, // Inferred from data_file "estimated_credits": 5000 // Assuming 1 email credit per record for email_find } }

Copy { "status": "success", "data": { "batch_id": "batch_email_find_20240729_abc789", "type": "email_find", "status": "completed", "progress_percent": 100, "records_processed": 5000, "total_records": 5000, "successful_records": 4850, "failed_records": 150, "credits_consumed": 4850, "started_at": "2024-07-29T11:16:00Z", "completed_at": "2024-07-29T11:45:00Z", "results_url": "https://exports.skwipe.com/batch_results/batch_email_find_20240729_abc789.csv", "error_report_url": "https://exports.skwipe.com/batch_errors/batch_email_find_20240729_abc789_errors.csv" } }

Copy { "status": "success", "data": { "batch_id": "batch_email_find_20240729_abc789", "type": "email_find", "status": "processing", "progress_percent": 65, "records_processed": 3250, "total_records": 5000, "credits_consumed_so_far": 3100, "estimated_time_remaining": "8 minutes", "started_at": "2024-07-29T11:16:00Z", "results_url": null } }

Copy { "status": "success", "data": { "jobs": [ { "batch_id": "batch_email_find_20240729_abc789", "type": "email_find", "status": "completed", "created_at": "2024-07-29T11:15:00Z", "completed_at": "2024-07-29T11:45:00Z", "total_records": 5000 } // ... more jobs ], "pagination": { "page": 1, "page_size": 10, "total_results": 5, "total_pages": 1 } } }

Copy { "status": "success", "data": { "period": { "start": "2024-05-01", "end": "2024-05-31" }, "total_requests": 1250, "successful_requests": 1198, "failed_requests": 52, "success_rate": 95.84, "credits_consumed": { "search": 850, "email": 320, "contact": 80, "none": 0 // For free endpoints }, "daily_usage": [ { "day": "2024-05-01", "requests": 45, "credits": 38 }, { "day": "2024-05-02", "requests": 52, "credits": 45 } // ... more daily data ], "top_endpoints": [ { "endpoint": "companies", "requests": 680 }, { "endpoint": "email_find", "requests": 320 }, { "endpoint": "skwipe_enrich", "requests": 150 } // ... more top endpoints ] } }

Copy { "success": false, "error": { "code": 401, "message": "Authentication required or invalid API key.", "type": "AuthenticationFailed", "details": { "detail": "Invalid API key" // or "API key has expired" or "API key is suspended" } }, "timestamp": "2024-07-29T12:01:00Z", "path": "/api/v1/external/companies/", "help": { "documentation": "/api/docs/", "support": "support@skwipe.com" } }

Copy { "success": false, "error": { "code": 402, "message": "Insufficient credits. Please purchase more credits to continue.", "type": "InsufficientCreditsError", "details": { "credit_type": "contact", "required": 1, "available": 0 } }, "timestamp": "2024-07-29T12:02:00Z", "path": "/api/v1/external/skwipe/enrich-profile/", "billing_url": "/api/v1/billing/purchase-credits/" }

Copy { "success": false, "error": { "code": 429, "message": "Rate limit exceeded. Please slow down your requests.", "type": "Throttled", "details": { "detail": "Request was throttled. Expected available in 35 seconds." }, "retry_after": 35 // Seconds }, "timestamp": "2024-07-29T12:03:00Z", "path": "/api/v1/external/jobs/" }

Copy const fetch = require('node-fetch'); // Or use axios or native fetch in browser/modern Node class SkwipeAPIClient { constructor(apiKey) { this.apiKey = apiKey; this.baseUrl = 'https://skwipe.com/api/v1'; this.headers = { 'Authorization': `Bearer ${apiKey}`, 'Content-Type': 'application/json', 'Accept': 'application/json' }; } async _request(method, endpoint, params = null, body = null) { let url = `${this.baseUrl}${endpoint}`; if (params) { url += `?${new URLSearchParams(params)}`; } try { const response = await fetch(url, { method: method, headers: this.headers, body: body ? JSON.stringify(body) : null, timeout: 30000 }); const responseData = await response.json(); if (!response.ok) { console.error(`API Error: ${response.status} - ${JSON.stringify(responseData)}`); } return responseData; } catch (error) { console.error(`Request Exception: ${error}`); return { error: error.message }; } } async searchCompanies(searchQuery, city = null, page = 1, pageSize = 20) { const params = { search: searchQuery, page, page_size: pageSize }; if (city) params.city = city; return this._request('GET', '/external/companies/', params); } async enrichProfileByLinkedin(linkedinUrl) { const body = { linkedin_url: linkedinUrl }; return this._request('POST', '/external/skwipe/enrich-profile/', null, body); } async getKeyInfo() { return this._request('GET', '/key-info/'); } } // Usage example: // (async () => { // const client = new SkwipeAPIClient('YOUR_API_KEY'); // const companies = await client.searchCompanies('software', { city: 'New York' }); // console.log(JSON.stringify(companies, null, 2)); // const profileInfo = await client.enrichProfileByLinkedin('https://www.linkedin.com/in/example'); // console.log(JSON.stringify(profileInfo, null, 2)); // })();

Copy <?php class SkwipeAPIClient { private $apiKey; private $baseUrl = 'https://skwipe.com/api/v1'; public function __construct($apiKey) { $this->apiKey = $apiKey; } private function _request($method, $endpoint, $params = null, $data = null) { $url = $this->baseUrl . $endpoint; if ($params) { $url .= '?' . http_build_query($params); } $headers = [ 'Authorization: Bearer ' . $this->apiKey, 'Content-Type: application/json', 'Accept: application/json' ]; $ch = curl_init(); curl_setopt($ch, CURLOPT_URL, $url); curl_setopt($ch, CURLOPT_RETURNTRANSFER, true); curl_setopt($ch, CURLOPT_HTTPHEADER, $headers); curl_setopt($ch, CURLOPT_TIMEOUT, 30); if ($method === 'POST') { curl_setopt($ch, CURLOPT_POST, true); if ($data) { curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($data)); } } elseif ($method !== 'GET') { curl_setopt($ch, CURLOPT_CUSTOMREQUEST, $method); } $response = curl_exec($ch); $httpCode = curl_getinfo($ch, CURLINFO_HTTP_CODE); if (curl_errno($ch)) { $error_msg = curl_error($ch); curl_close($ch); error_log("cURL Error: " . $error_msg); return ['error' => $error_msg]; } curl_close($ch); $decodedResponse = json_decode($response, true); if ($httpCode >= 400) { error_log("API Error: " . $httpCode . " - " . $response); } return $decodedResponse; } public function searchCompanies($searchQuery, $city = null, $page = 1, $pageSize = 20) { $params = ['search' => $searchQuery, 'page' => $page, 'page_size' => $pageSize]; if ($city) $params['city'] = $city; return $this->_request('GET', '/external/companies/', $params); } public function enrichProfileByLinkedin($linkedinUrl) { $data = ['linkedin_url' => $linkedinUrl]; return $this->_request('POST', '/external/skwipe/enrich-profile/', null, $data); } public function getKeyInfo() { return $this->_request('GET', '/key-info/'); } } // Usage example: // $client = new SkwipeAPIClient('YOUR_API_KEY'); // $companies = $client->searchCompanies('consulting', ['city' => 'Berlin']); // echo json_encode($companies, JSON_PRETTY_PRINT); // $profileInfo = $client->enrichProfileByLinkedin('https://www.linkedin.com/in/example'); // echo json_encode($profileInfo, JSON_PRETTY_PRINT); ?>