OneSimpleAPI

https://onesimpleapi.com/docs
Admin
OneSimpleAPI offers a suite of easy-to-use APIs for various web development tasks, including...
Tokens:89,829
Snippets:1,163
Trust Score:6.6
Update:3 months ago
Show doc for...
Tokens:
Raw
### Configure PDF output parameters

Source: https://onesimpleapi.com/docs/url-to-pdf-converter-api

Example of a GET request using specific parameters like page size and background rendering.

```http
GET https://onesimpleapi.com/api/pdf
    ?token=YOUR_TOKEN
    &url=https://example.com/report
    &page=a4
    &background=true
```

--------------------------------

### Example Link Expansion Scenarios

Source: https://onesimpleapi.com/docs/easily-expand-shortened-link-urls-with-onesimpleapi

Illustrative examples of how shortened links resolve to their final destinations in various contexts.

```text
Original: https://bit.ly/bank-notice
Expanded: https://fake-bank-login.scam.com/steal-credentials
```

```text
Original: https://t.co/xyz123
Expanded: https://news-site.com/legitimate-article
```

```text
Original: https://short.link/promo
Expanded: https://amazon.com/product?tag=correct-affiliate-id
```

--------------------------------

### Install requests dependency

Source: https://onesimpleapi.com/docs/html-to-pdf-api-python

Install the required requests library to perform HTTP calls.

```bash
pip install requests
```

--------------------------------

### Create a short link via GET request

Source: https://onesimpleapi.com/docs/url-shortener-api

Send a GET request with the destination URL and your API token to generate a short link.

```http
GET https://onesimpleapi.com/api/shortener/new
    ?token=YOUR_TOKEN
    &url=https://example.com/a-very-long-destination-url
    &output=json
```

```json
{
  "url": "https://example.com/a-very-long-destination-url",
  "single_use": false,
  "temporary_redirect": false,
  "forward_params": false,
  "short_url": "https://opq.to/1V9O4"
}
```

--------------------------------

### API Output Format Options

Source: https://onesimpleapi.com/docs/image-info

Examples of API request URLs demonstrating different output formats.

```http
https://onesimpleapi.com/api/image_info?token=YOUR_TOKEN_GOES_HERE& output=text&url=https://github.com/ianare/exif-samples/blob/master/jpg/gps/DSCN0010.jpg?raw=true
```

```http
https://onesimpleapi.com/api/image_info?token=YOUR_TOKEN_GOES_HERE& output=csv&url=https://github.com/ianare/exif-samples/blob/master/jpg/gps/DSCN0010.jpg?raw=true
```

```http
https://onesimpleapi.com/api/image_info?token=YOUR_TOKEN_GOES_HERE& output=for_google_docs&url=https://github.com/ianare/exif-samples/blob/master/jpg/gps/DSCN0010.jpg?raw=true
```

```http
https://onesimpleapi.com/api/image_info?token=YOUR_TOKEN_GOES_HERE& output=json&url=https://github.com/ianare/exif-samples/blob/master/jpg/gps/DSCN0010.jpg?raw=true
```

--------------------------------

### GET /api/discount_calculator

Source: https://onesimpleapi.com/docs/ppp-discount-calculator

Calculates the PPP-based discount for a given price and location.

```APIDOC
## GET /api/discount_calculator

### Description
Calculates a discounted price based on the origin country of the product and the customer's country or IP address.

### Method
GET

### Endpoint
/api/discount_calculator

### Parameters
#### Query Parameters
- **token** (string) - Required - Your API authentication token.
- **origin_country_code** (string) - Required - The 2-letter ISO Alpha-2 country code where the price is defined.
- **price** (number) - Required - The original price of the product.
- **max_discount** (number) - Optional - The maximum discount percentage to apply (default: 30).
- **destination_country_code** (string) - Optional - The 2-letter ISO Alpha-2 country code of the customer.
- **destination_user_ip** (string) - Optional - The IP address (IPv4 or IPv6) of the customer.
- **output** (string) - Optional - The desired response format: text, csv, for_google_docs, or json.
```

--------------------------------

### Convert Currency via API

Source: https://onesimpleapi.com/docs/exchange-rate

Example URL for converting 235 Euros to British Pounds.

```html
<a href="https://onesimpleapi.com/api/exchange_rate?token=YOUR_TOKEN_GOES_HERE&from_currency=EUR&to_currency=GBP&from_value=235
```

--------------------------------

### Capture a website screenshot

Source: https://onesimpleapi.com/docs/website-screenshot-api-capture-any-page-programmatically

Examples of how to request a screenshot from the API and retrieve the resulting CDN URL.

```javascript
// Capture a screenshot with JavaScript
async function captureScreenshot(url) {
  const apiUrl = new URL("https://onesimpleapi.com/api/screenshot");
  apiUrl.searchParams.set("token", "YOUR_API_TOKEN");
  apiUrl.searchParams.set("url", url);
  apiUrl.searchParams.set("output", "json");

  const response = await fetch(apiUrl);
  const data = await response.json();

  return data.url; // CDN URL to the screenshot
}

const screenshot = await captureScreenshot("https://example.com");
console.log("Screenshot saved:", screenshot);
```

```python
import requests

def capture_screenshot(url):
    response = requests.get(
        "https://onesimpleapi.com/api/screenshot",
        params={
            "token": "YOUR_API_TOKEN",
            "url": url,
            "output": "json",
        },
    )
    return response.json()["url"]

screenshot_url = capture_screenshot("https://example.com")
print(f"Screenshot saved: {screenshot_url}")
```

--------------------------------

### GET /api/shortener/new

Source: https://onesimpleapi.com/docs/url-shortener

Creates a new shortened URL with optional configuration parameters.

```APIDOC
## GET /api/shortener/new

### Description
Creates a new shortened URL. You can customize the behavior using various query parameters.

### Method
GET

### Endpoint
https://onesimpleapi.com/api/shortener/new

### Parameters
#### Query Parameters
- **token** (string) - Required - Your API token.
- **url** (string) - Required - The destination URL to shorten.
- **single_use** (boolean) - Optional - If true, the short URL is usable only once.
- **temporary_redirect** (boolean) - Optional - If true, uses a temporary redirect instead of permanent.
- **forward_params** (boolean) - Optional - If true, forwards extra query parameters to the destination.
- **start_date** (string) - Optional - Date when the link starts working (YYYY-MM-DD).
- **end_date** (string) - Optional - Date when the link stops working (YYYY-MM-DD).
- **output** (string) - Optional - Response format (text, csv, for_google_docs, json).
```

--------------------------------

### Call the API using cURL

Source: https://onesimpleapi.com/docs/url-to-pdf-converter-api

Command-line example for requesting a PDF conversion with encoded parameters.

```bash
curl -G "https://onesimpleapi.com/api/pdf" \
  --data-urlencode "token=YOUR_TOKEN" \
  --data-urlencode "url=https://example.com/report" \
  --data-urlencode "page=a4" \
  --data-urlencode "background=true" \
  --data-urlencode "output=json"
```

--------------------------------

### Create a Short URL

Source: https://onesimpleapi.com/docs/url-shortener

Example request and response for generating a short URL using the OneSimpleApi endpoint.

```http
https://onesimpleapi.com/api/shortener/new&token=YOUR_TOKEN_GOES_HERE&output=json&url=https://onesimpleapi.com/docs
```

```json
{
    "url": "https://onesimpleapi.com/docs",
    "single_use": false,
    "temporary_redirect": false,
    "forward_params": false,
    "short_url": "https://opq.to/1V9O4"
}
```

--------------------------------

### GET https://onesimpleapi.com/api/shortener/new

Source: https://onesimpleapi.com/docs/url-shortener-api

Creates a new short link by providing a destination URL and optional configuration parameters.

```APIDOC
## GET https://onesimpleapi.com/api/shortener/new

### Description
Creates a new short link from a destination URL. The returned short URL is live immediately and redirects to the destination.

### Method
GET

### Endpoint
https://onesimpleapi.com/api/shortener/new

### Parameters
#### Query Parameters
- **token** (string) - Required - Your API authentication token.
- **url** (string) - Required - The destination URL to shorten.
- **output** (string) - Optional - The format of the response (e.g., json).
- **custom_url** (string) - Optional - A custom slug for the short link.
- **single_use** (boolean) - Optional - If true, the link deactivates after one use.
- **temporary_redirect** (boolean) - Optional - If true, uses a 302 redirect instead of 301.
- **forward_params** (boolean) - Optional - If true, passes extra query parameters to the destination.
- **start_date** (string) - Optional - Date when the link becomes active.
- **end_date** (string) - Optional - Date when the link expires.

### Response
#### Success Response (200)
- **url** (string) - The original destination URL.
- **single_use** (boolean) - Whether the link is single-use.
- **temporary_redirect** (boolean) - Whether the link uses a 302 redirect.
- **forward_params** (boolean) - Whether parameters are forwarded.
- **short_url** (string) - The generated short URL.

#### Response Example
{
  "url": "https://example.com/a-very-long-destination-url",
  "single_use": false,
  "temporary_redirect": false,
  "forward_params": false,
  "short_url": "https://opq.to/1V9O4"
}
```

--------------------------------

### GET /api/files/delete

Source: https://onesimpleapi.com/docs/managing-files

Deletes a specific file using a GET request.

```APIDOC
## GET /api/files/delete

### Description
Deletes a file by providing its URL via a GET request.

### Method
GET

### Endpoint
https://onesimpleapi.com/api/files/delete

### Parameters
#### Query Parameters
- **token** (string) - Required - Your access token.
- **url** (string) - Required - The URL of the file to delete.
```

--------------------------------

### Build-time Reading Time Calculation

Source: https://onesimpleapi.com/docs/how-to-calculate-reading-time-for-blog-posts

Example logic for integrating reading time calculations into a static site generator build process.

```python
# Build script
for post in posts:
    analysis = calculate_reading_time(post.content, API_TOKEN)
    post.reading_time = analysis['minutes']
    post.save()
```

--------------------------------

### Implement PPP Pricing with Python

Source: https://onesimpleapi.com/docs/simplifying-global-pricing-with-onesimpleapi-s-ppp-discount-calculator

A wrapper class for the OneSimpleAPI PPP Discount Calculator that supports price lookups by country code or user IP address.

