Overview
Welcome to the official B.Y.P.A.S.S API documentation (Banning Your Persistent Attempts to Skip Sponsors). This API enables developers and content creators to protect their monetized links against unauthorized bypass services.
What is B.Y.P.A.S.S?
B.Y.P.A.S.S is an advanced protection system specifically designed to prevent unauthorized bypassing of monetized link services. It protects content creator revenue through multiple layers of security and detection.
Multi-Layer Protection
Multiple detection systems working in concert
Fast API
Millisecond responses for seamless integration
Highly Configurable
Customize every aspect of protection
Authentication
All API requests require authentication via a unique API Key that must be included in the headers of each request.
Authentication Header
Include your API Key in the c-api-key header in all your requests. This key is provided by B.Y.P.A.S.S upon service registration.
c-api-key: {apikey}Important
Never share your API Key publicly. If you believe it has been compromised, contact support immediately to generate a new one.
Base URL
All API requests must be directed to the following base URL. Ensure you use HTTPS to guarantee data security.
https://kys.linkvertise.lol/api/v2/bckCreate Protected Link
This endpoint allows you to create a new protected link with specified security configurations. The generated link will have a limited lifetime and will be protected against multiple bypass methods.
POST https://kys.linkvertise.lol/api/v2/bck/publishersRequired Headers
| Header | Type | Description |
|---|---|---|
c-api-key | string | Your B.Y.P.A.S.S API Key for authentication |
Content-Type | string | Must be application/json |
Request Body
The request body must be a JSON object containing all configuration parameters for the protected link. The complete structure is shown below.
{
"url": "https://google.com",
"pikey": "1229349",
"provider": "lvdynamic",
"ads_script_url": "https://example.com/ads.js",
"jsonDetections": {
"Referer": true,
"MaxTasks": "3",
"tier_id": 3,
"Presets": {
"BYPASS.VIP": true,
"BYPASS.CITY": true,
"TRW-API": true
},
"RenueveBooster": {
"BlockVPNS": true,
"BlockIncognito": true,
"CaptchaRequired": true,
"Max_Renueve": false,
"XTra_tasks": [
{
"Title": "Join Discord",
"Descr": "Join our community",
"link": "https://discord.gg/xyz",
"ID": "discord_join"
}
]
},
"MinTime": "1",
"DetectUserscripts": true,
"UnicodeDetect": true,
"SpoofCompletion": true,
"RS_Invisible": false,
"ManualDetectionZ": false,
"VMConfig": {
"enabled": true,
"VMode": "medium"
}
}
}Manual Report
Verifies tokens generated by ManualDetectionZ. When a bypass attempt is detected and ManualDetectionZ is enabled, the user is still allowed to reach their destination but the final URL receives a RS_EvaluationDT parameter containing a short-lived token. This endpoint allows you to verify those tokens server-side.
GET https://kys.linkvertise.lol/api/v2/ManualReport?tk={token}Query Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
tk | string | Required | The token received via the RS_EvaluationDT URL parameter. Valid for 30 seconds after generation. |
Response Fields
| Field | Type | Description |
|---|---|---|
success | Boolean | true if the token exists and is valid. false if a token was not provided, not found, or an error occurred. The fields below are only present when success is true. |
TaskID | String | The task_id of the link that generated this token (same as in /DTOM/{task_id} returned by /api/v2/bck/publishers). Useful to ensure you are not validating a token from a different task. |
TT | Number | Unix timestamp of when the token was generated. |
Completion_IP | String | The IP address of the user who completed the task. Typically IPv4. |
FinalReport | Object | A list of what was detected. Will be empty if nothing was detected. See the table below for possible entries. |
encrypted_port | String | Compact VM snapshot sealed with AES-256-GCM. If you find a working bypasser, bypass a link then send this parameter to our discord server, we will patch it. |
FinalReport, Possible Detection Entries
Only present in the report when detected. Absent if not triggered. Values are usually boolean true, but some detections may return an internal JSON object with extra telemetry instead (e.g. counters). Always accept both shapes; more detections may adopt this in the future.
| Key | False Positive Rate | Description |
|---|---|---|
referer_missmatch | ~2% | Referer mismatch, the expected referer (e.g. linkvertise.com) was not received or a different one was sent. Note: ~2% False Positive Rate in some browsers. |
Userscript_DET1 | 0% | A userscript was detected using detection method DET1. 0% False Positive Rate. |
LV_SPOOFED_COMPLETION | 0% | The Linkvertise step was completed, but it was detected by our systems as being spoofed by a bypasser. 0% False Positive Rate. |
LTL_SPOOFED_COMPLETION | 0% | The LootLabs ad was completed by an external bypassing server rather than by the actual user. 0% False Positive Rate. |
DeadHand_MagnusX5 | 0% | Detection by the Magnus-type Dead-Hand engine (VMD-SIGNATURE-FAIL). 0% False Positive Rate. |
DeadHand_MagnusX6 | 0% | Detection by the Magnus-type Dead-Hand engine (VMD-DCY). 0% False Positive Rate. |
DeadHand_MagnusX7 | ~1%/~30% | Detection by the Magnus-type Dead-Hand engine (VMD-SCREENWIDTHHEIGHT). ~1% False Positive Rate in normal users | ~30% False Positive in Premium Users (Linkvertise, Lootlabs, Lockr, etc). May return an internal JSON instead of true: {"VPoints": <int>} where 0 VPoints can mean the user used Premium to skip or used a bypasser. |
DeadHand_MagnusX8 | 0% | Detection by the Magnus-type Dead-Hand engine (VMD-TLS-FINGERPRINTING) |
DeadHand_MagnusX9 | 0% | Detection by the Magnus-type Dead-Hand engine (KAT environment-variable bind). Client-reported process env / KAT snapshot did not match the TLS-bound header set. 0% False Positive Rate. |
DeadHand_MagnusX10 | 0% | Detection by the Magnus-type Dead-Hand engine (VMD-YXHandshake-MISMATCH) |
TRW_API_Detected | 0% | A bypass using TRW-API was detected. 0% False Positive Rate. |
BYPASS_CITY_DETECTED | 0% | A bypass using BYPASS.CITY was detected. 0% False Positive Rate. |
SEC_BROWSER_CHECK_01 | ~2% | Completion request was not a browser navigation (no Fetch Metadata, or a subresource/fetch). A normal document load is not flagged, including the ad redirect and the IP-changed continue button. Residual false positives are old browsers or proxies that strip Sec-Fetch-*. |
FAST_COMPLETION | 0% | The checkpoint was completed faster than the configured MinTime, indicating the ad steps were skipped. 0% False Positive Rate. |
{
"success": true,
"TaskID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"TT": 1767760709,
"Completion_IP": "192.168.1.1",
"FinalReport": {
"Userscript_DET1": true,
"referer_missmatch": true,
"DeadHand_MagnusX7": { "VPoints": 1 }
}
}{
"success": true,
"TaskID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"TT": 1767760709,
"Completion_IP": "192.168.1.1",
"FinalReport": {}
}Token Validity
Tokens generated by ManualDetectionZ are valid for 30 seconds only. Make sure to verify the token as soon as it is received to avoid expiration.
url
RequiredStringThe destination URL to which the user will be redirected after successfully completing the monetization process. This is the final URL you wish to protect.
Detailed Description
This parameter defines the final destination of the protected link. When a user successfully completes all required verifications and monetization tasks, they will be automatically redirected to this URL.
- Must be a valid URL with protocol (http:// or https://)
- Can contain query string parameters
- Supports any valid domain
- HTTPS is recommended for greater security
"url": "https://example.com/file.zip"pikey
RequiredStringMonetization provider authorization token. This value varies depending on the provider you are using to monetize your links.
Tokens by Provider
Depending on the selected provider, the pikey value must correspond to one of the following credential types:
| Provider | Token Type | Where to Obtain |
|---|---|---|
| lvdynamic | User ID | Your numeric Linkvertise User ID |
| lootlabs | API Key | LootLabs Dashboard โ Developers |
| admaven | API Key | Ad-Maven Dashboard โ Tools โ API |
| cutyio | API Key | Cuty.io Dashboard โ Settings |
| lockr | API Key | Lockr Dashboard โ API |
| rinku | API Key | Rinku Dashboard โ API |
"pikey": "1229349"provider
RequiredStringSpecifies the monetization provider you wish to use to generate revenue through your protected link. Each provider has its own characteristics and requirements.
Available Providers
lvdynamicRecommended Linkvertise via User ID. The only Linkvertise provider; linkvertise (bearer) is no longer accepted.
lootlabsRequires PostbackIntegration with LootLabs. Requires postback configuration in the LootLabs dashboard to function properly.
admavenIntegration with Ad-Maven. Uses the Ad-Maven API Key to generate monetized link-shortener links.
cutyioIntegration with Cuty.io. Requires Cuty.io API Key to generate monetized links.
lockrIntegration with Lockr. Requires Lockr API Key to generate monetized links.
rinkuIntegration with Rinku. Requires Rinku API Key to generate monetized links.
"provider": "lvdynamic"Domain Management
Auto-RoutingRemoved - The system now auto-routes all users between domains: kys.linkvertise.lol, red-square.space, and rs.linkvertise.lol. This enhancement provides better load balancing, improved redundancy, and seamless user experience across all available domains without manual tier-based assignment.
Automatic Domain Routing
The previous tier-based domain assignment has been replaced with intelligent auto-routing. The system automatically distributes users across all available domains (kys.linkvertise.lol, red-square.space, and rs.linkvertise.lol) to optimize performance, ensure high availability, and prevent any single domain from becoming a bottleneck.
Improvement
This change eliminates the need for manual domain selection and ensures consistent performance across all user tiers.
ads_script_url
OptionalStringWhen provided, this url will be loaded within the website, specifically on the /taskcompleted route, allowing the user to view personalized advertisements. this enables publishers and keysystem owners to maximize revenue generation from each link.
Detailed Description
This parameter allows loading custom advertisement scripts on the task completion page, enabling additional monetization opportunities.
"ads_script_url": "https://example.com/ads.js"Referer
BooleanEnables HTTP Referer header verification to detect and block bypass attempts originating from unauthorized websites.
How Does It Work?
When this option is enabled, the system verifies the Referer header of each incoming request. If the request originates from a known bypass service domain (such as websites offering to skip monetization), access will be automatically denied.
โ Advantages
- โข Blocks direct bypasses from websites
- โข Real-time detection
- โข No impact on legitimate users
โ Considerations
- โข Can be evaded with modified headers
- โข Combine with other detections
"Referer": trueMaxTasks
StringLootLabs OnlyDefines the maximum number of tasks a user must complete before gaining access to protected content. This parameter is exclusive to LootLabs.
Allowed Values
The value must be a numeric string between "1" and "5". Higher task numbers increase monetization but also the time required from users.
"MaxTasks": "3"tier_id
IntegerLootLabs Only LootLabs advertisement tier passed to content_locker. Ignored for every other provider. You may send it inside jsonDetections or at the top level of the wrap body. Missing or out of range values fall back to 3.
Allowed Values (1โ4)
Matches LootLabs: which ads the visitor sees on the locker.
"tier_id": 3Presets
ObjectPredefined configurations to detect and block specific bypass services. Each preset is optimized to detect the behavior pattern of a particular service.
Detectable Services
BYPASS.VIPBooleanDetects and blocks bypass attempts from the BYPASS.VIP service, one of the most widely used services for skipping monetization.
BYPASS.CITYBooleanDetects and blocks bypass attempts from BYPASS.CITY, another popular link bypass service.
TRW-APIBooleanDetects services based on TRW-API, including F.E.A.R, BYPASSUNLOCK, and other websites using this bypass technology.
"Presets": {
"BYPASS.VIP": true,
"BYPASS.CITY": true,
"TRW-API": true
}MinTime
StringEstablishes the minimum time in seconds that a user must spend completing the monetization process before accessing the content.
Detailed Description
This configuration helps detect automated bypasses that attempt to complete the process instantly. If a user "completes" the adlink in less than the specified time, they will be marked as suspicious and denied access.
"MinTime": "1"DetectUserscripts
BooleanEnables detection of userscripts (Tampermonkey, Greasemonkey scripts, etc.) that attempt to manipulate or bypass the monetization process.
What are Userscripts?
Userscripts are small JavaScript programs that users can install in their browsers to modify website behavior. Some of these scripts are specifically designed to skip link monetization.
Advanced Detection
This function uses multiple detection techniques to identify userscript presence, including behavior analysis and DOM integrity verification.
"DetectUserscripts": trueRenueveBooster
ObjectA comprehensive revenue optimization suite that implements multiple protection mechanisms to maximize ad revenue while preventing bypass attempts. Each option targets specific vulnerabilities and revenue leaks.
Available Options
BlockVPNSBooleanBlocks VPN and Proxy connections to ensure better CPM rates from advertisers.
Why: Advertisers pay less for traffic from VPNs/Proxies as they are often associated with fraud or low-quality traffic.
BlockIncognitoBooleanBlocks Incognito/Private browsing mode for better CPM rates.
Why: Trackers and advertisers prefer users without Incognito/Anti-Tracking modes as they can collect more data and serve better-targeted ads.
CaptchaRequiredBooleanRequires RG-Sentry captcha to proceed before accessing the protected content.
Effectiveness: Blocks 100% of automated, bot, and userscript completions. This is the most effective protection against automated bypasses.
Max_RenueveBooleanEdits the API parameters to maximize revenue.
XTra_tasksArrayAttach additional tasks that users must complete before accessing the final destination. Tasks can be direct links, Discord server invitations, YouTube subscriptions, or any other action you want the user to complete.
Use Case: Monetize your links further by requiring users to complete extra actions (social follows, subscriptions, etc.) before proceeding to their destination.
"RenueveBooster": {
"BlockVPNS": true,
"BlockIncognito": true,
"CaptchaRequired": true,
"Max_Renueve": false,
"XTra_tasks": [
{
"Title": "Subscribe to Discord",
"Descr": "Join our Discord server for updates and community",
"link": "https://discord.gg/yourserver",
"ID": "discord_sub_2024"
},
{
"Title": "Follow Twitter",
"Descr": "Follow our Twitter account",
"link": "https://twitter.com/yourname",
"ID": "twitter_follow_unique_12345"
}
]
}XTra_tasks, Additional User Tasks
Array of ObjectsXTra_tasks enables you to require users to complete additional actions before accessing the protected content. This feature monetizes your links further by integrating social media follows, Discord server joins, YouTube subscriptions, or direct links to partner sites. Each task is tracked independently and persisted on the user's device via localStorage.
How It Works
1. Task Flow: After the user passes all bypass detection checks, they are presented with a list of required tasks before they can access the final destination.
2. Task Execution: Each task opens in a new browser window. The user clicks the task, waits 25 seconds (or completes the action), and the task is marked as done.
3. Device Tracking: Each completed task is stored in the browser's localStorage using the task's ID. This means:
โข If ID is a unique string โ user only completes it once per device forever
โข If ID is false โ user must complete it every time they visit
4. Completion: Once all tasks are marked as done, the user sees a "Click to Continue" button to access the final destination.
Task Object Structure
Each task in the array must contain:
Title (String, Required)The headline shown to the user. Be clear and descriptive. Example: "Subscribe to YouTube Channel", "Join Discord Server", "Follow on Twitter"
Descr (String, Required)Short description of what the task requires. Example: "Subscribe to our YouTube channel for exclusive content", "Join our Discord community"
link (String, Required - MUST BE VALID)A valid, working URL where the user will be directed. This MUST be a real, functioning link. Examples:
- โ
https://discord.gg/yourserver- Discord invite - โ
https://youtube.com/@yourchannel- YouTube channel - โ
https://twitter.com/yourhandle- Twitter profile - โ
https://example.com/signup- Partner site - โ
https://loot-link.com/...- Lootlabs (NOT RECOMMENDED) - โ
https://linkvertise.com/...- Linkvertise (NOT RECOMMENDED)
ID (String OR Boolean, Required)Unique identifier for task completion tracking. CRITICAL: This determines how many times the user must complete the task.
Option A: String (UUID/Unique ID)
Use a unique string identifier (e.g., "discord_invite_2024", "youtube_sub_unique_12345", or a UUID). When set to a string:
- โ User completes the task ONCE on their device
- โ Task is never required again from that device (stored in localStorage)
- โ Perfect for limited-time offers or one-time actions (follow, subscribe)
Example: "ID": "youtube_channel_sub_2024"
Option B: Boolean False
Use the boolean value false (NOT a string "false", but actual boolean false). When set to false:
- โ User MUST complete this task every single time they access the link
- โ No persistence across sessions
- โ Useful for mandatory viewing (ads, sponsor content)
- โ ๏ธ Creates poor user experience if overused
Example: "ID": false
Note: Avoid Using Competitor Ad-Links as XTra_tasks
We don't recommend using ad-link services like Lootlabs, Linkvertise, AdMaven, Lockr, or similar monetization platforms as XTra_tasks.
Why? These services create a poor user experience because:
- ๐ Users can easily skip or close these tasks, reducing effectiveness
- ๐ Creates redundant monetization layers (ad-link within ad-link) that confuse users
- โฑ๏ธ Best suited for lightweight, quick actions (Discord joins, follows, votes) rather than full ad campaigns
โ BETTER CHOICE: Use simple, quick actions like Discord server invites, YouTube channel subscriptions, Twitter follows, newsletter signups, or partner redirects. These work best with XTra_tasks.
Complete Examples
"XTra_tasks": [
{
"Title": "Subscribe to our YouTube Channel",
"Descr": "Get exclusive content and updates",
"link": "https://youtube.com/@myawesomechannel",
"ID": "youtube_sub_unique_2024"
},
{
"Title": "Join our Discord Community",
"Descr": "Connect with thousands of members",
"link": "https://discord.gg/abcd1234",
"ID": "discord_join_2024"
},
{
"Title": "Follow on Twitter",
"Descr": "Stay updated with the latest news",
"link": "https://twitter.com/myhandle",
"ID": "twitter_follow_unique_001"
}
]"XTra_tasks": [
{
"Title": "Watch Our Sponsor Ad",
"Descr": "This sponsor makes our service possible",
"link": "https://example.com/sponsor-ad",
"ID": false
},
{
"Title": "Sign the Petition (Every Visit)",
"Descr": "Your signature is required every time",
"link": "https://petition.example.com/sign",
"ID": false
}
]"XTra_tasks": [
{
"Title": "Subscribe to YouTube (One Time)",
"Descr": "Subscribe once and never see this again",
"link": "https://youtube.com/@mychannel",
"ID": "yt_sub_one_time_only"
},
{
"Title": "View Sponsor Message",
"Descr": "Quick message from our partner",
"link": "https://sponsor.example.com/message",
"ID": false
}
]Best Practices for XTra_tasks
- โ Use clear, honest descriptions of what you're asking
- โ Ensure all links are legitimate and working
- โ Limit to 2-3 tasks maximum (too many reduces completion rates)
- โ Use unique string IDs for actions you only want once per user
- โ Test the links before deploying
- โ Monitor user feedback about task experience
- โ Never chain ad-links together
- โ Don't use Lootlabs, Linkvertise, AdMaven, Lockr, or similar services
- โ Don't require users to complete impossible tasks
UnicodeDetect
BooleanDetects "undetectable" userscripts that use URL parameter manipulation techniques with Unicode characters to evade traditional detections.
Detection Technique
Some advanced userscripts attempt to conceal their presence by modifying URL parameters in subtle ways, including the use of Unicode characters that look identical to normal ASCII characters but have different codes.
This function verifies URL parameter integrity to detect if they have been modified by a userscript, blocking access if alterations are detected.
"UnicodeDetect": trueSpoofCompletion
BooleanImplements an advanced honeypot technique that tricks large website userscripts into believing the link has been successfully bypassed, sending them to a trap link that detects them.
How Does the Honeypot Work?
This is one of B.Y.P.A.S.S's most effective techniques. Instead of simply blocking bypass attempts, the system simulates a successful response that userscripts interpret as a completed bypass.
- The userscript attempts to bypass the link
- The system detects the attempt and returns a fake success response
- The userscript redirects the user to the "bypassed link"
- The trap link detects and records the bypass attempt
- The user is blocked or redirected to a warning page
"SpoofCompletion": trueRS_Invisible
Boolean When set to true, improves user experience by removing Red-Square ads, providing direct links to the original creator's adlinks.
How Does It Work?
When this option is enabled, the system removes the Red-Square advertising layer and provides direct links to the original creator's adlinks. This significantly improves the end user experience by eliminating unnecessary intermediaries.
โ Advantages
- โข Better user experience
- โข Removes Red-Square ads
- โข Direct links to creator's adlinks
- โข No additional configuration required
โ Considerations
- โข The only way Red-Square stays online is through ads (please consider supporting us)
- โข In automatic redirect mode, auto-bypass bots are more likely to pass through undetected
"RS_Invisible": trueVMConfig
ObjectControls how strict the isolated VM stage is for Lockr.so, LootLabs, and Ad-Maven links: how many verification tasks a user must clear before entering the VM, and whether decoy links are served alongside the real one.
Quick Explain: How It Works
To stop users from copying the ad-link and dropping it into a bypass site, we run it inside our own isolated VM, under our own domain. The link itself is randomized so it cannot just be copied and reused elsewhere.
The ad-link is then loaded inside a realm. Top-level userscripts (F.E.A.R by MCB, Evade by Skipped.lol) are built specifically to avoid running inside realms like this one, since realms are easy to fingerprint. This step alone kills about 99% of bypass attempts. Only advanced users make it past this point.
Next, we run 2 to 5 decoy realms alongside the real one, so a script has no way of knowing which realm holds the actual destination. Inject into the wrong one and it gets flagged and blocked. Inject into the right one and it still gets caught.
Finally, every realm is checked every 5 seconds for anomalies, and the results are sent to our servers over YX, an encrypted client-server channel that isn't readable even by the client itself. This is what gets us to a 100% detection rate.
enabled
Boolean Set to false to skip the isolated VM stage entirely for this link. Defaults to true when omitted.
โ Known Issues
- โข LootLabs can occasionally return a 429 error for some users, caused by the decoys that keep the link secure
- โข High loading time on some devices (1-10s on a black screen)
- โข On Lockr.so, premium sessions seem to not work properly for users (gets them logged out, etc)
โ What Our VM Offers
- โข So far, a 100% detection rate for bypasses, userscripts, and automated scripts
- โข The isolated VM blocks many network-level ad-blockers, improving CPM
- โข In some cases improves UX through cache loading that speeds everything up by 10x
- โข VM customization via
VMode
VMode Tiers
Set VMode to one of three presets. Strictness is per provider, since each one handles VM entry differently.
| VMode | Lockr.so | LootLabs | Ad-Maven | Decoys |
|---|---|---|---|---|
"onlyvm" | None | None | None | false |
"medium"โ
Recommended | Light | Light | Light | true |
"high" | Strict | Standard | Light | true |
Defaults to "medium" when omitted. Higher tiers mean more friction (and more monetized completions) before a user reaches the VM; "onlyvm" skips straight to the isolated VM with no extra checks and no decoys. Ignored when "enabled": false.
Known Issue: "high" VMode
"high" can cause false positives on Ad-Maven and LootLabs links. We are working on fixing it.
"VMConfig": {
"enabled": true,
"VMode": "medium"
}ManualDetectionZ
Boolean Delegates all final decisions to the administrator. When a bypass attempt is detected, the user is still allowed to reach their destination instead of being blocked, however, the final URL is appended with a RS_EvaluationDT parameter containing a short-lived verification token.
How Does It Work?
When this setting is enabled and a bypass attempt is detected, the system will not block the user. Instead, it appends a RS_EvaluationDT query parameter to the final destination URL. This token is valid for 30 seconds and can be verified server-side by making a GET request to the /api/v2/ManualReport endpoint.
โ Advantages
- โข Users are never hard-blocked, no false positive lockouts
- โข Full control stays with the administrator
- โข Detailed detection report available per request
- โข Can be used alongside other detection settings
โ Considerations
- โข Requires server-side token verification
- โข Token expires after 30 seconds, verify promptly
- โข Administrator must implement their own enforcement logic
Flow Overview
- User completes the monetization link
- B.Y.P.A.S.S detects a bypass attempt
- Instead of blocking, the user is redirected to the destination URL with
?RS_EvaluationDT=<token>appended - Your server receives the request, extracts the token, and sends a GET to
/api/v2/ManualReport?tk=<token> - The API returns a
FinalReportwith what was detected, you decide how to proceed
"ManualDetectionZ": trueResponse Structure
When the request is successful, the API returns a JSON object with information about the generated protected link, including timestamps and the final link.
{
"success": true,
"link": "https://kys.linkvertise.lol/DTOM/{TaskID}?antibypass=true&apimade=tr",
"Ntimestamp": 1767760709.8914726
}About TaskID
The {TaskID} in the URL is a unique identifier generated for each protected link. This ID allows tracking and management of the specific link. Example: a1b2c3d4-e5f6-7890-abcd-ef1234567890
Response Fields
| Field | Type | Description |
|---|---|---|
success | Boolean | Indicates whether the operation was successful (true) or failed (false) |
link | String | The generated protected link. Share this URL. apimade=tr when created with a publisher API key, fl when created from the public dashboard. |
Ntimestamp | Number | Unix timestamp (seconds, with decimals) of when the link was created. API-created links are deleted 1800 seconds (30 minutes) after this time. |
X-RT header | String | Server processing time, e.g. 0.0123s. Not part of the JSON body. |
Code Generator
Use this interactive generator to create customized integration code according to your specific needs.
Enter a valid JSON array of task objects. Leave empty if not using XTra_tasks.
import requests
data = {
"url": "https://google.com",
"pikey": "1229349",
"provider": "lvdynamic",
"ads_script_url": "",
"jsonDetections": {
"Referer": True,
"MaxTasks": "3",
"tier_id": 3,
"Presets": {
"BYPASS.VIP": True,
"BYPASS.CITY": True,
"TRW-API": True
},
"RenueveBooster": {
"BlockVPNS": True,
"BlockIncognito": True,
"CaptchaRequired": True,
"Max_Renueve": False
},
"MinTime": "1",
"DetectUserscripts": True,
"UnicodeDetect": True,
"SpoofCompletion": True
}
}
response = requests.post(
"https://red-square.space/api/v2/bck/publishers",
json=data,
headers={"c-api-key": "xyzabc"}
)
print(response.json())Common Errors
Below are the most common errors you may encounter when using the API and how to resolve them.
Unauthorized
The API Key provided in the c-api-key header is invalid or was not included in the request. Body: {"success": false, "THReason": "N01"}
Solution: Verify that you are using the correct API Key and that it is included in the headers.
Key inactive
The API key has not generated any new links for 15 consecutive days and is blocked. Body: {"success": false, "THReason": "INACTIVE"}
Solution: Contact staff on Discord to restore the key. Completions on existing links do not reset this window.
Bad Request
The parameters sent in the request body are invalid or required fields are missing.
Solution: Review that all required fields are present and have the correct format.
Invalid Provider Key
The pikey provided is not valid for the selected provider.
Solution: Ensure you are using the correct type of credential according to the provider (User ID, API Key, Bearer Token).
Rate Limited
You have exceeded the allowed requests per minute limit.
Solution: Wait a few seconds before making another request. Consider implementing rate limiting in your application.
Server Error
Unexpected failure while creating the link. Body is typically {"success": false}.
Solution: Retry once. If it persists, join Discord with the request payload (redact keys) and the X-RT header if present.
Need Help?
Join our Discord community to get technical support, report bugs, or suggest new features.
Join Discord