castomAPI
Get your key
POST /v1/minify/url free No key needed Minify

Strip marketing, ad, and analytics tracking parameters (utm_*

Strip marketing, ad, and analytics tracking parameters (utm_*, fbclid, gclid, etc.) from URLs and normalize structure

POST

Request

  • x-api-key: <your-api-key>
  • Content-Type: application/json

Response 

{
  "result": {
    "cleanedUrl": "https://example.com/page",
    "domain": "example.com",
    "originalUrl": "https://example.com/page",
    "paramsRemoved": [
      {
        "key": "example",
        "reason": "checksum ok",
        "value": "example"
      }
    ]
  },
  "stats": {
    "charactersSaved": 23,
    "cleanedLength": 16,
    "originalLength": 16,
    "parametersRemovedCount": 3
  },
  "status": "success",
  "tokensDeducted": 1
}
The response below is a mock built from the endpoint's own schema — no request leaves this page. Edit the body, press Send, read the shape you will get back. Run it for real in the dashboard →

What it does

Strip marketing, ad, and analytics tracking parameters (utm_*, fbclid, gclid, etc.) from URLs and normalize structure

Request

Body

FieldTypeRequiredDescription
canonicalizebooleannoWhether to sort query parameters and normalize hostname casing.
customStripParamsarray<string>noAdditional custom query parameter names to strip.
preserveParamsarray<string>noQuery parameter names to preserve even if they match tracking blacklists.
stripAllParamsbooleannoIf true, removes ALL query parameters from the URL.
urlstringyesURL string to clean and canonicalize.

Example request

{
  "canonicalize": true,
  "customStripParams": [
    "<custom strip param>"
  ],
  "preserveParams": [
    "<preserve param>"
  ],
  "stripAllParams": false,
  "url": "https://example.com/page"
}

Response

FieldTypeDescription
resultobject
  ↳ cleanedUrlstring
  ↳ domainstring
  ↳ originalUrlstring
  ↳ paramsRemovedarray<object>
statsobject
  ↳ charactersSavedinteger
  ↳ cleanedLengthinteger
  ↳ originalLengthinteger
  ↳ parametersRemovedCountinteger
statusstring
tokensDeductedinteger

Example response

{
  "result": {
    "cleanedUrl": "https://example.com/page",
    "domain": "example.com",
    "originalUrl": "https://example.com/page",
    "paramsRemoved": [
      {
        "key": "example",
        "reason": "checksum ok",
        "value": "example"
      }
    ]
  },
  "stats": {
    "charactersSaved": 23,
    "cleanedLength": 16,
    "originalLength": 16,
    "parametersRemovedCount": 3
  },
  "status": "success",
  "tokensDeducted": 1
}

Errors

Every error answers with the same envelope: an HTTP status, a machine code and a sentence.

400The body or a parameter failed validation. The details array names the field.
401No key, a revoked key or a wrong header. Send x-api-key.
402The wallet cannot cover this call. Top up or wait for the monthly grant.
404The resource does not exist, or it is not yours. Both answer identically and cost nothing.
429Over the per-minute quota of your tier. Back off and retry.
5xxUpstream refused or timed out. The call is not billed.

Code

curl -X POST 'https://app.castomapi.com/v1/minify/url' \
  -H 'x-api-key: <your-api-key>' \
  -H 'Content-Type: application/json' \
  -d '{"canonicalize": true, "customStripParams": ["<custom strip param>"], "preserveParams": ["<preserve param>"], "stripAllParams": false, "url": "https://example.com/page"}'
const res = await fetch('https://app.castomapi.com/v1/minify/url', {
  method: 'POST',
  headers: { 'x-api-key': '<your-api-key>', 'Content-Type': 'application/json' },
  body: JSON.stringify({"canonicalize": true, "customStripParams": ["<custom strip param>"], "preserveParams": ["<preserve param>"], "stripAllParams": false, "url": "https://example.com/page"})
});
const data = await res.json();
console.log(data);
import { request } from 'node:https';

// Node 18+ has fetch built in
const res = await fetch('https://app.castomapi.com/v1/minify/url', {
  method: 'POST',
  headers: { 'x-api-key': '<your-api-key>', 'Content-Type': 'application/json' },
  body: JSON.stringify({"canonicalize": true, "customStripParams": ["<custom strip param>"], "preserveParams": ["<preserve param>"], "stripAllParams": false, "url": "https://example.com/page"})
});
const data = await res.json();
console.log(data);
import requests

res = requests.post(
    'https://app.castomapi.com/v1/minify/url',
    headers={'x-api-key': '<your-api-key>'},
    json={"canonicalize": True, "customStripParams": ["<custom strip param>"], "preserveParams": ["<preserve param>"], "stripAllParams": False, "url": "https://example.com/page"},
    timeout=30,
)
print(res.json())
<?php
$ch = curl_init('https://app.castomapi.com/v1/minify/url');
curl_setopt_array($ch, [
    CURLOPT_CUSTOMREQUEST => 'POST',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => ['x-api-key: <your-api-key>', 'Content-Type: application/json'],
    CURLOPT_POSTFIELDS => json_encode(['canonicalize' => true, 'customStripParams' => ['<custom strip param>'], 'preserveParams' => ['<preserve param>'], 'stripAllParams' => false, 'url' => 'https://example.com/page']),
]);
$data = json_decode(curl_exec($ch), true);
print_r($data);

Cost and limits

This operation needs no API key and costs nothing: called without a key it answers 200 and deducts zero tokens, up to 10 requests a minute per IP address.

Rate limits per minute

No key10
Free60
Pro300
Enterprise1200

Docs → Pricing

Questions

What does Strip marketing, ad, and analytics tracking parameters (utm_* cost?

This operation needs no API key and costs nothing: called without a key it answers 200 and deducts zero tokens, up to 10 requests a minute per IP address.

How do I authenticate?

Send your key in the x-api-key header. One key covers every metered endpoint; there is nothing to enable per endpoint.

Can I send an Authorization: Bearer token instead?

Not for a metered endpoint — those take the x-api-key header and nothing else. Bearer tokens belong to the account side: the dashboard and account APIs accept a JWT session, and castomapi-auth issues those through a standard OAuth2 handshake, with authorization code, client credentials and refresh grants. The auth service page covers it.

What are the limits?

10 requests a minute per IP with no key at all, 60 a minute on the free tier, 300 on Pro, 1200 on Enterprise. Above the no-key tier the quota is per account, across every endpoint.

OpenAPI: https://app.castomapi.com/docs/json