```python
import requests

class PPPPricing:
    def __init__(self, api_token, base_price, max_discount=40):
        self.token = api_token
        self.base_price = base_price
        self.max_discount = max_discount

    def get_price(self, country_code):
        response = requests.get(
            'https://onesimpleapi.com/api/discount_calculator',
            params={
                'token': self.token,
                'price': self.base_price,
                'origin_country_code': 'US',
                'destination_country_code': country_code,
                'max_discount': self.max_discount,
                'output': 'json'
            }
        )
        return response.json()

    def get_price_by_ip(self, user_ip):
        response = requests.get(
            'https://onesimpleapi.com/api/discount_calculator',
            params={
                'token': self.token,
                'price': self.base_price,
                'origin_country_code': 'US',
                'destination_user_ip': user_ip,
                'max_discount': self.max_discount,
                'output': 'json'
            }
        )
        return response.json()

# Usage
pricing = PPPPricing('your_token', 99, max_discount=40)
brazil = pricing.get_price('BR')
print(f"Brazil price: ${brazil['discounted_price_in_origin_currency']}")
```

--------------------------------

### GET /api/screenshot

Source: https://onesimpleapi.com/docs/screenshot

Generates a screenshot of a specified website URL. The API is accessed via a GET request with query parameters for authentication, target URL, and output format.

```APIDOC
## GET /api/screenshot

### Description
Generates a screenshot of the provided website URL. This endpoint can be used directly in HTML image tags, social media meta tags, or spreadsheet functions.

### Method
GET

### Endpoint
https://onesimpleapi.com/api/screenshot

### Parameters
#### Query Parameters
- **token** (string) - Required - Your unique API access token.
- **url** (string) - Required - The URL of the website to capture.
- **output** (string) - Optional - The output format or behavior (e.g., 'redirect' for direct image display, 'spreadsheet_image' for Google Sheets).
```

--------------------------------

### Optimize Product Listing Thumbnails

Source: https://onesimpleapi.com/docs/image-optimization-best-practices-for-e-commerce-websites

Use lazy loading and optimized parameters for fast-loading product grid images.

```html
<div class="product-grid">
  <img
    src="https://onesimpleapi.com/api/image_manager?token=TOKEN&image=SOURCE&width=300&height=300&format=webp&quality=80"
    loading="lazy"
    alt="Product Name"
  />
</div>
```

--------------------------------

### Generate a QR code via HTTP GET

Source: https://onesimpleapi.com/docs/qr-code-api

Perform a GET request to the API endpoint to generate a QR code, specifying the message, format, and output type.

```http
GET https://onesimpleapi.com/api/qr_code
    ?token=YOUR_TOKEN
    &message=https://example.com
    &format=svg
    &size=large
    &output=json
```

```json
{
  "success": true,
  "qr_url": "https://cdn.onesimpleapi.com/qr/abc123.svg"
}
```

--------------------------------

### Implement Responsive Product Page Images

Source: https://onesimpleapi.com/docs/image-optimization-best-practices-for-e-commerce-websites

Use the picture element with srcset to serve appropriately sized images based on device viewport.

```html
<picture>
  <!-- WebP for modern browsers -->
  <source
    type="image/webp"
    srcset="
      ...&width=600&format=webp 600w,
      ...&width=1200&format=webp 1200w,
      ...&width=2000&format=webp 2000w
    "
  />
  <!-- JPEG fallback -->
  <img
    srcset="
      ...&width=600 600w,
      ...&width=1200 1200w,
      ...&width=2000 2000w
    "
    sizes="(max-width: 600px) 100vw, 50vw"
    alt="Product Name"
  />
</picture>
```

--------------------------------

### Calculate PPP discounts with Python

Source: https://onesimpleapi.com/docs/what-is-purchasing-power-parity-saas-guide

Uses the requests library to fetch localized pricing data from the OneSimpleAPI PPP Discount Calculator.

```python
import requests

def get_ppp_discount(country_code, base_price, api_token):
    response = requests.get('https://onesimpleapi.com/api/discount_calculator', params={
        'token': api_token,
        'price': base_price,
        'origin_country_code': 'US',
        'destination_country_code': country_code,
        'max_discount': 50,
        'output': 'json'
    })
    data = response.json()
    
    return {
        'country': data['destination_country_name'],
        'theoretical_discount': data['ppp_theoretical_discount'],
        'applied_discount': data['discount'],
        'final_price': data['discounted_price_in_origin_currency']
    }

# Example
brazil = get_ppp_discount('BR', 99, 'your_token')
# Returns: {'country': 'Brazil', 'theoretical_discount': 52, 'applied_discount': 50, 'final_price': 49.5}
```

--------------------------------

### GET /api/page_status

Source: https://onesimpleapi.com/docs/web-page-status-and-certificate

Retrieves the status and certificate information for a specified URL.

```APIDOC
## GET /api/page_status

### Description
Checks the status and SSL certificate details for a provided URL. The output format can be customized based on the intended use case.

### Method
GET

### Endpoint
/api/page_status

### Parameters
#### Query Parameters
- **token** (string) - Required - Your API authentication token.
- **url** (string) - Required - The URL to check. Ensure complex URLs containing &, ?, or / are encoded.
- **output** (string) - Optional - The format of the response. Options: text (default), csv, for_google_docs, json.
```

--------------------------------

### Perform a basic API request

Source: https://onesimpleapi.com/docs/unlock-the-power-of-purchase-parity-pricing-with-the-discount-calculator-api

Use this cURL command to calculate a discounted price by providing your API token, base price, and location details.

```bash
curl "https://onesimpleapi.com/api/discount_calculator?token=YOUR_TOKEN&price=99&origin_country_code=US&destination_country_code=BR&max_discount=40&output=json"
```

--------------------------------

### GET /api/shortener

Source: https://onesimpleapi.com/docs/url-shortener

Retrieves a list of all shortened URLs created by the user.

