Cancels the current request.
Returns the response body length. Note: Some Web servers may not send a body length. In this case, the value returned will be -1. If using chunked transfer encoding, the body length will also be -1.
Returns the amount of bytes this HTTPRequest downloaded.
Returns the current status of the underlying HTTPClient. See HTTPClient.status.
Creates request on the underlying HTTPClient. If there is no configuration errors, it tries to connect using HTTPClient.connectToHost and passes parameters onto HTTPClient.request. Returns constant OK if request is successfully created. (Does not imply that the server has responded), constant ERR_UNCONFIGURED if not in the tree, constant ERR_BUSY if still processing previous request, constant ERR_INVALID_PARAMETER if given string is not a valid URL format, or constant ERR_CANT_CONNECT if not using thread and the HTTPClient cannot connect to host. Note: The request_data parameter is ignored if method is constant HTTPClient.METHOD_GET. This is because GET methods can't contain request data. As a workaround, you can pass request data as a query string in the URL. See String.httpEscape for an example.
Maximum allowed size for response bodies.
The size of the buffer used and maximum bytes to read per iteration. See HTTPClient.readChunkSize. Set this to a lower value (e.g. 4096 for 4 KiB) when downloading small files to decrease memory usage at the cost of download speeds.
The file to download into. Will output any received file into it.
Maximum number of allowed redirects.
If true, multithreading is used to improve performance.
Construct a new instance of HTTPRequest. Note: use memnew!HTTPRequest instead.
func _ready(): # Create an HTTP request node and connect its completion signal. var http_request = HTTPRequest.new() add_child(http_request) http_request.connect("request_completed", self, "_http_request_completed")
# Perform a GET request. The URL below returns JSON as of writing. var error = http_request.request("https://httpbin.org/get") if error != OK: push_error("An error occurred in the HTTP request.")
# Perform a POST request. The URL below returns JSON as of writing. # Note: Don't make simultaneous requests using a single HTTPRequest node. # The snippet below is provided for reference only. var body = {"name": "Godette"} error = http_request.request("https://httpbin.org/post", [], true, HTTPClient.METHOD_POST, body) if error != OK: push_error("An error occurred in the HTTP request.")
# Called when the HTTP request is completed. func _http_request_completed(result, response_code, headers, body): var response = parse_json(body.get_string_from_utf8())
# Will print the user agent string used by the HTTPRequest node (as recognized by httpbin.org). print(response.headers"User-Agent")
Example of loading and displaying an image using HTTPRequest:
func _ready(): # Create an HTTP request node and connect its completion signal. var http_request = HTTPRequest.new() add_child(http_request) http_request.connect("request_completed", self, "_http_request_completed")
# Perform the HTTP request. The URL below returns a PNG image as of writing. var error = http_request.request("https://via.placeholder.com/512") if error != OK: push_error("An error occurred in the HTTP request.")
# Called when the HTTP request is completed. func _http_request_completed(result, response_code, headers, body): var image = Image.new() var error = image.load_png_from_buffer(body) if error != OK: push_error("Couldn't load the image.")
var texture = ImageTexture.new() texture.create_from_image(image)
# Display the image in a TextureRect node. var texture_rect = TextureRect.new() add_child(texture_rect) texture_rect.texture = texture
A node with the ability to send HTTP(S) requests.
A node with the ability to send HTTP requests. Uses HTTPClient internally. Can be used to make HTTP requests, i.e. download or upload files or web content via HTTP. Warning: See the notes and warnings on HTTPClient for limitations, especially regarding SSL security. Example of contacting a REST API and printing one of its returned fields: