HTTPClient

Inherits: Reference < Object

Low-level hyper-text transfer protocol client.

Descripción

Hyper-text transfer protocol client (sometimes called "User Agent"). Used to make HTTP requests to download web content, upload files and other data or to communicate with various services, among other use cases. See the :ref:`HTTPRequest<class_HTTPRequest>` node for a higher-level alternative.

Note: This client only needs to connect to a host once (see connect_to_host) to send multiple requests. Because of this, methods that take URLs usually take just the part after the host instead of the full URL, as the client is already connected to a host. See request for a full example and to get started.

A HTTPClient should be reused between multiple requests or to connect to different hosts instead of creating one client per request. Supports SSL and SSL server certificate verification. HTTP status codes in the 2xx range indicate success, 3xx redirection (i.e. "try again, but over here"), 4xx something was wrong with the request, and 5xx something went wrong on the server's side.

For more information on HTTP, see https://developer.mozilla.org/en-US/docs/Web/HTTP (or read RFC 2616 to get it straight from the source: https://tools.ietf.org/html/rfc2616).

Note: When performing HTTP requests from a project exported to HTML5, keep in mind the remote server may not allow requests from foreign origins due to CORS. If you host the server in question, you should modify its backend to allow requests from foreign origins by adding the Access-Control-Allow-Origin: * HTTP header.

Note: SSL/TLS support is currently limited to TLS 1.0, TLS 1.1, and TLS 1.2. Attempting to connect to a TLS 1.3-only server will return an error.

Warning: SSL/TLS certificate revocation and certificate pinning are currently not supported. Revoked certificates are accepted as long as they are otherwise valid. If this is a concern, you may want to use automatically managed certificates with a short validity period.

Enumeraciones

enum Method:

  • METHOD_GET = 0 --- Método HTTP GET. El método GET solicita una representación del recurso especificado. Las solicitudes que utilizan GET sólo deben recuperar datos.

  • METHOD_HEAD = 1 --- Método HTTP HEAD. El método HEAD pide una respuesta idéntica a la de una petición GET, pero sin el cuerpo de respuesta. Esto es útil para solicitar metadatos como cabeceras HTTP o para comprobar si existe un recurso.

  • METHOD_POST = 2 --- Método HTTP POST. El método POST se utiliza para someter una entidad al recurso especificado, a menudo causando un cambio de estado o efectos secundarios en el servidor. A menudo se utiliza para formularios y para enviar datos o cargar archivos.

  • METHOD_PUT = 3 --- Método HTTP PUT. El método PUT pide reemplazar todas las representaciones actuales del recurso de destino con la carga útil de la solicitud. (Puedes pensar en POST como "crear o actualizar" y en PUT como "actualizar", aunque muchos servicios tienden a no hacer una distinción clara o a cambiar su significado).

  • METHOD_DELETE = 4 --- Método HTTP DELETE. El método DELETE pide que se elimine el recurso especificado.

  • METHOD_OPTIONS = 5 --- Método OPTIONS HTTP. El método OPTIONS pide una descripción de las opciones de comunicación para el recurso objetivo. Rara vez se utiliza.

  • METHOD_TRACE = 6 --- Método HTTP TRACE. El método TRACE realiza una prueba de bucle de mensajes a lo largo del camino hacia el recurso objetivo. Devuelve toda la petición HTTP recibida en el cuerpo de respuesta. Rara vez se usa.

  • METHOD_CONNECT = 7 --- Método HTTP CONNECT. El método CONNECT establece un túnel hacia el servidor identificado por el recurso objetivo. Rara vez se utiliza.

  • METHOD_PATCH = 8 --- Método HTTP PATCH. El método PATCH se utiliza para aplicar modificaciones parciales a un recurso.

  • METHOD_MAX = 9 --- Representa el tamaño del enum Method.


enum Status:

  • STATUS_DISCONNECTED = 0 --- Estado: Desconectado del servidor.

  • STATUS_RESOLVING = 1 --- Estado: Actualmente resolviendo el nombre del host para la URL dada, en una IP.

  • STATUS_CANT_RESOLVE = 2 --- Estado: Fallo del DNS: No se puede resolver el nombre de host para la URL dada.

  • STATUS_CONNECTING = 3 --- Estado: Actualmente conectándose al servidor.

  • STATUS_CANT_CONNECT = 4 --- Estado: No puede conectarse al servidor.

  • STATUS_CONNECTED = 5 --- Estado: Conexión establecida.

  • STATUS_REQUESTING = 6 --- Estado: Actualmente enviando la petición.

  • STATUS_BODY = 7 --- Estado: Cuerpo HTTP recibido.

  • STATUS_CONNECTION_ERROR = 8 --- Estado: Error en la conexión HTTP.

  • STATUS_SSL_HANDSHAKE_ERROR = 9 --- Estado: Error en el handshake SSL.