```APIDOC
## GET /api/shortener

### Description
Returns a list of all shortened URLs associated with the provided API token.

### Method
GET

### Endpoint
https://onesimpleapi.com/api/shortener

### Parameters
#### Query Parameters
- **token** (string) - Required - Your API token.
```

--------------------------------

### Implement Color API in React

Source: https://onesimpleapi.com/docs/unlock-your-creativity-with-our-color-and-color-palette-generator

A practical example demonstrating how to fetch color data based on a username and apply it to a React component's style.

```javascript
async function getAvatarColor(username) {
  const response = await fetch(
    `https://onesimpleapi.com/api/color?` +
    `token=${API_TOKEN}&text=${encodeURIComponent(username)}&output=json`
  );

  const data = await response.json();
  return {
    primary: data.hex,
    palette: data.hex_palette
  };
}

// Usage in a React component
function UserAvatar({ username }) {
  const [colors, setColors] = useState({ primary: '#ccc', palette: [] });

  useEffect(() => {
    getAvatarColor(username).then(setColors);
  }, [username]);

  const initials = username.slice(0, 2).toUpperCase();

  return (
    <div style={{ backgroundColor: colors.primary }} className="avatar">
      {initials}
    </div>
  );
}
```

--------------------------------

### Create Design Tokens with Python

Source: https://onesimpleapi.com/docs/get-your-design-project-to-success-with-onesimpleapi-s-color-palette-generator-the-all-in-one-toolbox-you-need

Generates a structured dictionary of design tokens including primary, accent, and semantic colors using the ColorHelper class.

```python
def create_design_tokens(brand_color, api_token):
    """Create design tokens from one brand color."""
    helper = ColorHelper(api_token)
    
    primary = helper.get_all_formats(brand_color)
    
    return {
        'primary': {
            'hex': primary['hex'],
            'rgb': primary['rgb'],
            'hsl': primary['hsl']
        },
        'accents': primary['hex_palette'],
        'neutral': helper.get_all_formats('#808080'),
        'success': helper.get_all_formats('#22c55e'),
        'warning': helper.get_all_formats('#eab308'),
        'error': helper.get_all_formats('#ef4444'),
    }
```

--------------------------------

### GET https://onesimpleapi.com/api/spotify_profile

Source: https://onesimpleapi.com/docs/spotify-profile

Retrieves detailed information about a specific Spotify profile.

```APIDOC
## GET https://onesimpleapi.com/api/spotify_profile

### Description
Obtain Spotify profile details including name, followers, popularity, picture, monthly listeners, biography, social media links, top songs, and top listeners locations.

### Method
GET

### Endpoint
https://onesimpleapi.com/api/spotify_profile

### Parameters
#### Query Parameters
- **token** (string) - Required - Your access token.
- **profile** (string) - Required - The Profile code or Artist name.
- **output** (string) - Optional - The format of the response (json, csv, for_google_docs).
- **country** (string) - Optional - The 2-letter country code for top songs (default: US).

### Response
#### Success Response (200)
- **name** (string) - The name of the profile.
- **picture** (string) - URL to the profile picture.
- **external_url** (string) - URL to the Spotify profile.
- **followers** (integer) - Number of followers.
- **popularity** (integer) - Popularity score.
- **monthly_listeners** (integer) - Number of monthly listeners.
- **type** (string) - Type of profile (e.g., artist).
- **bio** (string) - Biography of the profile.
- **social_media** (array) - List of social media links.
- **top** (array) - List of top songs.
- **listeners** (array) - List of listeners by location.

### Response Example
{
  "name": "Olivia Rodrigo",
  "picture": "https://onesimpleapi.com/storage/spotify/5034983c70523c76d767aca6ac951645.jpg",
  "external_url": "https://open.spotify.com/artist/1McMsnEElThX1knmY4oliG",
  "followers": 10242518,
  "popularity": 91,
  "monthly_listeners": 45160235,
  "type": "artist",
  "bio": "hi there! my name is olivia!",
  "social_media": [{"name": "INSTAGRAM", "url": "https://instagram.com/oliviarodrigo/?hl=en"}],
  "top": [{"name": "good 4 u", "popularity": 94}],
  "listeners": [{"location": "Jakarta,ID", "listeners": "1,022,984"}]
}
```

--------------------------------

### Implement Responsive Image Sizes via URL Parameters

Source: https://onesimpleapi.com/docs/the-benefits-of-responsive-images-and-how-to-implement-them

Use the width parameter to generate different image sizes from a single source URL.

```html
<!-- Desktop: Full size -->
<img src="https://onesimpleapi.com/api/image_manager?token=TOKEN&image=SOURCE&width=1200" />

<!-- Tablet -->
<img src="https://onesimpleapi.com/api/image_manager?token=TOKEN&image=SOURCE&width=800" />

<!-- Mobile -->
<img src="https://onesimpleapi.com/api/image_manager?token=TOKEN&image=SOURCE&width=400" />
```

--------------------------------

### Create a Color Helper Class in Python

Source: https://onesimpleapi.com/docs/get-your-design-project-to-success-with-onesimpleapi-s-color-palette-generator-the-all-in-one-toolbox-you-need

Encapsulate color retrieval and format conversion logic within a class.

```python
class ColorHelper:
    def __init__(self, api_token):
        self.api_token = api_token

    def get_all_formats(self, color):
        """Get a color in all formats."""
        response = requests.get(
            'https://onesimpleapi.com/api/color',
            params={
                'token': self.api_token,
                'text': color,
                'output': 'json'
            }
        )
        return response.json()

    def for_css(self, color):
        """Return HEX for CSS."""
        return self.get_all_formats(color)['hex']

    def for_canvas(self, color):
        """Return RGB string for HTML canvas."""
        rgb = self.get_all_formats(color)['rgb']
        return f"rgb({rgb[0]}, {rgb[1]}, {rgb[2]})"

    def for_design_tool(self, color):
        """Return HSL for design tools."""
        hsl = self.get_all_formats(color)['hsl']
        return f"hsl({hsl[0]}, {hsl[1]}%, {hsl[2]}%)"
