--- title: HTTP Client --- # HTTP Client This example uses ArduinoHttpClient with TinyGSM to perform HTTP requests for REST-style API interactions. --- ## The Complete Code ```cpp /** ============================================================================ * @example{lineno} HttpClient.ino * * @brief This sketch connects to a website and downloads a page using the * Arduino HTTP client library. * * It can be used to perform HTTP/RESTful API calls. * * For this example, you need to install ArduinoHttpClient library: * https://github.com/arduino-libraries/ArduinoHttpClient * or from http://librarymanager/all#ArduinoHttpClient * * For more HTTP API examples, see ArduinoHttpClient library * * @warning This example may NOT work with the XBee because the * HttpClient library does not empty the serial buffer fast enough * and the buffer overflow causes the HttpClient library to stall. * Boards with faster processors may work, 8 MHz boards will not. * ========================================================================== */ // Select your modem: // #define TINY_GSM_MODEM_SIM800 // #define TINY_GSM_MODEM_SIM808 // #define TINY_GSM_MODEM_SIM868 // #define TINY_GSM_MODEM_SIM900 // #define TINY_GSM_MODEM_SIM7000 // #define TINY_GSM_MODEM_SIM7000SSL // #define TINY_GSM_MODEM_SIM7080 // #define TINY_GSM_MODEM_SIM5360 // #define TINY_GSM_MODEM_SIM7600 // #define TINY_GSM_MODEM_A7672X // #define TINY_GSM_MODEM_UBLOX // #define TINY_GSM_MODEM_SARAR4 // #define TINY_GSM_MODEM_SARAR5 // #define TINY_GSM_MODEM_M95 // #define TINY_GSM_MODEM_BG95 // #define TINY_GSM_MODEM_BG96 // #define TINY_GSM_MODEM_A6 // #define TINY_GSM_MODEM_A7 // #define TINY_GSM_MODEM_M590 // #define TINY_GSM_MODEM_MC60 // #define TINY_GSM_MODEM_MC60E // #define TINY_GSM_MODEM_ESP32 // #define TINY_GSM_MODEM_ESP8266 // #define TINY_GSM_MODEM_ESP8266_NONOS // #define TINY_GSM_MODEM_XBEE // #define TINY_GSM_MODEM_SEQUANS_MONARCH // Set serial for debug console (to the Serial Monitor) #define SerialMon Serial // Set serial for AT commands (to the module) // Use Hardware Serial on Mega, Leonardo, Micro #if !defined(__AVR_ATmega328P__) && !defined(SerialAT) #define SerialAT Serial1 // or Software Serial on Uno, Nano #elif !defined(SerialAT) #include SoftwareSerial SerialAT(2, 3); // RX, TX #endif // Increase RX buffer to capture the entire response // Chips without internal buffering (A6/A7, ESP8266, M590) // need enough space in the buffer for the entire response // else data will be lost (and the http library will fail). #if !defined(TINY_GSM_RX_BUFFER) #define TINY_GSM_RX_BUFFER 256 #endif // See all AT commands, if wanted // WARNING: At high baud rates, incoming data may be lost when dumping AT // commands // #define DUMP_AT_COMMANDS // Define the serial console for debug prints, if needed // #define TINY_GSM_DEBUG SerialMon // #define LOGGING // <- Logging is for the HTTP library // Range to attempt to autobaud // NOTE: DO NOT AUTOBAUD in production code. Once you've established // communication, set a fixed baud rate using modem.setBaud(#). #define GSM_AUTOBAUD_MIN 9600 #define GSM_AUTOBAUD_MAX 921600 // Add a reception delay, if needed. // This may be needed for a fast processor at a slow baud rate. // #define TINY_GSM_YIELD_MS 2 // Define how you're planning to connect to the internet // These defines are only for this example; they are not needed in other code. #define TINY_GSM_USE_GPRS true #define TINY_GSM_USE_WIFI false // set GSM PIN, if any #define GSM_PIN "" // Your GPRS credentials, if any const char apn[] = "hologram"; const char gprsUser[] = ""; const char gprsPass[] = ""; // Your WiFi connection credentials, if applicable const char wifiSSID[] = "Stroud-Mobile"; const char wifiPass[] = "phone970"; // Server details to test TCP without SSL const char server[] = "time.sodaq.net"; const char resource[] = "/"; const int port = 80; #include #include #if (defined(ARDUINO_NRF52840_FEATHER)) && !defined(ADAFRUIT_TINYUSB_H_) #include // for Serial #endif // Just in case someone defined the wrong thing.. #if TINY_GSM_USE_GPRS && not defined TINY_GSM_MODEM_HAS_GPRS #undef TINY_GSM_USE_GPRS #undef TINY_GSM_USE_WIFI #define TINY_GSM_USE_GPRS false #define TINY_GSM_USE_WIFI true #endif #if TINY_GSM_USE_WIFI && not defined TINY_GSM_MODEM_HAS_WIFI #undef TINY_GSM_USE_GPRS #undef TINY_GSM_USE_WIFI #define TINY_GSM_USE_GPRS true #define TINY_GSM_USE_WIFI false #endif #ifdef DUMP_AT_COMMANDS #include StreamDebugger debugger(SerialAT, SerialMon); TinyGsm modem(debugger); #else TinyGsm modem(SerialAT); #endif TinyGsmClient client(modem); HttpClient http(client, server, port); void setup() { // Set console baud rate SerialMon.begin(115200); delay(10); // !!!!!!!!!!! #include TINY_GSM_MODEM_WAKEUP(); // !!!!!!!!!!! SerialMon.println("Wait..."); // Set GSM module baud rate TinyGsmAutoBaud(SerialAT, GSM_AUTOBAUD_MIN, GSM_AUTOBAUD_MAX); // SerialAT.begin(9600); delay(6000); // Restart takes quite some time // To skip it, call init() instead of restart() SerialMon.println("Initializing modem..."); modem.restart(); // modem.init(); String modemInfo = modem.getModemInfo(); SerialMon.print("Modem Info: "); SerialMon.println(modemInfo); #if TINY_GSM_USE_GPRS // Unlock your SIM card with a PIN if needed if (GSM_PIN && modem.getSimStatus() != SIM_READY) { // simUnlock will do nothing if the pin is empty modem.simUnlock(GSM_PIN); } #endif } void loop() { #if TINY_GSM_USE_WIFI // Wifi connection parameters must be set before waiting for the network SerialMon.print(F("Setting SSID/password...")); if (!modem.networkConnect(wifiSSID, wifiPass)) { SerialMon.println(" fail"); delay(10000); return; } SerialMon.println(" success"); #endif #if TINY_GSM_USE_GPRS && defined TINY_GSM_MODEM_XBEE // The XBee must run the gprsConnect function BEFORE waiting for network! modem.gprsConnect(apn, gprsUser, gprsPass); #endif SerialMon.print("Waiting for network..."); if (!modem.waitForNetwork()) { SerialMon.println(" fail"); delay(10000); return; } SerialMon.println(" success"); if (modem.isNetworkConnected()) { SerialMon.println("Network connected"); } #if TINY_GSM_USE_GPRS // GPRS connection parameters are usually set after network registration SerialMon.print(F("Connecting to ")); SerialMon.print(apn); if (!modem.gprsConnect(apn, gprsUser, gprsPass)) { SerialMon.println(" fail"); delay(10000); return; } SerialMon.println(" success"); if (modem.isGprsConnected()) { SerialMon.println("GPRS connected"); } #endif SerialMon.print(F("Performing HTTP GET request... ")); int err = http.get(resource); if (err != 0) { SerialMon.println(F("failed to connect")); delay(10000); return; } int status = http.responseStatusCode(); SerialMon.print(F("Response status code: ")); SerialMon.println(status); if (!status) { delay(10000); return; } SerialMon.println(F("Response Headers:")); while (http.headerAvailable()) { String headerName = http.readHeaderName(); String headerValue = http.readHeaderValue(); SerialMon.println(" " + headerName + " : " + headerValue); } int length = http.contentLength(); if (length >= 0) { SerialMon.print(F("Content length is: ")); SerialMon.println(length); } if (http.isResponseChunked()) { SerialMon.println(F("The response is chunked")); } String body = http.responseBody(); SerialMon.println(F("Response:")); SerialMon.println(body); SerialMon.print(F("Body length is: ")); SerialMon.println(body.length()); // Shutdown http.stop(); SerialMon.println(F("Server disconnected")); #if TINY_GSM_USE_WIFI modem.networkDisconnect(); SerialMon.println(F("WiFi disconnected")); #endif #if TINY_GSM_USE_GPRS modem.gprsDisconnect(); SerialMon.println(F("GPRS disconnected")); #endif // Do nothing forevermore while (true) { delay(1000); } } ``` ------------------------------- Generated by [Doxygen](https://www.doxygen.nl) and [m.css](https://mcss.mosra.cz/) with templates from [doxybook2](https://github.com/matusnovak/doxybook2) Updated on 2026-09-11