enum ResponseCode:

  • RESPONSE_CONTINUE = 100 --- Código de estado HTTP ``100 Continuar ``. Respuesta provisional que indica que todo hasta ahora está bien y que el cliente debe continuar con la solicitud (o ignorar este estado si ya ha terminado).

  • RESPONSE_SWITCHING_PROTOCOLS = 101 --- Código de estado HTTP 101 Switching Protocol. Enviado en respuesta a una solicitud de Upgrade por el cliente. Indica el protocolo al que el servidor está cambiando.

  • RESPONSE_PROCESSING = 102 --- Código de estado HTTP 102 Processing (WebDAV). Indica que el servidor ha recibido y está procesando la solicitud, pero aún no hay respuesta disponible.

  • RESPONSE_OK = 200 --- Código de estado HTTP 200 OK. La petición ha tenido éxito. Respuesta por defecto para las solicitudes con exito. El significado varía dependiendo de la solicitud. GET: El recurso ha sido recuperado y se transmite en el cuerpo del mensaje. HEAD: Las cabeceras de la entidad están en el cuerpo del mensaje. POST: El recurso que describe el resultado de la acción se transmite en el cuerpo del mensaje. TRACE: El cuerpo del mensaje contiene el mensaje de solicitud tal y como lo recibió el servidor.

  • RESPONSE_CREATED = 201 --- Código de estado HTTP 201 Creado. La petición ha tenido éxito y se ha creado un nuevo recurso como resultado de ella. Esta es típicamente la respuesta enviada después de una solicitud PUT.

  • RESPONSE_ACCEPTED = 202 --- Código de estado HTTP 202 Accepted. La solicitud ha sido recibida pero aún no se ha actuado al respecto. No se ha tomado ninguna medida, lo que significa que no hay forma de que HTTP envíe más tarde una respuesta asincrónica que indique el resultado del procesamiento de la solicitud. Está destinado a los casos en que otro proceso o servidor se encarga de la solicitud, o para el procesamiento por lotes.

  • RESPONSE_NON_AUTHORITATIVE_INFORMATION = 203 --- Código de estado HTTP ``203 Información no autorizada ``. Este código de respuesta significa que el conjunto de meta-información devuelta no está exactamente establecida como disponible en el servidor de origen, sino que se ha recogido de una copia local o de un tercero. Excepto en esta condición, se debe preferir la respuesta 200 OK en lugar de esta respuesta.

  • RESPONSE_NO_CONTENT = 204 --- Código de estado HTTP ``204 No hay contenido ``. No hay contenido que enviar para esta petición, pero los encabezados pueden ser útiles. El user-agent puede actualizar sus cabeceras en caché para este recurso con las nuevas.

  • RESPONSE_RESET_CONTENT = 205 --- Código de estado HTTP 205 Reset Content. El servidor ha cumplido la solicitud y desea que el cliente restablezca la "vista del documento" que causó que la solicitud se enviara a su estado original tal como se recibió del servidor de origen.

  • RESPONSE_PARTIAL_CONTENT = 206 --- Código de estado HTTP 206 Partial Content. Este código de respuesta se utiliza debido a un encabezado de rango enviado por el cliente para separar la descarga en múltiples flujos.

  • RESPONSE_MULTI_STATUS = 207 --- Código de estado HTTP 207 Multi-Status (WebDAV). Una respuesta Multi-Status transmite información sobre múltiples recursos en situaciones en las que podrían ser apropiados múltiples códigos de estado.

  • RESPONSE_ALREADY_REPORTED = 208 --- Código de estado HTTP 208 Already Reported (WebDAV). Utilizado dentro de un DAV: elemento de respuesta propstat para evitar enumerar los miembros internos de múltiples enlaces a la misma colección repetidamente.

  • RESPONSE_IM_USED = 226 --- Código de estado HTTP 226 IM Used (WebDAV). El servidor ha cumplido una solicitud GET para el recurso, y la respuesta es una representación del resultado de una o más manipulaciones de instancia aplicadas a la instancia actual.

  • RESPONSE_MULTIPLE_CHOICES = 300 --- Código de estado HTTP 300 Multiple Choice. La solicitud tiene más de una respuesta posible y no hay una forma estandarizada de elegir una de las respuestas. El user-agent o el usuario debe elegir una de ellas.

  • RESPONSE_MOVED_PERMANENTLY = 301 --- Código de estado HTTP 301 Moved Permanently. Redirección. Este código de respuesta significa que la URI del recurso solicitado ha sido cambiada. La nueva URI suele estar incluida en la respuesta.

  • RESPONSE_FOUND = 302 --- Código de estado HTTP 302 Found. Redireccionamiento temporal. Este código de respuesta significa que la URI del recurso solicitado ha sido cambiada temporalmente. Nuevos cambios en la URI podrían hacerse en el futuro. Por lo tanto, esta misma URI debería ser utilizada por el cliente en futuras solicitudes.

  • RESPONSE_SEE_OTHER = 303 --- Código de estado HTTP 303 See Other. El servidor está redirigiendo el user agent a un recurso diferente, como se indica en una URI en el campo de encabezamiento de la localización, que tiene por objeto proporcionar una respuesta indirecta a la solicitud original.

  • RESPONSE_NOT_MODIFIED = 304 --- Código de estado HTTP 304 Not Modified. Se ha recibido una solicitud condicional GET o HEAD que habría dado lugar a una respuesta de 200 OK si no fuera por el hecho de que la condición fue evaluada a false.

  • RESPONSE_USE_PROXY = 305 --- Código de estado HTTP 305 Use Proxy. Descartado. No Usar.

  • RESPONSE_SWITCH_PROXY = 306 --- Código de estado HTTP 306 Switch Proxy. Descartado. No Usar.

  • RESPONSE_TEMPORARY_REDIRECT = 307 --- Código de estado HTTP 307 Temporary Redirect. El recurso objetivo reside temporalmente bajo una URI diferente y el user-agent NO DEBE cambiar el método de solicitud si realiza una redirección automática a esa URI.

  • RESPONSE_PERMANENT_REDIRECT = 308 --- Código de estado HTTP 308 Permanent Redirect. Al recurso objetivo se le ha asignado una nueva URI permanente y cualquier referencia futura a este recurso deberá utilizar una de las URI adjuntas.

  • RESPONSE_BAD_REQUEST = 400 --- Código de estado HTTP 400 Bad Request. La solicitud era inválida. El servidor no puede o no quiere procesar la solicitud debido a algo que se percibe como un error del cliente (por ejemplo, sintaxis de solicitud mal formada, enmarcado de mensaje de solicitud inválido, contenido de solicitud inválido o enrutamiento de solicitud engañoso).

  • RESPONSE_UNAUTHORIZED = 401 --- Código de estado HTTP 401 Unauthorized. Se requieren credenciales. La solicitud no se ha aplicado porque carece de credenciales de autenticación válidas para el recurso de destino.

  • RESPONSE_PAYMENT_REQUIRED = 402 --- Código de estado HTTP 402 Payment Required. Este código de respuesta está reservado para un uso futuro. El objetivo inicial para crear este código era usarlo para sistemas de pago digitales, sin embargo no se usa actualmente.

  • RESPONSE_FORBIDDEN = 403 --- Código de estado HTTP 403 Forbidden. El cliente no tiene derechos de acceso al contenido, es decir, no están autorizados, por lo que el servidor se está negando a dar una respuesta adecuada. A diferencia de 401, la identidad del cliente es conocida por el servidor.

  • RESPONSE_NOT_FOUND = 404 --- Código de estado HTTP 404 Not Found. El servidor no puede encontrar el recurso solicitado. La URL no se reconoce o el punto final es válido pero el recurso en sí no existe. También puede ser enviado en lugar de 403 para ocultar la existencia de un recurso si el cliente no está autorizado.

  • RESPONSE_METHOD_NOT_ALLOWED = 405 --- Código de estado HTTP 405 Method Not Allowed. El método HTTP de la petición es conocido por el servidor pero ha sido desactivado y no puede ser utilizado. Por ejemplo, una API puede prohibir la eliminación de un recurso. Los dos métodos obligatorios, GET y HEAD, nunca deben ser desactivados y no deben devolver este código de error.

  • RESPONSE_NOT_ACCEPTABLE = 406 --- Código de estado HTTP 406 Not Acceptable. El recurso de destino no tiene una representación actual que sería aceptable para el agente usuario, según los campos del encabezado de negociación proactiva recibidos en la solicitud. Se utiliza cuando el contenido de la negociación.

  • RESPONSE_PROXY_AUTHENTICATION_REQUIRED = 407 --- Código de estado HTTP 407 Proxy Authentication Required. Similar a 401 No autorizado, pero indica que el cliente necesita autenticarse para usar un proxy.

  • RESPONSE_REQUEST_TIMEOUT = 408 --- Código de estado HTTP ``408 Solicitud de tiempo de espera ``. El servidor no recibió un mensaje de solicitud completo en el tiempo que estaba preparado para esperar.

  • RESPONSE_CONFLICT = 409 --- Código de estado HTTP 409 Conflict. La solicitud no pudo completarse debido a un conflicto con el estado actual del recurso objetivo. Este código se utiliza en situaciones en las que el usuario podría resolver el conflicto y volver a enviar la solicitud.

  • RESPONSE_GONE = 410 --- Código de estado HTTP 410 Gone. El recurso objetivo ya no está disponible en el servidor de origen y esta condición es probablemente permanente.

  • RESPONSE_LENGTH_REQUIRED = 411 --- Código de estado HTTP 411 Length Required. El servidor se niega a aceptar la solicitud sin un encabezado de longitud de contenido definido.

  • RESPONSE_PRECONDITION_FAILED = 412 --- Código de estado HTTP 412 Precondition Failed. Una o más condiciones dadas en los campos de la cabecera de la petición evaluadas a false al ser probadas en el servidor.

  • RESPONSE_REQUEST_ENTITY_TOO_LARGE = 413 --- Código de estado HTTP 413 Entity Too large. El servidor se niega a procesar una solicitud porque la carga útil de la solicitud es mayor de lo que el servidor está dispuesto o puede procesar.

  • RESPONSE_REQUEST_URI_TOO_LONG = 414 --- Código de estado HTTP 414 Request-URI Too Long. El servidor se niega a atender la solicitud porque el objetivo de la solicitud es más largo de lo que el servidor está dispuesto a interpretar.

  • RESPONSE_UNSUPPORTED_MEDIA_TYPE = 415 --- Código de estado HTTP 415 Unsupported Media Type. El servidor de origen se niega a atender la solicitud porque la carga útil está en un formato no soportado por este método en el recurso de destino.

  • RESPONSE_REQUESTED_RANGE_NOT_SATISFIABLE = 416 --- Código de estado HTTP 416 Requested Range Not Satisfiable. Ninguno de los rangos en el campo de encabezamiento del rango de la solicitud se superpone a la extensión actual del recurso seleccionado o el conjunto de rangos solicitados ha sido rechazado debido a rangos inválidos o a una solicitud excesiva de rangos pequeños o superpuestos.

  • RESPONSE_EXPECTATION_FAILED = 417 --- Código de estado HTTP 417 Expectation Failed. La expectativa dada en el campo de encabezado Expect de la solicitud no pudo ser satisfecha por al menos uno de los servidores de entrada.

  • RESPONSE_IM_A_TEAPOT = 418 --- Código de estado HTTP 418 I'm A Teapot. Cualquier intento de preparar café con una tetera debería dar como resultado el código de error "418 I'm a Teapot". El cuerpo de la entidad resultante PUEDE ser corto y robusto.

  • RESPONSE_MISDIRECTED_REQUEST = 421 --- Código de estado HTTP 421 Misdirected Request. La solicitud fue dirigida a un servidor que no es capaz de producir una respuesta. Esto puede ser enviado por un servidor que no está configurado para producir respuestas para la combinación de esquema y autoridad que se incluyen en la URI de la solicitud.

  • RESPONSE_UNPROCESSABLE_ENTITY = 422 --- Código de estado HTTP 422 Unprocessable Entity (WebDAV). El servidor entiende el tipo de contenido de la entidad de solicitud (por lo tanto, un código de estado 415 Unsupported Media Type es inapropiado), y la sintaxis de la entidad de solicitud es correcta (por lo tanto, un código de estado 400 Bad Request es inapropiado) pero no pudo procesar las instrucciones contenidas.

  • RESPONSE_LOCKED = 423 --- Código de estado HTTP 423 Locked (WebDAV). El recurso de origen o destino de un método está bloqueado.

  • RESPONSE_FAILED_DEPENDENCY = 424 --- Código de estado HTTP 424 Failed Dependency (WebDAV). El método no pudo realizarse en el recurso porque la acción solicitada dependía de otra acción y esa acción falló.

  • RESPONSE_UPGRADE_REQUIRED = 426 --- Código de estado HTTP 426 Upgrade Required. El servidor se niega a realizar la solicitud utilizando el protocolo actual, pero podría estar dispuesto a hacerlo después de que el cliente se actualice a un protocolo diferente.

  • RESPONSE_PRECONDITION_REQUIRED = 428 --- Código de estado HTTP 428 Precondition Required. El servidor de origen requiere que la petición sea condicional.

  • RESPONSE_TOO_MANY_REQUESTS = 429 --- Código de estado HTTP 429 Too Many Requests. El usuario ha enviado demasiadas solicitudes en un período de tiempo determinado (véase "limitación de la tasa"). Retroceda y aumente el tiempo entre las solicitudes o inténtelo de nuevo más tarde.

  • RESPONSE_REQUEST_HEADER_FIELDS_TOO_LARGE = 431 --- Código de estado HTTP 431 Request Header Fields Too Large. El servidor no está dispuesto a procesar la solicitud porque los campos de la cabecera son demasiado grandes. La solicitud PUEDE volver a enviarse después de reducir el tamaño de los campos de la cabecera de la solicitud.

  • RESPONSE_UNAVAILABLE_FOR_LEGAL_REASONS = 451 --- Código de estado HTTP 451 Response Unavailable for Legal Reasons. El servidor está negando el acceso al recurso como consecuencia de una demanda legal.

  • RESPONSE_INTERNAL_SERVER_ERROR = 500 --- Código de estado HTTP 500 Internal Server Error. El servidor se encontró con una condición inesperada que le impidió cumplir con la solicitud.

  • RESPONSE_NOT_IMPLEMENTED = 501 --- Código de estado HTTP 501 Not Implemented. El servidor no soporta la funcionalidad requerida para cumplir con la solicitud.

  • RESPONSE_BAD_GATEWAY = 502 --- Código de estado HTTP 502 Bad Gateway. El servidor, mientras actuaba como gateway o proxy, recibió una respuesta inválida de un servidor entrante al que accedió mientras intentaba cumplir la solicitud. Normalmente devuelta por los balanceadores de carga o proxies.

  • RESPONSE_SERVICE_UNAVAILABLE = 503 --- Código de estado HTTP 503 Service Unavailable. El servidor no puede actualmente atender la solicitud debido a una sobrecarga temporal o a un mantenimiento programado, que probablemente se aliviará después de algún retraso. Inténtelo de nuevo más tarde.

  • RESPONSE_GATEWAY_TIMEOUT = 504 --- Código de estado HTTP 504 Gateway Timeout. El servidor, aunque actuaba como gateway o proxy, no recibía una respuesta oportuna de un servidor ascendente al que necesitaba acceder para completar la solicitud. Normalmente se devuelve por los balanceadores de carga o proxies.

  • RESPONSE_HTTP_VERSION_NOT_SUPPORTED = 505 --- Código de estado HTTP 505 Versión HTTP Not Supported. El servidor no soporta, o se niega a soportar, la versión principal de HTTP que se utilizó en el mensaje de solicitud.

  • RESPONSE_VARIANT_ALSO_NEGOTIATES = 506 --- Código de estado HTTP 506 Variant Also Negotiates. El servidor tiene un error de configuración interna: el recurso de la variante elegida está configurado para participar en una negociación de contenido transparente en sí misma, y por lo tanto no es un punto final adecuado en el proceso de negociación.

  • RESPONSE_INSUFFICIENT_STORAGE = 507 --- Código de estado HTTP 507 Insufficient Storage. El método no pudo realizarse en el recurso porque el servidor no puede almacenar la representación necesaria para completar con éxito la solicitud.

  • RESPONSE_LOOP_DETECTED = 508 --- Código de estado HTTP 508 Loop Detected. El servidor terminó una operación porque encontró un bucle infinito mientras procesaba una petición con "Depth:infinity". Este estado indica que la operación entera falló.

  • RESPONSE_NOT_EXTENDED = 510 --- Código de estado HTTP 510 Not Extended. La política de acceso al recurso no se ha cumplido en la solicitud. El servidor debería devolver toda la información necesaria para que el cliente emita una solicitud extendida.

  • RESPONSE_NETWORK_AUTH_REQUIRED = 511 --- Código de estado HTTP 511 Network Authentication Required. El cliente necesita autenticarse para obtener acceso a la red.