```

--------------------------------

### Example CSS output

Source: https://onesimpleapi.com/docs/color-palette-generator-api-for-design-automation

The resulting CSS structure generated by the export function.

```css
:root {
  /* primary */
  --primary: #4a7c59;
  --primary-accent-1: #7c594a;
  --primary-accent-2: #594a7c;
  --primary-accent-3: #4a597c;
  --primary-rgb: 74, 124, 89;

  /* neutral */
  --neutral: #6b7280;
  --neutral-accent-1: #806b72;
  /* ... */
}
```

--------------------------------

### GET /api/unshorten

Source: https://onesimpleapi.com/docs/url-expander-api-see-where-short-links-really-go

Resolves a shortened URL to its final destination and provides security information.

```APIDOC
## GET /api/unshorten

### Description
Takes a shortened link and returns its true destination, including tracking parameters and a safety risk assessment.

### Method
GET

### Endpoint
https://onesimpleapi.com/api/unshorten

### Parameters
#### Query Parameters
- **token** (string) - Required - Your API authentication token.
- **url** (string) - Required - The shortened URL to expand.
- **output** (string) - Optional - The desired output format (e.g., json).

### Response
#### Success Response (200)
- **data** (string) - The final destination URL.
- **hops** (integer) - Number of redirects followed.
- **elapsed** (float) - Time taken to resolve the URL in seconds.
- **trace** (array) - List of URLs visited during the redirect process.
- **risk_check** (object) - Security assessment containing is_safe (boolean) and risk_score (integer).

### Response Example
{
  "data": "https://example.com/landing-page?utm_source=campaign",
  "hops": 1,
  "elapsed": 0.234,
  "trace": [
    "https://bit.ly/example",
    "https://example.com/landing-page?utm_source=campaign"
  ],
  "risk_check": {
    "is_safe": true,
    "risk_score": 0
  }
}
```

--------------------------------

### Generate Product Image Variants in Python

Source: https://onesimpleapi.com/docs/image-optimization-best-practices-for-e-commerce-websites

A helper function to generate dynamic image URLs for different product display requirements.

```python
def get_product_image(source_url, variant, token):
    variants = {
        'hero': {'width': 1200, 'height': 1200, 'quality': 90},
        'gallery': {'width': 800, 'height': 800, 'quality': 85},
        'thumbnail': {'width': 200, 'height': 200, 'quality': 80},
        'cart': {'width': 100, 'height': 100, 'quality': 75},
        'og_image': {'width': 1200, 'height': 630, 'quality': 85}
    }
    
    config = variants[variant]
    params = {
        'token': token,
        'image': source_url,
        'width': config['width'],
        'height': config['height'],
        'quality': config['quality'],
        'format': 'webp',
        'resize_mode': 'cover'
    }
    
    return f"https://onesimpleapi.com/api/image_manager?{'&'.join(f'{k}={v}' for k, v in params.items())}"
```

--------------------------------

### GET /api/screenshot

Source: https://onesimpleapi.com/docs/screenshot

Captures a screenshot of a specified URL or HTML content with configurable options.

```APIDOC
## GET /api/screenshot

### Description
Captures a screenshot of a given URL or HTML string. The API supports various screen sizes, full-page capture, and multiple output formats.

### Method
GET

### Endpoint
/api/screenshot

### Parameters
#### Query Parameters
- **token** (string) - Required - Your API authentication token.
- **url** (string) - Optional - The URL to capture.
- **html** (string) - Optional - A string containing HTML to capture.
- **screen** (string) - Optional - Defines screen size (retina, phone, phone-landscape, tablet, tablet-landscape, 4k, 8k, or custom:WIDTHxHEIGHT).
- **force** (string) - Optional - Set to 'yes' to retake the screenshot instead of using a cached version.
- **full** (string) - Optional - Set to 'yes' to capture the full length of the page.
- **background** (string) - Optional - Set to 'false' to remove background images and colors.
- **output** (string) - Optional - Defines response format (text, redirect, csv, for_google_docs, spreadsheet_image, json).
```

--------------------------------

### Configure Cache API options

Source: https://onesimpleapi.com/docs/cache

Examples of individual URL parameters used to customize the behavior of the Cache API.

```http
https://onesimpleapi.com/api/cache?token=YOUR_TOKEN_GOES_HERE&output=content**& url=https://example.com**
```

```http
https://onesimpleapi.com/api/cache?token=YOUR_TOKEN_GOES_HERE**& output=json**&url=https://example.com
```

```http
https://onesimpleapi.com/api/cache?token=YOUR_TOKEN_GOES_HERE&output=content&url=https://example.com**& force=yes**
```

```http
https://onesimpleapi.com/api/cache?token=YOUR_TOKEN_GOES_HERE&output=content&url=https://example.com**& headers=HEADER_DATA**
```

```http
https://onesimpleapi.com/api/cache?token=YOUR_TOKEN_GOES_HERE&output=content&url=https://example.com**& cache_duration=3600**
```

```http
https://onesimpleapi.com/api/cache?token=YOUR_TOKEN_GOES_HERE&output=content&url=https://example.com**& http_method=post**
```

--------------------------------

### GET /api/files

Source: https://onesimpleapi.com/docs/managing-files

Retrieves a paginated list of files associated with the user's token.

```APIDOC
## GET /api/files

