astro-loader-ins-medias

[![version][version-badge]][version-link]
[![jsDocs.io][jsdocs-src]][jsdocs-href]
[![npm downloads][npm-downloads-src]][npm-downloads-href]

This package provides Instagram media loaders for Astro projects using the Instagram API with Instagram Login. It includes:

- insMediasLoader: Loads Instagram media at build time.
- liveInsMediasLoader: Fetches Instagram media at runtime on each request.

Prerequisites

To use this loader, you need to get an access token from Meta. This requires a few steps:

1. Instagram Professional Account: Your Instagram account must be a Business or Creator account. You can switch your account type in the Instagram app settings.
2. Meta Developer Account: Register as a developer at Meta for Developers.
3. Create a Meta App for Instagram: In the App Dashboard, create a Meta app to get the token later. You can skip “Connect a business”.
4. Generate Access Token: Go to Instagram > API Setup with Instagram Business Login, click Generate Token next to the target Instagram account, log into Instagram Professional Account, and copy the generated access token (valid for 60 days).

Installation

``sh npm install astro-loader-ins-medias`

`Usage`

To use the Astro loader, ensure Astro version ^4.14.0 || ^5.0.0. For ^4.14.0, enable the experimental content layer in astro.config.ts:

`ts export default defineConfig({ experimental: { contentLayer: true, }, })`

`$3`

In src/content/config.ts (for ^4.14.0) or src/content.config.ts (for ^5.0.0), import and configure the build-time loader to define a new content collection:

`ts import { defineCollection } from "astro:content" import { insMediasLoader } from "astro-loader-ins-medias"

const insMedias = defineCollection({ loader: insMediasLoader({ fields: 'id,permalink,caption,media_url', mediaTypes: ['IMAGE', 'VIDEO', 'CAROUSEL_ALBUM'], since: new Date('2024-01-01'), until: '2024-12-31', limit: 10, apiVersion: 'v23.0', }), })

export const collections = { insMedias }`

Query the content collection like any other Astro content collection to render the loaded Instagram medias:

`astro --- import { getCollection } from "astro:content";

const medias = await getCollection("insMedias"); ---

{medias.map((media) => { const { permalink, media_url, caption } = media.data; return (

{caption}


    
  );
})}


To update the data, trigger a site rebuild (e.g., using a third-party cron job service), as the loader fetches data only at build time.
$3

Astro 5.10+ introduces experimental live content collections, which allow data fetching at runtime. To use this feature, enable the experimental liveContentCollections flag as shown below, and use an adapter that supports on-demand rendering.

`js title="astro.config.mjs" // astro.config.mjs export default { experimental: { liveContentCollections: true, }, };`

In src/live.config.ts, import and configure the live loader to define a new live content collection:

`ts title="src/live.config.ts" // src/live.config.ts import { defineLiveCollection } from 'astro:content'; import { liveInsMediasLoader } from 'astro-loader-ins-medias';

const liveInsMedias = defineLiveCollection({ loader: liveInsMediasLoader(), });

export const collections = { liveInsMedias };`

Query at runtime using getLiveCollection() or getLiveEntry():

`astro --- export const prerender = false; import { getLiveCollection, getLiveEntry } from 'astro:content';

// Get medias const { entries: medias, error } = await getLiveCollection('liveInsMedias',{ fields: 'id,permalink,caption,media_url', mediaTypes: ['IMAGE', 'VIDEO', 'CAROUSEL_ALBUM'], since: new Date('2024-01-01'), until: '2024-12-31', limit: 10, apiVersion: 'v23.0', });

// Get individual media /* const { entry: media } = await getLiveEntry('liveInsMedias', { mediaId: '17862623307162462', }); */ ---

{ error ? (

{error.message}


  ) : (
    
      {medias?.map((media) => {
        const { permalink, media_url, caption } = media.data;
        return (
          
            
            {caption}

          
        );
      })}
    

  )
}


Configuration
$3

| Option (* required) | Type (default) | Description | | ------------------- | ------------------------------------------------------------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | |fields | string(default) | A string that specifies which Instagram media fields to fetch, and optionally additional fields from supported edges. Note: - Default fields have exact types defined in the schema, any extra fields you add will be typed asunknown. - You can provide your own schema, or import and extendInsMediaSchema, to validate the data and generate TypeScript types for your collection. - To fetch edge fields, include them in the formatedge{field1,field2}. Ref: Fields reference、edges Edges reference | |mediaTypes | ('IMAGE' \| 'VIDEO' \| 'CAROUSEL_ALBUM')[](default: ['IMAGE', 'VIDEO', 'CAROUSEL_ALBUM']) | Filter by media type. If not specified, all media types will be loaded. | |since | Date \| string \| number | Only load medias after this date. It must be a valid Date or a value convertible by new Date(). | |until | Date \| string \| number | Only load medias before this date. It must be a valid Date or a value convertible by new Date(). | |limit | number| Maximum number of media items to load. | |apiVersion | string ("v23.0") | The API version to use for the Instagram API. | |instagramToken | string | You need to get an access token that ensures the loader can access the Instagram API with Instagram Login. Defaults to the INSTAGRAM_TOKEN environment variable. If configured here, keep confidential and avoid public exposure. See how to create one and configure env vars in an Astro project. Note: Access tokens from the App Dashboard are are valid for 60 days. |

`$3`

| Option (* required) | Type (default) | Description | | ------------------- | ---------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | |fields | string(default) | A string that specifies which Instagram media fields to fetch, and optionally additional fields from supported edges. Note: - Default fields have exact types defined in the schema, any extra fields you add will be typed asunknown. - You can provide your own schema, or import and extendInsMediaSchema, to validate the data and generate TypeScript types for your collection. - To fetch edge fields, include them in the formatedge{field1,field2}. Ref: Fields reference、edges Edges reference | |apiVersion | string ("v23.0") | The API version to use for the Instagram API. | |instagramToken | string | You need to get an access token that ensures the loader can access the Instagram API with Instagram Login. Defaults to the INSTAGRAM_TOKEN environment variable. If configured here, keep confidential and avoid public exposure. See how to create one and configure env vars in an Astro project. Note: Access tokens from the App Dashboard are are valid for 60 days. |

`$3`

| Option (* required) | Type (default) | Description | | ------------------- | ---------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | |fields | string(default) | A string that specifies which Instagram media fields to fetch, and optionally additional fields from supported edges. Note: - Default fields have exact types defined in the schema, any extra fields you add will be typed asunknown. - You can provide your own schema, or import and extendInsMediaSchema, to validate the data and generate TypeScript types for your collection. - To fetch edge fields, include them in the formatedge{field1,field2}. Ref: Fields reference、edges Edges reference | |mediaTypes | ('IMAGE' \| 'VIDEO' \| 'CAROUSEL_ALBUM')[](default: ['IMAGE', 'VIDEO', 'CAROUSEL_ALBUM']) | Filter by media type. If not specified, all media types will be loaded. | |since | Date \| string \| number | Only load medias after this date. It must be a valid Date or a value convertible by new Date(). | |until | Date \| string \| number | Only load medias before this date. It must be a valid Date or a value convertible by new Date(). | |limit | number| Maximum number of media items to load. |

`$3`

`Schema`

The collection entries use the following Zod schema:

`ts const InsMediaSchema = z .object({ id: z.string(), caption: z.string(), comments_count: z.number().int(), like_count: z.number().int(), media_product_type: z.enum(['AD', 'FEED', 'STORY', 'REELS']), media_type: z.enum(['IMAGE', 'VIDEO', 'CAROUSEL_ALBUM']), media_url: z.string().url(), permalink: z.string().url(), timestamp: z.coerce.date(), children: z.object({ data: z.array( z .object({ id: z.string(), media_type: z.enum(['IMAGE', 'VIDEO', 'CAROUSEL_ALBUM']), media_url: z.string().url(), }) .partial() .required({ id: true }) .passthrough() ), }), comments: z.object({ data: z.array( z .object({ id: z.string(), username: z.string(), text: z.string(), timestamp: z.coerce.date(), }) .partial() .required({ id: true }) .passthrough() ), }), }) .partial() .required({ id: true }) .passthrough()`

Astro uses these schemas to generate TypeScript interfaces for autocompletion and type safety. When customizing the collection schema, keep it compatible with the loader’s built-in Zod schema to avoid errors.

`Live Collections Error Handling`

Live loaders may fail due to network, API, or validation errors. Handle these errors in your components. The live loader also returns specific error codes:

- INVALID_FILTER: Missing required filter options. -COLLECTION_LOAD_ERROR: Failed to load collection. -ENTRY_LOAD_ERROR: Failed to load individual entry. -INS_API_QUERY_ERROR`: Failed to query Instagram API.

Changelog

See CHANGELOG.md for the change history of this loader.

Contribution

If you see any errors or room for improvement, feel free to open an issues or pull request . Thank you in advance for contributing! ❤️

[version-badge]: https://img.shields.io/npm/v/astro-loader-ins-medias?label=release&style=flat&colorA=080f12&colorB=f87171
[version-link]: https://www.npmjs.com/package/astro-loader-ins-medias
[jsdocs-src]: https://img.shields.io/badge/jsdocs-reference-080f12?style=flat&colorA=080f12&colorB=f87171
[jsdocs-href]: https://www.jsdocs.io/package/astro-loader-ins-medias
[npm-downloads-src]: https://img.shields.io/npm/dm/astro-loader-ins-medias?style=flat&colorA=080f12&colorB=f87171
[npm-downloads-href]: https://npmjs.com/package/astro-loader-ins-medias

