Note
The functions mentioned in this section are optimized for maximum performance and for the most part do not follow the RFC-3986 standard. Functions which implement RFC-3986 have RFC
appended to their function name and are generally slower.
You can generally use the non-RFC
function variants when working with publicly registered domains that contain neither user strings nor @
symbols. The table below details which symbols in a URL can (✔
) or cannot (✗
) be parsed by the respective RFC
and non-RFC
variants:
RFC
RFC
' ' ✗ ✗ \t ✗ ✗ < ✗ ✗ > ✗ ✗ % ✗ ✔* { ✗ ✗ } ✗ ✗ | ✗ ✗ \\ ✗ ✗ ^ ✗ ✗ ~ ✗ ✔* [ ✗ ✗ ] ✗ ✔ ; ✗ ✔* = ✗ ✔* & ✗ ✔*
symbols marked *
are sub-delimiters in RFC 3986 and allowed for user info following the @
symbol.
If the relevant part isn't present in a URL, an empty string is returned.
protocolExtracts the protocol from a URL.
Examples of typical returned values: http, https, ftp, mailto, tel, magnet.
domainExtracts the hostname from a URL.
Syntax
Arguments
url
— URL. String.The URL can be specified with or without a protocol. Examples:
For these examples, the domain
function returns the following results:
Returned values
Example
domainRFCExtracts the hostname from a URL. Similar to domain, but RFC 3986 conformant.
Syntax
Arguments
url
— URL. String.Returned values
Example
domainWithoutWWWReturns the domain without leading www.
if present.
Syntax
Arguments
url
— URL. String.Returned values
www.
), otherwise an empty string. String.Example
domainWithoutWWWRFCReturns the domain without leading www.
if present. Similar to domainWithoutWWW but conforms to RFC 3986.
Syntax
Arguments
url
— URL. String.Returned values
www.
), otherwise an empty string. String.Example
Query:
Result:
topLevelDomainExtracts the the top-level domain from a URL.
Arguments
url
— URL. String.Note
The URL can be specified with or without a protocol. Examples:
Returned values
Example
Query:
Result:
topLevelDomainRFCExtracts the the top-level domain from a URL. Similar to topLevelDomain, but conforms to RFC 3986.
Arguments
url
— URL. String.Note
The URL can be specified with or without a protocol. Examples:
Returned values
Example
Query:
Result:
firstSignificantSubdomainReturns the "first significant subdomain". The first significant subdomain is a second-level domain for com
, net
, org
, or co
, otherwise it is a third-level domain. For example, firstSignificantSubdomain ('https://news.clickhouse.com/') = 'clickhouse', firstSignificantSubdomain ('https://news.clickhouse.com.tr/') = 'clickhouse'
. The list of "insignificant" second-level domains and other implementation details may change in the future.
Syntax
Arguments
url
— URL. String.Returned value
Example
Query:
Result:
firstSignificantSubdomainRFCReturns the "first significant subdomain". The first significant subdomain is a second-level domain for com
, net
, org
, or co
, otherwise it is a third-level domain. For example, firstSignificantSubdomain ('https://news.clickhouse.com/') = 'clickhouse', firstSignificantSubdomain ('https://news.clickhouse.com.tr/') = 'clickhouse'
. The list of "insignificant" second-level domains and other implementation details may change in the future. Similar to firstSignficantSubdomain but conforms to RFC 1034.
Syntax
Arguments
url
— URL. String.Returned value
Example
Query:
Result:
cutToFirstSignificantSubdomainReturns the part of the domain that includes top-level subdomains up to the "first significant subdomain".
Syntax
Arguments
url
— URL. String.Returned value
Example
Query:
Result:
cutToFirstSignificantSubdomainRFCReturns the part of the domain that includes top-level subdomains up to the "first significant subdomain". Similar to cutToFirstSignificantSubdomain but conforms to RFC 3986.
Syntax
Arguments
url
— URL. String.Returned value
Example
Query:
Result:
cutToFirstSignificantSubdomainWithWWWReturns the part of the domain that includes top-level subdomains up to the "first significant subdomain", without stripping www
.
Syntax
Arguments
url
— URL. String.Returned value
www
) if possible, otherwise returns an empty string. String.Example
Query:
Result:
cutToFirstSignificantSubdomainWithWWWRFCReturns the part of the domain that includes top-level subdomains up to the "first significant subdomain", without stripping www
. Similar to cutToFirstSignificantSubdomainWithWWW but conforms to RFC 3986.
Syntax
Arguments
url
— URL. String.Returned value
Example
Query:
Result:
cutToFirstSignificantSubdomainCustomReturns the part of the domain that includes top-level subdomains up to the first significant subdomain. Accepts custom TLD list name. This function can be useful if you need a fresh TLD list or if you have a custom list.
Configuration example
Syntax
Arguments
Returned value
Example
Query:
Result:
See Also
cutToFirstSignificantSubdomainCustomRFCReturns the part of the domain that includes top-level subdomains up to the first significant subdomain. Accepts custom TLD list name. This function can be useful if you need a fresh TLD list or if you have a custom list. Similar to cutToFirstSignificantSubdomainCustom but conforms to RFC 3986.
Syntax
Arguments
Returned value
See Also
cutToFirstSignificantSubdomainCustomWithWWWReturns the part of the domain that includes top-level subdomains up to the first significant subdomain without stripping www
. Accepts custom TLD list name. It can be useful if you need a fresh TLD list or if you have a custom list.
Configuration example
Syntax
Arguments
Returned value
www
. String.Example
Query:
Result:
See Also
cutToFirstSignificantSubdomainCustomWithWWWRFCReturns the part of the domain that includes top-level subdomains up to the first significant subdomain without stripping www
. Accepts custom TLD list name. It can be useful if you need a fresh TLD list or if you have a custom list. Similar to cutToFirstSignificantSubdomainCustomWithWWW but conforms to RFC 3986.
Syntax
Arguments
Returned value
www
. String.See Also
firstSignificantSubdomainCustomReturns the first significant subdomain. Accepts customs TLD list name. Can be useful if you need fresh TLD list or you have custom.
Configuration example:
Syntax
Arguments
Returned value
Example
Query:
Result:
See Also
firstSignificantSubdomainCustomRFCReturns the first significant subdomain. Accepts customs TLD list name. Can be useful if you need fresh TLD list or you have custom. Similar to firstSignificantSubdomainCustom but conforms to RFC 3986.
Syntax
Arguments
Returned value
See Also
portReturns the port or default_port
if the URL contains no port or cannot be parsed.
Syntax
Arguments
Returned value
Example
Query:
Result:
portRFCReturns the port or default_port
if the URL contains no port or cannot be parsed. Similar to port, but RFC 3986 conformant.
Syntax
Arguments
Returned value
Example
Query:
Result:
pathReturns the path without query string.
Example: /top/news.html
.
The same as above, but including query string and fragment.
Example: /top/news.html?page=2#comments
.
Extracts the protocol from a URL.
Syntax
Arguments
url
— URL to extract protocol from. String.Returned value
Example
Query:
Result:
queryStringReturns the query string without the initial question mark, #
and everything after #
.
Example: page=1&lr=213
.
Returns the fragment identifier without the initial hash symbol.
queryStringAndFragmentReturns the query string and fragment identifier.
Example: page=1#29390
.
Returns the value of the name
parameter in the URL, if present, otherwise an empty string is returned. If there are multiple parameters with this name, the first occurrence is returned. The function assumes that the parameter in the url
parameter is encoded in the same way as in the name
argument.
Returns an array of name=value
strings corresponding to the URL parameters. The values are not decoded.
Returns an array of name strings corresponding to the names of URL parameters. The values are not decoded.
URLHierarchy(url)Returns an array containing the URL, truncated at the end by the symbols /,? in the path and query-string. Consecutive separator characters are counted as one. The cut is made in the position after all the consecutive separator characters.
URLPathHierarchy(url)The same as above, but without the protocol and host in the result. The / element (root) is not included.
encodeURLComponent(url)Returns the encoded URL.
Example:
decodeURLComponent(url)Returns the decoded URL.
Example:
encodeURLFormComponent(url)Returns the encoded URL. Follows rfc-1866, space(
) is encoded as plus(+
).
Example:
decodeURLFormComponent(url)Returns the decoded URL. Follows rfc-1866, plain plus(+
) is decoded as space(
).
Example:
netlocExtracts network locality (username:password@host:port
) from a URL.
Syntax
Arguments
url
— URL. String.Returned value
username:password@host:port
. String.Example
Query:
Result:
Functions that remove part of a URLIf the URL does not have anything similar, the URL remains unchanged.
cutWWWRemoves leading www.
(if present) from the URL's domain.
Removes query string, including the question mark.
cutFragmentRemoves the fragment identifier, including the number sign.
cutQueryStringAndFragmentRemoves the query string and fragment identifier, including the question mark and number sign.
cutURLParameter(url, name)Removes the name
parameter from a URL, if present. This function does not encode or decode characters in parameter names, e.g. Client ID
and Client%20ID
are treated as different parameter names.
Syntax
Arguments
Returned value
name
URL parameter removed. String.Example
Query:
Result:
RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4