1---
2c: Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al.
3SPDX-License-Identifier: curl
4Title: CURLINFO_SPEED_DOWNLOAD
5Section: 3
6Source: libcurl
7See-also:
8  - CURLINFO_SIZE_UPLOAD_T (3)
9  - CURLINFO_SPEED_UPLOAD (3)
10  - curl_easy_getinfo (3)
11  - curl_easy_setopt (3)
12Protocol:
13  - All
14Added-in: 7.4.1
15---
16
17# NAME
18
19CURLINFO_SPEED_DOWNLOAD - get download speed
20
21# SYNOPSIS
22
23~~~c
24#include <curl/curl.h>
25
26CURLcode curl_easy_getinfo(CURL *handle, CURLINFO_SPEED_DOWNLOAD,
27                           double *speed);
28~~~
29
30# DESCRIPTION
31
32Pass a pointer to a double to receive the average download speed that curl
33measured for the complete download. Measured in bytes/second.
34
35CURLINFO_SPEED_DOWNLOAD_T(3) is a newer replacement that returns a more
36sensible variable type.
37
38# %PROTOCOLS%
39
40# EXAMPLE
41
42~~~c
43int main(void)
44{
45  CURL *curl = curl_easy_init();
46  if(curl) {
47    CURLcode res;
48    curl_easy_setopt(curl, CURLOPT_URL, "https://example.com");
49
50    /* Perform the request */
51    res = curl_easy_perform(curl);
52
53    if(!res) {
54      double speed;
55      res = curl_easy_getinfo(curl, CURLINFO_SPEED_DOWNLOAD, &speed);
56      if(!res) {
57        printf("Download speed %.0f bytes/sec\n", speed);
58      }
59    }
60  }
61}
62~~~
63
64# DEPRECATED
65
66Deprecated since 7.55.0.
67
68# %AVAILABILITY%
69
70# RETURN VALUE
71
72Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
73