Docs - Apitty 🚀 The Lightweight, Scalable API Platform Built for Developers

Overview

Apitty is a comprehensive API-as-a-Service platform providing 91 validation endpoints for all your data validation needs. Built with a developer-first approach, it offers robust validation for:

✉️ Email & Phone - Advanced email verification with domain suggestions, international phone validation
🌐 URLs & Domains - URL accessibility checking, domain validation with DNS/SSL analysis
🌍 IP & Geolocation - IPv4/IPv6 validation, geolocation data, security analysis
💳 Financial Data - Credit cards, IBANs, routing numbers, SWIFT codes, tax IDs
📄 Data Formats - JSON/XML/CSV validation with detailed analysis
📍 Geographic Data - Address validation, coordinate verification with format conversion
🔐 Security - JWT tokens, hash generation, API key validation
🛠️ Developer Tools - Regex testing, version validation, color format conversion, UUID generation, cron validation
🎯 Modern Web - Cryptocurrency addresses, QR codes, file security scanning
📝 Content Analysis - Text sentiment, language detection, password strength, HTML/Markdown validation
👥 Social Validation - Username validation for major platforms, Discord ID parsing
🏢 Business Data - Registration numbers, license plates for international formats
🌐 Network Tools - MAC address validation with vendor lookup, subnet calculations
📦 Bulk Operations - Batch processing for emails, mixed data types, CSV parsing
🕐 Time & Date - Date format validation, timezone verification, business hours validation
📄 Document Processing - Base64 validation, MIME type checking, file signature detection
🌐 Communication - SMTP server validation, WebSocket URL checking, SIP URI validation
📦 E-commerce - Tracking numbers, barcode validation, SKU format checking
🎮 Gaming & Social - Steam ID, Xbox Gamertag, Minecraft UUID validation
🆔 Identity Documents - Passport, license, national ID validation with privacy protection
📏 Units & Measurement - Temperature, currency, measurement unit conversion and validation
🏥 Healthcare & Medical - NDC drug codes, ICD diagnostic codes, DEA numbers, NPI healthcare provider IDs
🚗 Automotive & Transportation - VIN decoding, tire sizes, flight numbers, shipping container validation
🎓 Education & Academic - Enhanced ISBN with conversion, DOI validation, ORCID researcher IDs, school codes
🎬 Media & Entertainment - IMDb ID validation, ISRC music codes, color palette analysis with accessibility
⚖️ Legal & Compliance - Court case numbers, patent/trademark validation, comprehensive GDPR analysis
📱 Telecommunications - IMEI device validation, carrier codes, international calling codes

Getting Started

Welcome to Apitty! This API-as-a-Service platform is designed to provide comprehensive validation services without the need for self-hosting or complex setup.

Quick Setup

To get started with Apitty, you'll need to:

Sign up for an account (coming soon)
Generate your API key from the dashboard
Make your first validation API call

Quick Start

# Clone and setup (for local development)
git clone https://github.com/your-username/apitty.git
cd apitty
npm install

# Run development server
npm run dev

# The API will be available at https://api.apitty.com

Health Check

curl https://api.apitty.com/health

Authentication

Apitty uses API keys for authentication. Include your API key in the Authorization header of your requests:

Authorization: Bearer YOUR_API_KEY

Keep your API keys secure and never commit them to public repositories. You can manage your API keys from your dashboard.

Validation Categories

Apitty organizes its 91 endpoints into logical categories for easy discovery and use:

Core Validation

Essential validation services for common data types:

POST /email/verify - Email validation with domain suggestions
POST /phone/verify - International phone number validation
POST /url/verify - URL accessibility and security checking
POST /ip/verify - IP validation with geolocation data
POST /domain/verify - Domain validation with DNS/SSL analysis
POST /credit-card/verify - Credit card validation with Luhn check
POST /text/analyze - Text analysis with sentiment and language detection
POST /password/analyze - Password strength analysis

Data Format Validation

Validate structured data formats:

POST /format/json - JSON syntax and structure validation
POST /format/xml - XML well-formedness checking
POST /format/csv - CSV structure and data type analysis

Financial Validation

Comprehensive financial data validation:

POST /financial/iban - IBAN validation with checksum
POST /financial/routing - Bank routing number validation
POST /financial/swift - SWIFT code validation
POST /financial/tax-id - Tax ID validation (SSN/EIN/VAT)

Geographic Validation

Location and address validation services:

POST /geo/address - Address format validation
POST /geo/coordinates - Coordinate validation with conversion

Security & Developer Tools

Security validation and development utilities:

POST /security/jwt - JWT token validation
POST /security/hash - Hash generation and comparison
POST /security/api-key - API key strength analysis
POST /dev-tools/regex - Regex pattern validation and testing
POST /dev-tools/version - Semantic version validation
POST /dev-tools/color - Color format validation and conversion

Modern Web Validation

Contemporary web development validation needs:

POST /modern/crypto-address - Cryptocurrency address validation
POST /modern/qr - QR code validation and generation prep
POST /modern/file - File security scanning and validation

Additional Validation Services

Extended validation utilities:

POST /format/uuid - UUID format and version validation
POST /format/base64 - Base64 encoding validation and decoding
POST /network/mac - MAC address format validation

All Available Endpoints

Complete list of all 91 validation endpoints organized by category. All endpoints are accessible via https://api.apitty.com/:

Complete reference of all 91 endpoints:

Category	Endpoint	Description
Core	POST /email/verify	Email validation with domain suggestions
	POST /phone/verify	International phone number validation
	POST /url/verify	URL accessibility and security checking
	POST /ip/verify	IP validation with geolocation data
	POST /domain/verify	Domain validation with DNS/SSL analysis
	POST /credit-card/verify	Credit card validation with Luhn check
	POST /text/analyze	Text analysis with sentiment and language detection
	POST /password/analyze	Password strength analysis
Format	POST /format/json	JSON syntax and structure validation
	POST /format/xml	XML well-formedness checking
	POST /format/csv	CSV structure and data type analysis
Geographic	POST /geo/address	Address format validation
	POST /geo/coordinates	Coordinate validation with conversion
Financial	POST /financial/iban	IBAN validation with checksum
	POST /financial/routing	Bank routing number validation
	POST /financial/swift	SWIFT code validation
	POST /financial/tax-id	Tax ID validation (SSN/EIN/VAT)
Security	POST /security/jwt	JWT token validation
	POST /security/hash	Hash generation and comparison
	POST /security/api-key	API key strength analysis
Dev Tools	POST /dev-tools/regex	Regex pattern validation and testing
	POST /dev-tools/version	Semantic version validation
	POST /dev-tools/color	Color format validation and conversion
Modern Web	POST /modern/crypto-address	Cryptocurrency address validation
	POST /modern/qr	QR code validation and generation prep
	POST /modern/file	File security scanning and validation
Social	POST /social/username	Username validation for major platforms
	POST /social/discord-id	Discord snowflake ID validation
Business	POST /business/registration	Business registration numbers
	POST /business/license-plate	License plate validation
Network	POST /network/mac-address	MAC address validation with vendor lookup
	POST /network/subnet	Subnet/CIDR validation
	GET /network/generate-mac	Generate random valid MAC addresses
Content	POST /content/html	HTML validation with security scanning
	POST /content/markdown	Markdown validation with TOC generation
Bulk	POST /bulk/emails	Batch email validation (up to 100)
	POST /bulk/mixed	Auto-detect mixed data types
	POST /bulk/csv-parse	CSV parsing with validation
Advanced	POST /advanced/uuid	UUID validation with version ID
	POST /advanced/uuid/generate	Generate UUIDs (v1, v4)
	POST /advanced/cron	Cron expression validation
Time & Date	POST /time/date	Date format validation
	POST /time/timezone	Timezone validation with DST
	POST /time/business-hours	Business hours validation
Document	POST /document/base64	Base64 validation with content detection
	POST /document/mime-type	MIME type validation
	POST /document/signature	File signature validation
Protocol	POST /protocol/smtp	SMTP server validation
	POST /protocol/websocket	WebSocket URL validation
	POST /protocol/sip	SIP URI validation
E-commerce	POST /ecommerce/tracking	Multi-carrier tracking validation
	POST /ecommerce/barcode	Barcode validation (UPC/EAN/ISBN)
	POST /ecommerce/sku	SKU format validation
Gaming	POST /gaming/steam-id	Steam ID validation
	POST /gaming/xbox-gamertag	Xbox Gamertag validation
	POST /gaming/minecraft-uuid	Minecraft UUID validation
Identity	POST /identity/passport	Passport validation
	POST /identity/license	Driver's license validation
	POST /identity/national-id	National ID validation
Units	POST /units/temperature	Temperature conversion
	POST /units/currency	Currency validation
	POST /units/measurement	Measurement conversion
Medical	POST /medical/ndc	National Drug Code validation
	POST /medical/icd	ICD-10/11 diagnostic codes
	POST /medical/dea	DEA prescriber number validation
	POST /medical/npi	National Provider Identifier
Automotive	POST /automotive/vin	VIN validation with decoding
	POST /automotive/tire-size	Tire size validation
	POST /automotive/flight-number	Flight number validation
	POST /automotive/container	Shipping container validation
