URL Parsing

• urlstringrequired

  Absolute URL to parse, including its scheme (e.g. https://example.com/path?a=1)

When the URL omits the port, the scheme's default port is returned:

Any other scheme returns null.

• urlstring

  The original input URL

• schemestring

  URL scheme without the trailing colon (e.g. https)

• hoststring

  Hostname

• portnumber|null

  Port number — the scheme's default port when the URL omits it, null if the scheme has no known default

• pathstring

  Path component

• paramsobject

  Query parameters — duplicate keys are grouped into an array

• fragmentstring

  Fragment identifier without the leading #

• validboolean

  Always true for a successfully parsed URL

If parameters are missing or invalid, the API will return an error:

• 400Please provide a URL (?url={URL})The url parameter is missing
• 400URL cannot exceed 2048 charactersThe url exceeds the maximum length
• 400Invalid URLThe url value cannot be parsed as a URL