Descripciones de Propiedades

  • bool blocking_mode_enabled

Default

false

Setter

set_blocking_mode(value)

Getter

is_blocking_mode_enabled()

Si true, la ejecución se bloqueará hasta que se lean todos los datos de la respuesta.


Setter

set_connection(value)

Getter

get_connection()

La conexión a usar para este cliente.


  • int read_chunk_size

Default

65536

Setter

set_read_chunk_size(value)

Getter

get_read_chunk_size()

El tamaño de la memoria intermedia utilizada y el máximo de bytes a leer por iteración. Véase read_response_body_chunk.

Descripciones de Métodos

  • void close ( )

Cierra la conexión actual, permitiendo la reutilización de este HTTPClient.


Se conecta a un host. Esto debe hacerse antes de que se envíe cualquier solicitud.

El host no debe tener preparado http://, pero eliminará el identificador del protocolo si se le proporciona.

Si no se especifica port (o se utiliza -1), se establece automáticamente en 80 para HTTP y en 443 para HTTPS (si se activa use_ssl).

verify_host comprobará la identidad SSL del host si se establece en true.


  • int get_response_body_length ( ) const

Devuelve la longitud del cuerpo de la respuesta.

Nota: Algunos servidores web pueden no enviar la longitud del cuerpo. En este caso, el valor devuelto será -1. Si se utiliza la codificación de transferencia de trozos, la longitud del cuerpo también será -1.


  • int get_response_code ( ) const