Education	POST /education/isbn	Enhanced ISBN validation
	POST /education/doi	Digital Object Identifier validation
	POST /education/orcid	ORCID researcher ID validation
	POST /education/school-code	Educational institution codes
Media	POST /media/imdb	IMDb ID validation
	POST /media/isrc	International Standard Recording Code
	POST /media/color-palette	Color palette validation
Legal	POST /legal/case-number	Court case number validation
	POST /legal/patent	Patent number validation
	POST /legal/trademark	Trademark registration validation
	POST /legal/gdpr-compliance	GDPR compliance analysis
Telecom	POST /telecom/imei	IMEI validation with device info
	POST /telecom/carrier-code	Mobile carrier code validation
	POST /telecom/calling-code	International calling codes

Quick Examples

# Email Validation
curl -X POST https://api.apitty.com/email/verify \
  -H "Content-Type: application/json" \
  -d '{"email": "user@example.com", "check_suggestions": true}'

# Financial Validation
curl -X POST https://api.apitty.com/financial/iban \
  -H "Content-Type: application/json" \
  -d '{"iban": "DE89 3704 0044 0532 0130 00"}'

# Geographic Validation  
curl -X POST https://api.apitty.com/geo/address \
  -H "Content-Type: application/json" \
  -d '{"street": "123 Main St", "city": "Prague", "postal_code": "110 00", "country": "CZ"}'

Response Format

All Apitty endpoints return a consistent response structure for predictable integration:

{
  "success": true,
  "data": {
    "valid": true,
    "checks": { "format": true, "length": true },
    "analysis": { "detailed": "results" }
  },
  "credits_used": 1,
  "timestamp": "2025-08-10T10:30:00.000Z"
}

Response Fields

success - Boolean indicating if the API call was successful
data - Object containing validation results and analysis
data.valid - Boolean indicating if the validated data is valid
data.checks - Object with detailed validation check results
data.analysis - Additional analysis and suggestions (when available)
credits_used - Number of credits consumed by this request
timestamp - ISO 8601 timestamp of the request

Code Examples

JavaScript/Node.js

const response = await fetch('https://api.apitty.com/email/verify', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({ email: 'test@example.com' })
});

const result = await response.json();
console.log(result.data.valid); // true/false

Python

import requests

headers = {
    'Authorization': 'Bearer YOUR_API_KEY',
    'Content-Type': 'application/json'
}

response = requests.post('https://api.apitty.com/format/json', 
    headers=headers,
    json={'data': '{"key": "value"}'})
    
result = response.json()
print(result['data']['valid'])

cURL

Quick email validation:

curl -X POST https://api.apitty.com/email/verify \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"email": "user@domain.com"}' | jq '.data.valid'

Credit System

Apitty uses a credit-based pricing model where different validation types consume different amounts of credits based on computational complexity:

Credit Consumption

Basic validation (format checks, simple rules): 1 credit
Network operations (DNS lookups, URL accessibility): +1 credit
Enhanced features (geolocation data, security analysis): +1-2 credits
Complex analysis (sentiment analysis, multiple text features): 1 credit per feature

Credit Tracking

Every API response includes the credits_used field so you can monitor your consumption in real-time.

Rate Limits & Security

Apitty implements comprehensive security measures and rate limiting:

Rate Limits

Standard Rate Limit: 100 requests per 15 minutes per IP
Request Size Limit: 10MB maximum payload
Custom Limits: Available for enterprise plans

Security Features

Security Headers: Comprehensive security headers via Helmet.js
CORS Protection: Cross-origin resource sharing controls
Input Validation: Joi schema validation on all endpoints
API Key Management: Secure token-based authentication

Rate limit information is included in response headers:

X-RateLimit-Limit: 100
X-RateLimit-Remaining: 99
X-RateLimit-Reset: 1640995200

Error Handling

Apitty uses conventional HTTP response codes to indicate the success or failure of API requests.

HTTP Status Codes

200 OK - Request successful
400 Bad Request - Invalid request parameters
401 Unauthorized - Invalid or missing API key
429 Too Many Requests - Rate limit exceeded
500 Internal Server Error - Server error

Error Response Format

{
  "success": false,
  "error": {
    "type": "validation_error",
    "message": "Invalid email format provided",
    "code": "INVALID_EMAIL_FORMAT"
  },
  "timestamp": "2025-08-10T10:30:00.000Z"
}

Common Error Codes

INVALID_API_KEY - API key is missing or invalid
RATE_LIMIT_EXCEEDED - Too many requests in time window
VALIDATION_ERROR - Input data validation failed
INSUFFICIENT_CREDITS - Not enough credits to complete request
PAYLOAD_TOO_LARGE - Request payload exceeds 10MB limit

apitty

API Documentation