### Description
Retrieves a list of files. The response is paginated, and the next page can be accessed via the next_page_url field.

### Method
GET

### Endpoint
https://onesimpleapi.com/api/files

### Parameters
#### Query Parameters
- **token** (string) - Required - Your access token.
- **status** (string) - Optional - Filter files by status (e.g., 'live' or 'deleted').

### Response
#### Success Response (200)
- **next_page_url** (string) - URL to retrieve the next page of results.
```

--------------------------------

### Expand URL using cURL

Source: https://onesimpleapi.com/docs/expand-shortened-url-api-guide

Example of calling the URL expander API using the cURL command-line tool.

```bash
curl -G "https://onesimpleapi.com/api/unshorten" \
  --data-urlencode "token=YOUR_TOKEN" \
  --data-urlencode "url=https://tinyurl.com/example" \
  --data-urlencode "output=json"
```

--------------------------------

### Generate Color and Palette from Text

Source: https://onesimpleapi.com/docs/color-unique-color-for-text-and-color-palette

Example request and JSON response for generating a color and palette based on a specific name.

```http
https://onesimpleapi.com/api/color?token=YOUR_TOKEN_GOES_HERE&output=json&text=Avril Lavigne
```

```json
{
 	"hex": "#783A3A",
 	"rgb": [
 	 	120,
 	 	58,
 	 	58
 	 ],
 	"hsl": [
 	 	0,
 	 	0.34831460674157305,
 	 	0.34901960784313724
 	 ],
 	"hex_palette": [
 	 	"#3A4D78",
 	 	"#3A784C",
 	 	"#5E783A"
 	 ],
 	"elapsed": 0.0007
}
```

--------------------------------

### GET https://onesimpleapi.com/api/image_info

Source: https://onesimpleapi.com/docs/image-info

Retrieves metadata and EXIF information from a provided image URL.

```APIDOC
## GET https://onesimpleapi.com/api/image_info

### Description
Retrieves encoded information inside an image, including camera make, model, exposure, aperture, date, ISO, and GPS coordinates.

### Method
GET

### Endpoint
https://onesimpleapi.com/api/image_info

### Parameters
#### Query Parameters
- **token** (string) - Required - Your API access token.
- **url** (string) - Required - The URL of the image to analyze.
- **output** (string) - Optional - The format of the response. Supported values: text, csv, for_google_docs, json. Defaults to text.

### Request Example
https://onesimpleapi.com/api/image_info?token=YOUR_TOKEN_GOES_HERE&output=json&url=https://example.com/image.jpg

### Response
#### Success Response (200)
- **make** (string) - Camera manufacturer
- **model** (string) - Camera model
- **exposure** (string) - Exposure time
- **aperture** (string) - Aperture setting
- **date** (string) - Date taken
- **iso** (number) - ISO level
- **latitude** (number) - GPS latitude
- **longitude** (number) - GPS longitude

#### Response Example
{
    "make": "NIKON",
    "model": "COOLPIX P6000",
    "exposure": "4/300",
    "aperture": "f/5.9",
    "date": "2008:11:01 21:15:07",
    "iso": 64,
    "latitude": 43.46744833333334,
    "longitude": 11.885126666663888
}
```

--------------------------------

### GET /api/email

Source: https://onesimpleapi.com/docs/email-validation

Validates an email address and returns deliverability information in the requested format.

```APIDOC
## GET /api/email

### Description
Validates an email address and returns a deliverability score or detailed validation data based on the output parameter.

### Method
GET

### Endpoint
/api/email

### Parameters
#### Query Parameters
- **token** (string) - Required - Your API authentication token.
- **email** (string) - Required - The email address to validate.
- **output** (string) - Optional - The format of the response. Supported values: text, csv, for_google_docs, json.
```

--------------------------------

### Format and Quality Parameters

Source: https://onesimpleapi.com/docs/image-compression-api-reduce-file-size

A snippet demonstrating how to append format and quality settings to an API request.

```http
&format=webp&quality=80

```

--------------------------------

### Configure QR Code Format and Size

Source: https://onesimpleapi.com/docs/free-qr-code-generator-api-guide

Request an SVG format for high-resolution output and specify the size.

```http
GET https://onesimpleapi.com/api/qr_code
    ?token=YOUR_TOKEN
    &message=https://example.com
    &format=svg
    &size=large
```

--------------------------------

### GET /api/pdf

Source: https://onesimpleapi.com/docs/web-page-to-pdf

Generates a PDF from a provided URL or HTML string with optional configuration parameters.

```APIDOC
## GET /api/pdf

### Description
Generates a PDF document from a specified URL or HTML content. The API supports various output formats and customization options.

### Method
GET

### Endpoint
/api/pdf

