{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"505c9d46-0321-4371-bf09-0d141d0f76f6","name":"API documentation","description":"## Uses\n\nWith the UnshortLink web interface you can easily check the HTTP status code, status message, response headers, and redirect chain of URLs.\n\nYou can check a limited number of URLs at once using the web interface.\n\nFor situations where you need to frequently check URLs, it may be beneficial to automate the process. Additionally, having the flexibility to choose the form and tooling for processing results (the API is compatible with various applications and scripting languages) can be advantageous. In such cases, utilizing an API is often a suitable option.\n\n### How it works\n\nSimilar to the UnshortLink web interface, the API has an endpoint for sending a POST request to the specified URL. The API endpoint can be accessed via HTTPS using a POST request, where all input is managed through a JSON body object, and it returns a JSON response.\n\n### Packed with features\n\n- **Experience the full package:** returns status codes, redirect chains, response headers and response bodies.\n    \n- **Redirect hop limits:** provides flexibility in handling redirects by defining the specific number of redirect responses the API should follow.\n    \n- **Set user-agent strings:** effortlessly explore how URLs respond across various user agents by using predefined or custom user-agent strings.\n    \n- **Custom request headers**: send any combination of request headers to audit the response of URLs to specific request headers.\n    \n- **HTTP Basic authentication:** access protected resources by sending the \"X-Billing-Token\" in the header of each request.\n    \n- **URL parser:** the built-in URL parser splits each URL or redirection location into readable parts for easy analysis.\n    \n- **Metadata:** get metadata such as title, meta description, canonical link tag, etc. for the destination URL.\n    \n- **Secure connections only:** only supports HTTPS connections, ensuring that your information is transmitted safely and securely.\n    \n- **CORS support:** allows cross-domain requests in the browser.\n    \n\n# API Reference\n\nUse this endpoint to check the status of a single URL.\n\n> [https://core.unshortlink.com/api/v1/status](https://core.unshortlink.com/api/v1/status) \n  \n\n## Parameters\n\n| **Parameter** | **Type** | **Default** | **Description** | **Required** |\n| --- | --- | --- | --- | --- |\n| `url` | string |  | The URL to fetch the status for. Use a URL without a specified scheme, which defaults to HTTP, or include an HTTP or HTTPS scheme. | Yes |\n| `https` | boolean | `false` | Set which scheme (http:// or https://) is used for request URLs without a scheme (eg. [www.google.com](http://www.google.com)). | No |\n| `user_agent` | string | `default` | Specifies the User-Agent header sent with requests. You can set a custom value to simulate specific browsers or leave it as default. Example:  <br>Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/130.0.0.0 Safari/537.36. | No |\n| `proxy` | string |  | Allows requests to be routed through a proxy serve. The proxy should be specified in one of the following formats: protocol://host:port:username:password | No |\n| `max_redirects` | number | `10` | Sets a specific number of redirect responses for the API to follow. If this value is exceeded, the request will be aborted and an error message will be returned. Defaults to 10 redirects. | No |\n| `timeout` | number | `10000` | The maximum time (in milliseconds) to wait for each request in the redirect chain before it is aborted. | No |\n| `check_downloadable` | boolean | false | If set to true, the system will check whether the final destination is a downloadable file (e.g., .exe, .zip, .pdf, etc.).  <br>This is useful for warning when a link leads directly to a file rather than a web page, helping to identify potentially risky or unintended downloads. | No |\n| `idle_time` | number | 0 | Defines the duration (in milliseconds) the system should wait after the last request is received before considering the process complete.  <br>This is especially useful for handling websites that introduce a delayed redirect — for example, pages that wait a few seconds before automatically redirecting. By setting an idle_time, you allow the system to remain active long enough to capture these late redirects and ensure the final destination is correctly resolved. | No |\n| `metadata` | boolean | false | When enabled, the system extracts basic metadata from the final destination page, including:  <br>• Title of the page  <br>• Description  <br>• Body | No |\n| `headers` | boolean | false | If set to true, the API response will include the HTTP response headers received in the final destination. | No |\n\n---\n\n# Rate limits\n\nA rate limit is enabled for each specific plan. The rate limit specifies the number of requests (calls) per second (rps) that will be accepted by the API endpoint.\n\nIf too many requests are sent to the endpoint within a second, a 429 response (Too Many Requests) will be returned. Use a sleep function to wait between API calls to avoid exceeding the limit.\n\n| **Header** | **Example** | **Description** |\n| --- | --- | --- |\n| `X-Quota` | label=callspermonth; limit-type=hard; quota=20000; remaining=18969; usage=1031; call-usage=1; reset=268395 | Information about the number of requests that the client will be able to make in the time window. |\n\nThis information can also be tracked within your Nadles API dashboard.\n\n# Request","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"41735207","team":6746831,"collectionId":"505c9d46-0321-4371-bf09-0d141d0f76f6","publishedId":"2sAYX3sjBV","public":true,"publicUrl":"https://docs.unshortlink.com","privateUrl":"https://go.postman.co/documentation/41735207-505c9d46-0321-4371-bf09-0d141d0f76f6","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"8437fe"},"documentationLayout":"classic-single-column","customisation":{"metaTags":[{"name":"description","value":""},{"name":"title","value":"UnshortLink — API Documentation"}],"appearance":{"default":"system_default","themes":[{"name":"dark","logo":"https://content.pstmn.io/f48dc7f9-3a2c-4ebb-85cf-6e4d789c690d/cG9zdG1hbiBkYXJrLnBuZw==","colors":{"top-bar":"1d1e21","right-sidebar":"303030","highlight":"a97dfc"}},{"name":"light","logo":"https://content.pstmn.io/098fd9c2-c978-4b5d-ad08-6f2f8abb5edb/cG9zdG1hbiBsaWdodC5wbmc=","colors":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"8437fe"}}]}},"version":"8.11.4","publishDate":"2025-02-11T14:01:42.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{"title":"UnshortLink — API Documentation","description":""},"logos":{"logoLight":"https://content.pstmn.io/098fd9c2-c978-4b5d-ad08-6f2f8abb5edb/cG9zdG1hbiBsaWdodC5wbmc=","logoDark":"https://content.pstmn.io/f48dc7f9-3a2c-4ebb-85cf-6e4d789c690d/cG9zdG1hbiBkYXJrLnBuZw=="}},"statusCode":200},"environments":[],"user":{"authenticated":false,"permissions":{"publish":false}},"run":{"button":{"js":"https://run.pstmn.io/button.js","css":"https://run.pstmn.io/button.css"}},"web":"https://www.getpostman.com/","team":{"logo":"https://res.cloudinary.com/postman/image/upload/t_team_logo_pubdoc/v1/team/983805e32d672108e32c4ce5ac07699052eae188da0120b84ae3187501430519","favicon":"https://res.cloudinary.com/postman/image/upload/v1738587554/team/09b7505cbf9b177299bce58206c8c11a.ico"},"isEnvFetchError":false,"languages":"[{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"HttpClient\"},{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"RestSharp\"},{\"key\":\"curl\",\"label\":\"cURL\",\"variant\":\"cURL\"},{\"key\":\"dart\",\"label\":\"Dart\",\"variant\":\"http\"},{\"key\":\"go\",\"label\":\"Go\",\"variant\":\"Native\"},{\"key\":\"http\",\"label\":\"HTTP\",\"variant\":\"HTTP\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"OkHttp\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"Unirest\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"Fetch\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"jQuery\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"XHR\"},{\"key\":\"c\",\"label\":\"C\",\"variant\":\"libcurl\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Axios\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Native\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Request\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Unirest\"},{\"key\":\"objective-c\",\"label\":\"Objective-C\",\"variant\":\"NSURLSession\"},{\"key\":\"ocaml\",\"label\":\"OCaml\",\"variant\":\"Cohttp\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"cURL\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"Guzzle\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"HTTP_Request2\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"pecl_http\"},{\"key\":\"powershell\",\"label\":\"PowerShell\",\"variant\":\"RestMethod\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"http.client\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"Requests\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"httr\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"RCurl\"},{\"key\":\"ruby\",\"label\":\"Ruby\",\"variant\":\"Net::HTTP\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"Httpie\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"wget\"},{\"key\":\"swift\",\"label\":\"Swift\",\"variant\":\"URLSession\"}]","languageSettings":[{"key":"csharp","label":"C#","variant":"HttpClient"},{"key":"csharp","label":"C#","variant":"RestSharp"},{"key":"curl","label":"cURL","variant":"cURL"},{"key":"dart","label":"Dart","variant":"http"},{"key":"go","label":"Go","variant":"Native"},{"key":"http","label":"HTTP","variant":"HTTP"},{"key":"java","label":"Java","variant":"OkHttp"},{"key":"java","label":"Java","variant":"Unirest"},{"key":"javascript","label":"JavaScript","variant":"Fetch"},{"key":"javascript","label":"JavaScript","variant":"jQuery"},{"key":"javascript","label":"JavaScript","variant":"XHR"},{"key":"c","label":"C","variant":"libcurl"},{"key":"nodejs","label":"NodeJs","variant":"Axios"},{"key":"nodejs","label":"NodeJs","variant":"Native"},{"key":"nodejs","label":"NodeJs","variant":"Request"},{"key":"nodejs","label":"NodeJs","variant":"Unirest"},{"key":"objective-c","label":"Objective-C","variant":"NSURLSession"},{"key":"ocaml","label":"OCaml","variant":"Cohttp"},{"key":"php","label":"PHP","variant":"cURL"},{"key":"php","label":"PHP","variant":"Guzzle"},{"key":"php","label":"PHP","variant":"HTTP_Request2"},{"key":"php","label":"PHP","variant":"pecl_http"},{"key":"powershell","label":"PowerShell","variant":"RestMethod"},{"key":"python","label":"Python","variant":"http.client"},{"key":"python","label":"Python","variant":"Requests"},{"key":"r","label":"R","variant":"httr"},{"key":"r","label":"R","variant":"RCurl"},{"key":"ruby","label":"Ruby","variant":"Net::HTTP"},{"key":"shell","label":"Shell","variant":"Httpie"},{"key":"shell","label":"Shell","variant":"wget"},{"key":"swift","label":"Swift","variant":"URLSession"}],"languageOptions":[{"label":"C# - HttpClient","value":"csharp - HttpClient - C#"},{"label":"C# - RestSharp","value":"csharp - RestSharp - C#"},{"label":"cURL - cURL","value":"curl - cURL - cURL"},{"label":"Dart - http","value":"dart - http - Dart"},{"label":"Go - Native","value":"go - Native - Go"},{"label":"HTTP - HTTP","value":"http - HTTP - HTTP"},{"label":"Java - OkHttp","value":"java - OkHttp - Java"},{"label":"Java - Unirest","value":"java - Unirest - Java"},{"label":"JavaScript - Fetch","value":"javascript - Fetch - JavaScript"},{"label":"JavaScript - jQuery","value":"javascript - jQuery - JavaScript"},{"label":"JavaScript - XHR","value":"javascript - XHR - JavaScript"},{"label":"C - libcurl","value":"c - libcurl - C"},{"label":"NodeJs - Axios","value":"nodejs - Axios - NodeJs"},{"label":"NodeJs - Native","value":"nodejs - Native - NodeJs"},{"label":"NodeJs - Request","value":"nodejs - Request - NodeJs"},{"label":"NodeJs - Unirest","value":"nodejs - Unirest - NodeJs"},{"label":"Objective-C - NSURLSession","value":"objective-c - NSURLSession - Objective-C"},{"label":"OCaml - Cohttp","value":"ocaml - Cohttp - OCaml"},{"label":"PHP - cURL","value":"php - cURL - PHP"},{"label":"PHP - Guzzle","value":"php - Guzzle - PHP"},{"label":"PHP - HTTP_Request2","value":"php - HTTP_Request2 - PHP"},{"label":"PHP - pecl_http","value":"php - pecl_http - PHP"},{"label":"PowerShell - RestMethod","value":"powershell - RestMethod - PowerShell"},{"label":"Python - http.client","value":"python - http.client - Python"},{"label":"Python - Requests","value":"python - Requests - Python"},{"label":"R - httr","value":"r - httr - R"},{"label":"R - RCurl","value":"r - RCurl - R"},{"label":"Ruby - Net::HTTP","value":"ruby - Net::HTTP - Ruby"},{"label":"Shell - Httpie","value":"shell - Httpie - Shell"},{"label":"Shell - wget","value":"shell - wget - Shell"},{"label":"Swift - URLSession","value":"swift - URLSession - Swift"}],"layoutOptions":[{"value":"classic-single-column","label":"Single Column"},{"value":"classic-double-column","label":"Double Column"}],"versionOptions":[],"environmentOptions":[{"value":"0","label":"No Environment"}],"canonicalUrl":"https://docs.unshortlink.com/view/metadata/2sAYX3sjBV"}