astro-loader-ins-medias

[![version][version-badge]][version-link]
[![jsDocs.io][jsdocs-src]][jsdocs-href]
[![npm downloads][npm-downloads-src]][npm-downloads-href]

This package provides Instagram media loaders for Astro projects using the Instagram API with Instagram Login. It includes:

- insMediasLoader: Loads Instagram media at build time.
- liveInsMediasLoader: Fetches Instagram media at runtime on each request.

Prerequisites

To use this loader, you need to get an access token from Meta. This requires a few steps:

Installation

``sh npm install astro-loader-ins-medias`

`Usage`

To use the Astro loader, ensure Astro version ^4.14.0 || ^5.0.0. For ^4.14.0, enable the experimental content layer in astro.config.ts:

`ts export default defineConfig({ experimental: { contentLayer: true, }, })`

`$3`

In src/content/config.ts (for ^4.14.0) or src/content.config.ts (for ^5.0.0), import and configure the build-time loader to define a new content collection:

`ts import { defineCollection } from "astro:content" import { insMediasLoader } from "astro-loader-ins-medias"

export const collections = { insMedias }`

Query the content collection like any other Astro content collection to render the loaded Instagram medias:

`astro --- import { getCollection } from "astro:content";

const medias = await getCollection("insMedias"); ---

{medias.map((media) => { const { permalink, media_url, caption } = media.data; return (

{caption}


    
  );
})}


To update the data, trigger a site rebuild (e.g., using a third-party cron job service), as the loader fetches data only at build time.
$3

`js title="astro.config.mjs" // astro.config.mjs export default { experimental: { liveContentCollections: true, }, };`

In src/live.config.ts, import and configure the live loader to define a new live content collection:

`ts title="src/live.config.ts" // src/live.config.ts import { defineLiveCollection } from 'astro:content'; import { liveInsMediasLoader } from 'astro-loader-ins-medias';

const liveInsMedias = defineLiveCollection({ loader: liveInsMediasLoader(), });

export const collections = { liveInsMedias };`

Query at runtime using getLiveCollection() or getLiveEntry():

`astro --- export const prerender = false; import { getLiveCollection, getLiveEntry } from 'astro:content';

// Get individual media /* const { entry: media } = await getLiveEntry('liveInsMedias', { mediaId: '17862623307162462', }); */ ---

{ error ? (

{error.message}


  ) : (
    
      {medias?.map((media) => {
        const { permalink, media_url, caption } = media.data;
        return (
          
            
            {caption}

          
        );
      })}
    

  )
}


Configuration
$3

`$3`

| Option (* required) | Type (default) | Description | | ------------------- | ---------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | |fields | string(default) | A string that specifies which Instagram media fields to fetch, and optionally additional fields from supported edges. Note: - Default fields have exact types defined in the schema, any extra fields you add will be typed asunknown. - You can provide your own schema, or import and extendInsMediaSchema, to validate the data and generate TypeScript types for your collection. - To fetch edge fields, include them in the formatedge{field1,field2}. Ref: Fields reference、edges Edges reference | |apiVersion | string ("v23.0") | The API version to use for the Instagram API. | |instagramToken | string | You need to get an access token that ensures the loader can access the Instagram API with Instagram Login. Defaults to the INSTAGRAM_TOKEN environment variable. If configured here, keep confidential and avoid public exposure. See how to create one and configure env vars in an Astro project. Note: Access tokens from the App Dashboard are are valid for 60 days. |

`$3`

| Option (* required) | Type (default) | Description | | ------------------- | ---------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | |fields | string(default) | A string that specifies which Instagram media fields to fetch, and optionally additional fields from supported edges. Note: - Default fields have exact types defined in the schema, any extra fields you add will be typed asunknown. - You can provide your own schema, or import and extendInsMediaSchema, to validate the data and generate TypeScript types for your collection. - To fetch edge fields, include them in the formatedge{field1,field2}. Ref: Fields reference、edges Edges reference | |mediaTypes | ('IMAGE' \| 'VIDEO' \| 'CAROUSEL_ALBUM')[](default: ['IMAGE', 'VIDEO', 'CAROUSEL_ALBUM']) | Filter by media type. If not specified, all media types will be loaded. | |since | Date \| string \| number | Only load medias after this date. It must be a valid Date or a value convertible by new Date(). | |until | Date \| string \| number | Only load medias before this date. It must be a valid Date or a value convertible by new Date(). | |limit | number| Maximum number of media items to load. |

`$3`

`Schema`

The collection entries use the following Zod schema:

`Live Collections Error Handling`

Live loaders may fail due to network, API, or validation errors. Handle these errors in your components. The live loader also returns specific error codes:

Changelog

See CHANGELOG.md for the change history of this loader.

Contribution

If you see any errors or room for improvement, feel free to open an issues or pull request . Thank you in advance for contributing! ❤️