### Parameters
#### Query Parameters
- **token** (string) - Required - Your API authentication token.
- **url** (string) - Optional - The URL of the webpage to convert to PDF.
- **html** (string) - Optional - A string containing HTML formatted text to convert to PDF.
- **page** (string) - Optional - Defines the page size (Letter, Legal, Tabloid, Ledger, A0, A1, A2, A3, A4, A5, A6).
- **force** (string) - Optional - Set to 'yes' to regenerate the PDF instead of using a cached version.
- **background** (string) - Optional - Set to 'yes' to include background images and colors.
- **output** (string) - Optional - The response format (text, redirect, csv, for_google_docs, json).
```

--------------------------------

### GET https://onesimpleapi.com/api/page_info

Source: https://onesimpleapi.com/docs/web-page-meta-tags-and-open-graph

Retrieves metadata, Open Graph, and Twitter information for a specified URL.

```APIDOC
## GET https://onesimpleapi.com/api/page_info

### Description
Retrieves relevant information from a web page, including general metadata, Twitter card data, and Open Graph tags.

### Method
GET

### Endpoint
https://onesimpleapi.com/api/page_info

### Parameters
#### Query Parameters
- **token** (string) - Required - Your API authentication token.
- **url** (string) - Required - The URL of the web page to retrieve information from.
- **output** (string) - Optional - The format of the output (e.g., 'json' or 'for_google_docs').

### Request Example
https://onesimpleapi.com/api/page_info?token=YOUR_TOKEN_GOES_HERE&output=json&url=https://t.co/Q0uEt49I5D

### Response
#### Success Response (200)
- **general** (object) - General page metadata including title, description, and canonical URL.
- **twitter** (object) - Twitter card metadata.
- **og** (object) - Open Graph metadata.
- **elapsed** (number) - Time taken to process the request.

#### Response Example
{
    "general": {
        "title": "GitHub - fruitcake/laravel-cors",
        "description": "Adds CORS headers support in your Laravel application",
        "canonical": "https://github.com/fruitcake/laravel-cors"
    },
    "twitter": {
        "site": "@github",
        "title": "fruitcake/laravel-cors",
        "description": "Adds CORS headers support in your Laravel application"
    },
    "og": {
        "title": "fruitcake/laravel-cors",
        "url": "https://github.com/fruitcake/laravel-cors",
        "image": "https://avatars.githubusercontent.com/u/6661222?s=400&v=4",
        "description": "Adds CORS headers support in your Laravel application",
        "type": "object"
    },
    "elapsed": 0.4300110340118408
}
```

--------------------------------

### GET /api/unshorten

Source: https://onesimpleapi.com/docs/streamline-your-workflow-with-onesimpleapi-s-expand-url-feature

Retrieves the full redirect chain and safety information for a given shortened URL.

```APIDOC
## GET /api/unshorten

### Description
Reveals every step in the redirect chain for a provided URL, including tracking and routing hops.

### Method
GET

### Endpoint
https://onesimpleapi.com/api/unshorten

### Parameters
#### Query Parameters
- **token** (string) - Required - Your API authentication token.
- **url** (string) - Required - The shortened URL to expand.
- **output** (string) - Optional - The desired output format (e.g., json).

### Response
#### Success Response (200)
- **data** (string) - The final destination URL.
- **hops** (integer) - The number of redirects encountered.
- **elapsed** (float) - Time taken to process the request in seconds.
- **trace** (array) - A list of all URLs in the redirect chain.
- **risk_check** (object) - Security information including is_safe (boolean) and risk_score (integer).

#### Response Example
{
  "data": "https://final-destination.com/page",
  "hops": 3,
  "elapsed": 0.456,
  "trace": [
    "https://bit.ly/complex-redirect",
    "https://tracking.network.com/click/abc123",
    "https://affiliate.partner.com/redirect",
    "https://final-destination.com/page"
  ],
  "risk_check": {
    "is_safe": true,
    "risk_score": 0
  }
}
```

--------------------------------

### GET /api/image_manager

Source: https://onesimpleapi.com/docs/image-compression-api-reduce-file-size

Compresses an image from a source URL based on specified quality and format parameters.

```APIDOC
## GET /api/image_manager

### Description
Compresses an image from a provided source URL. The API returns an optimized image with the specified quality and format settings.

### Method
GET

### Endpoint
https://onesimpleapi.com/api/image_manager

### Parameters
#### Query Parameters
- **token** (string) - Required - Your API authentication token.
- **image** (string) - Required - The URL of the source image to compress.
- **quality** (integer) - Optional - Compression quality level (1-100). Default is 80-85 recommended.
- **format** (string) - Optional - Output format (e.g., webp, jpeg, png).
- **output** (string) - Optional - Response format (e.g., json, for_google_docs).
```

--------------------------------

### GET https://onesimpleapi.com/api/unshorten

Source: https://onesimpleapi.com/docs/expand-shortened-links-from-spreadsheet

Resolves a shortened URL to its final destination and performs a security check.

```APIDOC
## GET https://onesimpleapi.com/api/unshorten

### Description
Resolves a shortened URL to its final destination and performs a security check to verify if the link is safe.

### Method
GET

### Endpoint
https://onesimpleapi.com/api/unshorten

### Parameters
#### Query Parameters
- **token** (string) - Required - Your API authentication token.
- **url** (string) - Required - The shortened URL to expand.
- **output** (string) - Optional - The desired output format (e.g., json).

### Request Example
GET https://onesimpleapi.com/api/unshorten?token=YOUR_TOKEN&url=https://bit.ly/suspicious-link&output=json

