Fetching APIs in frontmatter in Astro

Introduction

Fetching APIs in frontmatter lets you get data before your page shows. This means your page can use fresh info right away.

You want to show weather info on your page that updates every time.

You need to get a list of blog posts from an online source before showing them.

You want to display user profiles fetched from a server when the page loads.

You want to get product details from an API to show in a shop page.

Syntax

Astro

---
const response = await fetch('https://api.example.com/data');
const data = await response.json();
---

The frontmatter is the top part of an Astro file between triple dashes (---).

You can use await here because Astro supports async frontmatter.

Examples

Fetches a list of users from an API and stores it in users.

Astro

---
const res = await fetch('https://api.example.com/users');
const users = await res.json();
---

Fetches current weather data to use in the page.

Astro

---
const res = await fetch('https://api.example.com/weather');
const weather = await res.json();
---

Sample Program

This Astro component fetches a post from a public API before the page loads. Then it shows the post's title and body inside the page.

Astro

---
const res = await fetch('https://jsonplaceholder.typicode.com/posts/1');
const post = await res.json();
---

<html lang="en">
  <head>
    <meta charset="UTF-8" />
    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
    <title>Post Example</title>
  </head>
  <body>
    <h1>{post.title}</h1>
    <p>{post.body}</p>
  </body>
</html>

Important Notes

Always check if the API URL is correct and accessible.

Use await to wait for the data before using it in your page.

Fetching in frontmatter means data is ready when the page renders, improving user experience.

Summary

Fetching APIs in frontmatter gets data before the page shows.

Use await fetch() inside the triple dash section at the top.

This helps show fresh data right away on your page.

Practice

1. What is the main purpose of fetching APIs in the frontmatter of an Astro component?

easy

A. To get data before the page renders so it shows fresh content immediately

B. To delay data loading until after the page is fully loaded

C. To style the page using CSS variables

D. To handle user input events on the page

Solution

1. Step 1: Understand frontmatter role in Astro

   Frontmatter runs before the page renders, allowing data fetching early.

2. Step 2: Purpose of fetching API in frontmatter

   Fetching data here ensures the page shows fresh content immediately when loaded.

3. Final Answer:

   To get data before the page renders so it shows fresh content immediately -> Option A

4. Quick Check:

   Fetching in frontmatter = fresh data before render [OK]

Hint: Frontmatter fetches data before page shows [OK]

Common Mistakes:

• Thinking data loads after page renders
• Confusing frontmatter with styling or events
• Assuming frontmatter runs on client side

2. Which of the following is the correct syntax to fetch data in Astro frontmatter?

easy

A. ---
const response = await fetch('https://api.example.com/data');
const data = await response.json();
---

B.

C. const data = fetch('https://api.example.com/data');

D. ---
fetch('https://api.example.com/data')
---

Solution

1. Step 1: Identify frontmatter syntax

   Astro frontmatter uses triple dashes --- to enclose code that runs before rendering.

2. Step 2: Correct async fetch usage

   Using await fetch and await response.json() inside frontmatter is correct to get JSON data.

3. Final Answer:

   --- const response = await fetch('https://api.example.com/data'); const data = await response.json(); --- -> Option A

4. Quick Check:

   Frontmatter uses --- and await fetch [OK]

Hint: Use --- and await fetch inside frontmatter [OK]

Common Mistakes:

• Using fetch without await in frontmatter
• Placing fetch inside <script> tag instead of frontmatter
• Not parsing response with .json()

3. Given this Astro frontmatter code, what will be the value of data.message in the component?

---
const response = await fetch('https://api.example.com/greet');
const data = await response.json();
---

{data.message}

Assuming the API returns JSON: { "message": "Hello, Astro!" }

medium

A. undefined

B. "Hello, Astro!"

C. SyntaxError

D. null

Solution

1. Step 1: Understand fetch and JSON parsing

   The fetch gets the API response, and await response.json() parses it into an object with a message property.

2. Step 2: Accessing data.message in component

   The component uses {data.message} which will display the string from the API: "Hello, Astro!".

3. Final Answer:

   "Hello, Astro!" -> Option B

4. Quick Check:

   API message property = "Hello, Astro!" [OK]

Hint: Parsed JSON data shows in component as expected [OK]

Common Mistakes:

• Forgetting to await response.json()
• Trying to access data before fetch completes
• Assuming data.message is undefined or null

4. What is wrong with this Astro frontmatter code?

---
const data = fetch('https://api.example.com/data');
const json = data.json();
---

medium

A. Using triple dashes --- incorrectly

B. json() is not a function

C. fetch URL is invalid syntax

D. Missing await before fetch and json() calls

Solution

1. Step 1: Check async fetch usage

   fetch returns a Promise, so it must be awaited to get the response object.

2. Step 2: Check json() call

   response.json() also returns a Promise and must be awaited to get parsed data.

3. Final Answer:

   Missing await before fetch and json() calls -> Option D

4. Quick Check:

   Always await fetch and response.json() [OK]

Hint: Always await fetch and json() in frontmatter [OK]

Common Mistakes:

• Not using await causing unresolved Promises
• Assuming fetch is synchronous
• Calling json() on Promise instead of response

5. You want to fetch a list of users from an API in Astro frontmatter and display their names. Which approach correctly fetches and prepares the data for rendering?

---
// Option A
const res = await fetch('https://api.example.com/users');
const users = await res.json();
---


  {users.map(user => 
{user.name}
)}

hard

A. Fetch data in frontmatter but forget to parse JSON

B. Fetch without await, map users directly on Promise

C. Fetch with await, parse JSON, then map users in component

D. Use fetch inside component JSX without frontmatter

Solution

1. Step 1: Fetch and parse JSON in frontmatter

   Using await fetch and await res.json() gets the user list as an array before rendering.

2. Step 2: Map over users array in component

   Mapping users to list items displays each user name correctly in the rendered HTML.

3. Final Answer:

   Fetch with await, parse JSON, then map users in component -> Option C

4. Quick Check:

   Await fetch + parse + map users = correct [OK]

Hint: Await fetch and parse JSON before mapping data [OK]

Common Mistakes:

• Mapping over unresolved Promise instead of data array
• Fetching inside JSX causing runtime errors
• Not parsing JSON before using data