Go Headless

Build Apps

Client

API Preview

Develop Websites

REST

Velo

GraphQL (Alpha)

string

options

WixFetchRequest

Retrieves the specified resource from the network using HTTPS.

The `fetch()` function fetches an HTTPS resource from the network. It returns
 a Promise that resolves to a [`WixFetchResponse`](wix-fetch.WixFetchResponse.html)
 object representing the HTTP response to the request.

 Responses with an HTTP status code in the ranges 2xx, 4xx, and 5xx are
 considered fulfilled. Use the [`httpResponse.ok`](wix-fetch.WixFetchResponse.html#ok)
 property to confirm that the HTTP request was successful with a response
 code in the 2xx range.

 The optional `WixFetchRequest` object contains information about an HTTPS request.
 Additional functionality is available in each of the respective [Fetch API implementations](wix-fetch/introduction).

 > **Notes:**
 > Some common errors when using the `fetch()` function are described here along with possible solutions.
 >
 > - You can usually tell if you are experiencing these issues by checking your browser's console using the [browser's developer tools](https://developer.mozilla.org/en-US/docs/Learn/Common_questions/What_are_browser_developer_tools).
 > - Certain [CORS](https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS) (Cross-Origin Resource Sharing) requests are restricted when originating from a browser. Usually, GET requests and certain POST requests can be made
 >   from your site's **Public**, **Page**, or **Site** code. All other requests need to be made from your site's **Backend** code. If you are experiencing an issue with a `fetch()`
 >   call due to a CORS restriction, move the `fetch()` call to the backend as described in [Accessing 3rd-Party Services](https://support.wix.com/en/article/accessing-3rd-party-services#backend-service-call).
 > - Because all Wix sites use HTTPS, you can't request HTTP content from a service in your site's code.

import {fetch} from 'wix-fetch';

// ...

fetch("https://someapi.com/api/someendpoint", {"method": "get"})
  .then( (httpResponse) => {
    if (httpResponse.ok) {
      return httpResponse.json();
    } else {
      return Promise.reject("Fetch did not succeed");
    }
  } )
  .then(json => console.log(json.someKey))
  .catch(err => console.log(err));

Get a resource

import {fetch} from 'wix-fetch';

// ...

fetch( "https://someapi.com/api/someendpoint", {
  "method": "post",
  "headers": {
    "Content-Type": "application/x-www-form-urlencoded"
  },
  "body": "somekey=somevalue"
} )
  .then( (httpResponse) => {
    if (httpResponse.ok) {
      return httpResponse.json();
    } else {
      return Promise.reject("Fetch did not succeed");
    }
  } )
  .then( (json) => console.log(json.someKey) )
  .catch(err => console.log(err));

Post data to a resource

import {fetch} from 'wix-fetch';

// ...

fetch("https://someapi.com/api/someendpoint", {"method": "get"})
  .then( (httpResponse) => {
    let url = httpResponse.url;
    let statusCode = httpResponse.status;
    let statusText = httpResponse.statusText;
    let headers = httpResponse.headers;
    let bodyUsed = httpResponse.bodyUsed;
    if (httpResponse.ok) {
      return httpResponse.json();
    }
    else {
      return Promise.reject("Fetch did not succeed");
    }
  } )
  .then( (json) => {
    console.log(json.someKey);
  } )
  .catch( (err) => {
    console.log(err);
  } );

Get a resource and the response information

import { fetch } from 'wix-fetch';

// GET call using fetch
export async function getRandomGreeting() {
  const response = await fetch('https://velo-examples.wixsite.com/training-tester/_functions/randomgreeting');
  if(response.ok) {
    const json = await response.json();
    return json.greeting;
  } else {
    return Promise.reject("Fetch did not succeed");
  }
}


In this example, we demonstrate how you can you can get a resource using fetch(). You can test out the code in our [example template](https://manage.wix.com/edit-template/from?originTemplateId=56e171e0-450f-4875-b27d-99f086001f6f&templateId=c1bb84c1-a373-4e1b-a8bb-41a9755c07cb&autoDevMode=true).

import { fetch } from 'wix-fetch';

// POST call using fetch
export async function postGreeting(language, greeting) {
  const jsonBody = {
    language,
    greeting
  };
  
  const fetchOptions = {
    method: 'post',
    headers: 'application/json',
    body: JSON.stringify(jsonBody)
  };

  const response = await fetch('https://velo-examples.wixsite.com/training-tester/_functions/greeting', fetchOptions); 
  return response.json();
}


In this example, we demonstrate how you can you can post data to a resource using fetch(). You can test out the code in our [example template](https://manage.wix.com/edit-template/from?originTemplateId=56e171e0-450f-4875-b27d-99f086001f6f&templateId=c1bb84c1-a373-4e1b-a8bb-41a9755c07cb&autoDevMode=true).

fetch

WixFetchResponse

Fulfilled - The HTTP response of the fetch operation.
Rejected - The error that caused the rejection.

The url of the JSON resource to retrieve.

Retrieves the specified JSON resource from the network using HTTPS.

The `getJSON()` function retrieves a JSON resource from the network. It returns
 a Promise that resolves to a JSON object representing the response to the request.

 To use `getJSON`, import it from `wix-fetch`:

 ```javascript
 import {getJSON} from 'wix-fetch';
 ```

 Retrieving the JSON object is performed using the GET method, regardless of
 what is specified in the `options` parameter.

 The `Accept` header is assumed to be `application/json` by default, but you
 can override it by explicitly setting a different value for `Accept`.

 The optional `WixFetchRequest` object contains information about an HTTPS request.
 Additional functionality is available in each of the respective [Fetch API implementations](wix-fetch/introduction).

 > **Notes:**
 > Some common errors when using the `getJSON()` function are described here along with possible solutions.
 >
 > - You can usually tell if you are experiencing these issues by checking your browser's console using the [browser's developer tools](https://developer.mozilla.org/en-US/docs/Learn/Common_questions/What_are_browser_developer_tools).
 > - Certain [CORS](https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS) (Cross-Origin Resource Sharing) requests are restricted when originating from a browser. Usually, GET requests and certain POST requests can be made from your site's **Public**, **Page**, or **Site** code. All other requests need to be made from your site's **Backend** code. If you are experiencing an issue with a `getJSON()` call due to a CORS restriction, move the `getJSON()` call to the backend as described in [Accessing 3rd-Party Services](https://support.wix.com/en/article/accessing-3rd-party-services#backend-service-call).
 > - You cannot request HTTP content, only HTTPS.

import {getJSON} from 'wix-fetch';

// ...

getJSON("https://someapi.com/api/someendpoint")
  .then(json => console.log(json.someKey))
  .catch(err => console.log(err));

Get a JSON resource

import { getJSON } from 'wix-fetch';

// GET call using getJSON
export async function getGreetings() {
  const response = await getJSON('https://velo-examples.wixsite.com/training-tester/_functions/greetings');
  return response;
}


In this example, we demonstrate how you can you can get data from a resource using getJSON(). You can test out the code in our [example template](https://manage.wix.com/edit-template/from?originTemplateId=56e171e0-450f-4875-b27d-99f086001f6f&templateId=c1bb84c1-a373-4e1b-a8bb-41a9755c07cb&autoDevMode=true).

getJSON

object

Fulfilled - The JSON response of the fetch operation.
Rejected - The error that caused the rejection.

# Introduction
The Fetch API enables you to send an HTTPS request to a server from your frontend or backend code.
 You can use the Fetch API to communicate with an external API to access or manage data.
 
 With the Fetch API, you can:
 + Integrate additional functionality using a 3rd-party API.
 + Retrieve data from an external service.
 + Submit data to an external database.

 The Fetch API is a Velo implementation of the standard [JavaScript Fetch API](https://developer.mozilla.org/en/docs/Web/API/Fetch_API)
 and works in a similar fashion.

 For examples of how to use the Fetch API, see [Getting Started](/getting-started/integration-with-third-party-services)
 and [Accessing 3rd-Party Services with the Fetch API](https://support.wix.com/en/article/velo-accessing-3rd-party-services-with-the-fetch-api).
 For a video tutorial, see [Wix Learn](https://www.wix.com/learn/online-course/coding-with-velo/velo-backend#get-to-know-fetch).
 
 Get hands-on experience with the Fetch API on our [Hello Fetch](https://www.wix.com/velo/example/hello-fetch) example page.

 To use the Fetch API, import `wixFetch` from the `wix-fetch` module:

   ```javascript
   import wixFetch from 'wix-fetch';
   ``` 

 ## Before you begin
 Although you can use the Fetch API in frontend or backend code, it's usually best to send requests to external APIs from your backend code.
 This is more secure, especially if the API requires a key or other authentication, and it avoids [CORS](https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS) issues that can occur when
 sending some requests from the frontend.

 The Fetch API contains two functions for sending HTTP requests: `getJSON()` and `fetch()`. For simple `GET` requests for retrieving a JSON object we recommend using `getJSON()`.
 For more complex requests, `fetch()` provides greater functionality. 

 The implementation of the `fetch()` function differs slightly depending on whether you are using it in backend or frontend code.
 The features documented here reflect the base functionality for both implementations.
 However, each implementation contains additional features:

 + In frontend code, the browser's native
   [Fetch API](https://developer.mozilla.org/en/docs/Web/API/Fetch_API) is used.
 + In backend code, the [node-fetch](https://github.com/bitinn/node-fetch) module is used.
 
 ## Terminology
 + **HTTP:** HTTP is a standard protocol for [transmitting information](https://developer.mozilla.org/en-US/docs/Web/HTTP/Messages) between a client and server. The client (your site or a site visitor's browser) sends a [request](https://developer.mozilla.org/en-US/docs/Web/HTTP/Messages#http_requests) to a server (an external API) and waits for a [response](https://developer.mozilla.org/en-US/docs/Web/HTTP/Messages#http_responses).
 + **Method:** Each HTTP request specifies a [method](https://developer.mozilla.org/en-US/docs/Web/HTTP/Methods) indicating the type of action being requested. For example, a `GET` request is used for retrieving data, and a `POST` request is used for submitting data.

velo_wix-fetch

Reads the response body as JSON.

The `json()` function reads the body response stream to its completion and
parses it as JSON. It returns a Promise that resolves to the response body as
a JSON object.

json

Fulfilled - The parsed response body as JSON.
Rejected - The errors that caused the rejection.

Reads the response body as a string.

The `text()` function reads the body response stream to its completion and
 formats the data as a string. It returns a Promise that resolves to the
 response body as a string.

text

Fulfilled - The response body as a string.
Rejected - The errors that caused the rejection.

# Introduction
The `WixFetchResponse` object contains information about an HTTP response.
More functionality is available in each of the respective [Fetch API implementations](wix-fetch/introduction).

Indicates whether the body of the response has been used yet.

The response's body is considered used once it has been read. For example,
 after calling the response's [`json()`](#json) function, the value of
 `bodyUsed` will be `true`.

bodyUsed

boolean

headers

Indicates if the request was successful, meaning its `status` is in the range 2xx.

The response [status code](https://en.wikipedia.org/wiki/List_of_HTTP_status_codes).

status

number

The response [status message](https://en.wikipedia.org/wiki/List_of_HTTP_status_codes).

statusText

body

The [request cache mode](https://developer.mozilla.org/en-US/docs/Web/API/Request/cache).

One of:

+ `"default"`
+ `"force-cache"`
+ `"no-cache"`
+ `"no-store"`
+ `"only-if-cached"`
+ `"reload"`

cache

The [request credentials](https://developer.mozilla.org/en-US/docs/Web/API/Request/credentials).

One of:

+ `"omit"`
+ `"include"`
+ `"same-origin"`

credentials

The [HTTP method](https://developer.mozilla.org/en-US/docs/Web/HTTP/Methods) to use. Defaults to `"GET"`.

method

The [request mode](https://developer.mozilla.org/en-US/docs/Web/API/Request/mode).

One of:

+ `"cors"`
+ `"no-cors"`
+ `"same-origin"`

getJSON( )