The curlExecute function can be used to transfer data to or from a server. You can use the function to make calls to Web APIs, transfer files to and from FTP servers, and much more.

curlExecute is powered by the libcurl library. curlExecute has been designed to expose as much of the underlying library as possible. As a result, curlExecute supports a very wide range of options. Some of the most commonly used options are documented below. For a complete list of options, click here.

When calling the curlExecute function, you must pass it an object that represents the cURL options that you want to use.

For example, this snippet of code indicates that you want to make an HTTP request to URL "https://swapi.dev/api/films/1/" and that you want the results to be available via a variable named "curlResult."

The result of the curlExecute function is a JSON-encoded string. To use the result, you'd convert it to a JavaScript object using JSON.parse.

Here's a slightly modified version of the example above, showing the use of JSON.parse to convert the response to an object.

The curlExecute response object's properties include:

errorCode
An integer value indicating the type of error that occurred, if applicable. The errorCode will be zero if no error occurred. For a list of error codes and descriptions, click here.

errorMessage
A description of the error that occurred, if applicable. The errorMessage will be blank if no error occurred. For a list of error codes and descriptions, click here.

responseCode
The HTTP response (status) code that was returned, if applicable. For a list of HTTP status codes, click here.

debug
A detailed transcript of the cURL command execution, which is helpful when debugging calls.

output
The output returned by the call, if applicable. For example, if you are making a call to a Web API, the API response will be available here.

responseHeaders
An object representing the HTTP headers that were returned by the remote server.

responseHeadersRaw
A string representing the HTTP headers that were returned by the remote server.

elapsedTime
An object that contains the total elapsed time that the cURL command took to complete, in milliseconds, seconds, and minutes.

properties
The cURL properties that were used to make the call.

For examples of the curlExecute function, click here.