Devuelve el código de estado HTTP de la respuesta.


Devuelve las cabeceras de la respuesta.


  • Dictionary get_response_headers_as_dictionary ( )

Devuelve todos los encabezados de respuesta como un diccionario de estructura {"key": "value1; value2" } donde la sensibilidad a mayúsculas y minúsculas de las claves y valores se mantiene como el servidor lo entrega. Un valor es una simple String, esta string puede tener más de un valor donde "; " se utiliza como separador.

Ejemplo:

{
    "content-length": 12,
    "Content-Type": "application/json; charset=UTF-8",
}

Devuelve una constant Status. Necesito llamar a poll para obtener actualizaciones de estado.


  • bool has_response ( ) const

Si true, este HTTPClient tiene una respuesta disponible.


  • bool is_response_chunked ( ) const

Si true, este HTTPClient tiene una respuesta que es troceada.


Hay que llamar a esto para que se procese cualquier solicitud. Comprueba los resultados con get_status.


Genera una string de consulta de estilo GET/POST/x-www-form-urlencoded desde un diccionario proporcionado, por ejemplo:

codeblock]

var campos = {"nombreusuario": "usuario", "password": "contrasena"}

var query_string = http_client.query_string_from_dict(campos)

# Returns "nombreusuario=usuario&password=contrasena"