### Response
#### Success Response (200)
- **data** (string) - The final destination URL.
- **hops** (integer) - Number of redirects followed.
- **elapsed** (float) - Time taken in seconds.
- **trace** (array) - List of URLs visited during the redirect process.
- **risk_check** (object) - Security assessment containing is_safe (boolean) and risk_score (integer).

#### Response Example
{
  "data": "https://legitimate-site.com/actual-page",
  "hops": 2,
  "elapsed": 0.45,
  "trace": [
    "https://bit.ly/suspicious-link",
    "https://bitly.com/redirect/...",
    "https://legitimate-site.com/actual-page"
  ],
  "risk_check": {
    "is_safe": true,
    "risk_score": 0
  }
}
```

--------------------------------

### Configure production environment variables

Source: https://onesimpleapi.com/docs/setup-image-cdn-website

Store your API token in an environment variable to keep it secure.

```bash
IMAGE_API_TOKEN=your_token_here
```

--------------------------------

### GET /api/exchange_rate

Source: https://onesimpleapi.com/docs/exchange-rate

Retrieves currency exchange rates or converted values based on the provided parameters.

```APIDOC
## GET /api/exchange_rate

### Description
Converts a value from one currency to another or retrieves exchange rates for available currencies.

### Method
GET

### Endpoint
https://onesimpleapi.com/api/exchange_rate

### Parameters
#### Query Parameters
- **token** (string) - Required - Your API authentication token.
- **to_currency** (string) - Required - The target currency code (e.g., GBP).
- **from_currency** (string) - Optional - The origin currency code (defaults to USD).
- **from_value** (number) - Optional - The amount to convert (defaults to 1).
- **output** (string) - Optional - The response format: 'text', 'csv', 'for_google_docs', or 'json'.
```

--------------------------------

### Calculate PPP Discount by IP Address

Source: https://onesimpleapi.com/docs/how-the-purchase-parity-pricing-discount-calculator-api-can-help-businesses-thrive

Automatically detects the user's location via IP address to apply the appropriate PPP discount.

```python
def get_ppp_discount_from_ip(base_price, user_ip, api_token):
    response = requests.get('https://onesimpleapi.com/api/discount_calculator', params={
        'token': api_token,
        'price': base_price,
        'origin_country_code': 'US',
        'destination_user_ip': user_ip,
        'max_discount': 40,
        'output': 'json'
    })
    return response.json()
```

--------------------------------

### GET https://onesimpleapi.com/api/email

Source: https://onesimpleapi.com/docs/email-validation-api

Validates an email address and returns a structured verdict on its deliverability and characteristics.

```APIDOC
## GET https://onesimpleapi.com/api/email

### Description
Validates an email address by checking format, domain, MX records, and deliverability status.

### Method
GET

### Endpoint
https://onesimpleapi.com/api/email

### Parameters
#### Query Parameters
- **token** (string) - Required - Your API authentication token.
- **email** (string) - Required - The email address to validate.
- **output** (string) - Optional - The format of the response (e.g., json).

### Response
#### Success Response (200)
- **is_format_valid** (boolean) - Whether the email syntax is valid.
- **is_domain_valid** (boolean) - Whether the domain exists.
- **domain_has_valid_mx_records** (boolean) - Whether the domain can receive mail.
- **is_email_free** (boolean) - Whether the email is from a free provider.
- **is_email_disposable** (boolean) - Whether the email is a throwaway address.
- **is_email_role** (boolean) - Whether the email is a role-based address.
- **canonical** (string) - The canonical version of the email.
- **deliverability** (string) - Overall verdict: GOOD, FAIR, or BAD.
- **safe_to_register_as_user** (boolean) - Whether the email is safe to register.

### Response Example
{
  "is_format_valid": true,
  "is_domain_valid": true,
  "domain_has_valid_mx_records": true,
  "is_email_free": false,
  "is_email_disposable": false,
  "is_email_role": false,
  "canonical": "peter@google.com",
  "deliverability": "GOOD",
  "safe_to_register_as_user": true
}
```

--------------------------------

### Convert Webpage to PDF in PHP

Source: https://onesimpleapi.com/docs/convert-webpage-to-pdf-programmatically

Uses http_build_query to construct the request and file_get_contents to fetch the response.

```php
$endpoint = 'https://onesimpleapi.com/api/pdf?' . http_build_query([
    'token'      => getenv('OSA_TOKEN'),
    'url'        => 'https://example.com/page',
    'page'       => 'a4',
    'background' => 'true',
    'output'     => 'json',
]);
$data = json_decode(file_get_contents($endpoint), true);
echo $data['pdf_url'];
```

--------------------------------

### GET /api/qr_code

Source: https://onesimpleapi.com/docs/10-creative-ways-to-use-qr-codes-in-your-business

Generates a QR code image based on the provided message and customization parameters.

```APIDOC
## GET /api/qr_code

### Description
Generates a QR code image hosted on the OneSimpleAPI CDN.

### Method
GET

### Endpoint
https://onesimpleapi.com/api/qr_code

### Parameters
#### Query Parameters
- **token** (string) - Required - Your API token with QR code permissions.
- **output** (string) - Required - The output format, e.g., 'json'.
- **message** (string) - Required - The content to encode in the QR code (e.g., a URL).
- **color** (string) - Optional - The foreground color in hex format (use %23 for #).
- **background** (string) - Optional - The background color in hex format (use %23 for #).
- **format** (string) - Optional - The image format, e.g., 'svg' for print.
- **size** (string) - Optional - The size of the QR code, e.g., 'large'.
```
Tokens:
Raw