WOLFRAM

Wolfram Language & System Documentation Center

ConnectionSettings

is an option for URLRead and related functions to specify advanced connection settings.

Details
Details and Options Details and Options
Examples  
Basic Examples  
See Also
History
Cite this Page

ConnectionSettings

ConnectionSettings

is an option for URLRead and related functions to specify advanced connection settings.

Details

  • ConnectionSettings takes an association with the following keys:
  • "MaxDownloadSpeed"Automaticmaximum allowed download speed
    "MaxUploadSpeed"Automaticmaximum allowed upload speed
  • Maximum download and upload speed settings are approximate speed settings.
  • Maximum download and upload speeds can be given as Quantity expressions.
  • Speeds given as integers are interpreted as bytes per second.

Examples

Basic Examples  (3)

Download at 12,500 bytes per second:

Wolfram Language code: URLRead["https://www.wolfram.com", "BodyByteArray", ConnectionSettings -> <|"MaxDownloadSpeed" -> 12500|>]//AbsoluteTiming

Download at 100 Kbps:

Wolfram Language code: AbsoluteTiming[URLRead["https://www.wolfram.com", "BodyByteArray", ConnectionSettings -> <|"MaxDownloadSpeed" -> Quantity[100, "Kbps"]|>]]

Download at twice the speed:

Wolfram Language code: AbsoluteTiming[URLRead["https://www.wolfram.com", "BodyByteArray", ConnectionSettings -> <|"MaxDownloadSpeed" -> Quantity[200, "Kbps"]|>]]

Create an APIFunction returning the number of characters in a string:

Wolfram Language code: api = APIFunction[{"x" -> "String"}, StringLength[#x]&]

Deploy the APIFunction to the cloud:

Wolfram Language code: co = CloudDeploy[api, CloudObject["string-length"], Permissions -> "Public"]

Get the URL:

Wolfram Language code: url = First[co]

Create a long string:

Wolfram Language code: longString = StringJoin[ConstantArray["x", 100000]]; StringLength[longString]

Upload the string to the API at 400 Kbps:

Wolfram Language code: AbsoluteTiming[ URLRead[ HTTPRequest[url, <|Method -> "POST", "Body" -> {"x" -> longString}|> ], "Body", ConnectionSettings -> <|"MaxUploadSpeed" -> Quantity[400, "Kbps"]|> ]]

Upload the string to the API at 800 Kbps:

Wolfram Language code: AbsoluteTiming[ URLRead[ HTTPRequest[url, <|Method -> "POST", "Body" -> {"x" -> longString}|> ], "Body", ConnectionSettings -> <|"MaxUploadSpeed" -> Quantity[800, "Kbps"]|> ]]

The expected time to upload a 100,000 character string at 800 Kbps is about one second:

Wolfram Language code: Quantity[ByteCount[longString], "Bytes"] / Quantity[800., "Kbps"]
Wolfram Research (2019), ConnectionSettings, Wolfram Language function, https://reference.wolfram.com/language/ref/ConnectionSettings.html.

Text

Wolfram Research (2019), ConnectionSettings, Wolfram Language function, https://reference.wolfram.com/language/ref/ConnectionSettings.html.

CMS

Wolfram Language. 2019. "ConnectionSettings." Wolfram Language & System Documentation Center. Wolfram Research. https://reference.wolfram.com/language/ref/ConnectionSettings.html.

APA

Wolfram Language. (2019). ConnectionSettings. Wolfram Language & System Documentation Center. Retrieved from https://reference.wolfram.com/language/ref/ConnectionSettings.html

BibTeX

@misc{reference.wolfram_2026_connectionsettings, author="Wolfram Research", title="{ConnectionSettings}", year="2019", howpublished="\url{https://reference.wolfram.com/language/ref/ConnectionSettings.html}", note=[Accessed: 12-June-2026]}

BibLaTeX

@online{reference.wolfram_2026_connectionsettings, organization={Wolfram Research}, title={ConnectionSettings}, year={2019}, url={https://reference.wolfram.com/language/ref/ConnectionSettings.html}, note=[Accessed: 12-June-2026]}