Además, si una clave tiene un valor null, sólo se añade la propia clave, sin igual signo y valor. Si el valor es un array, por cada valor en ella se añade un par con la misma clave.

var campos = {"unico": 123, "no_valor": null, "multiple": [22, 33, 44]}
var query_string = http_client.query_string_from_dict(fields)
# Devuelve "unico=123&no_valor&multiple=22&multiple=33&multiple=44"

Lee un trozo de la respuesta.


Sends a request to the connected host.

The URL parameter is usually just the part after the host, so for http://somehost.com/index.php, it is /index.php. When sending requests to an HTTP proxy server, it should be an absolute URL. For METHOD_OPTIONS requests, * is also allowed. For METHOD_CONNECT requests, it should be the authority component (host:port).

Headers are HTTP request headers. For available HTTP methods, see Method.

To create a POST request with query strings to push to the server, do:

var fields = {"username" : "user", "password" : "pass"}
var query_string = http_client.query_string_from_dict(fields)
var headers = ["Content-Type: application/x-www-form-urlencoded", "Content-Length: " + str(query_string.length())]
var result = http_client.request(http_client.METHOD_POST, "/index.php", headers, query_string)

Note: The request_data parameter is ignored if method is 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.http_escape for an example.


Sends a raw request to the connected host.

The URL parameter is usually just the part after the host, so for http://somehost.com/index.php, it is /index.php. When sending requests to an HTTP proxy server, it should be an absolute URL. For METHOD_OPTIONS requests, * is also allowed. For METHOD_CONNECT requests, it should be the authority component (host:port).

Headers are HTTP request headers. For available HTTP methods, see Method.

Sends the body data raw, as a byte array and does not encode it in any way.


  • void set_http_proxy ( String host, int port )

Sets the proxy server for HTTP requests.

The proxy server is unset if host is empty or port is -1.


  • void set_https_proxy ( String host, int port )

Sets the proxy server for HTTPS requests.

The proxy server is unset if host is empty or port is -1.