Creates a module component. For integration-created modules, set source to userCreated.

When source is userCreated, Scanifly automatically creates a company component-library entry for the new module and stores any optional metadata on that entry.

Module Library API

Use the Module Library API to create and manage user-created module components and add those modules to a company's component library.

Base URL

https://api.portal.scanifly.com

All endpoints are versioned under /api/v1.

Authentication

Send your Scanifly API token on each request:

x-api-token: YOUR_API_TOKEN

Main Workflow

1. Create a user-created module component. Scanifly automatically creates the company library entry when source is userCreated.
2. Read the company module library to confirm the module is available.
3. Update entry metadata such as nickname, tags, notes, favorite status, or texture override.
4. Add an existing component to the library directly only when you already have a component ID and need to create the library entry separately.

Endpoints

Create a Module and Library Entry

POST /api/v1/component/module

The source for integration-created modules should be userCreated. When source is userCreated, Scanifly creates the module component and automatically adds it to the authenticated user's company library. Optional metadata is stored on that auto-created library entry.

{
  "model": "ABC-450",
  "manufacturer": "Example Solar",
  "source": "userCreated",
  "maxPowerOutput": 450,
  "maxPowerVoltage": 41.2,
  "maxPowerCurrent": 10.92,
  "openCircuitVoltage": 49.8,
  "shortCircuitCurrent": 11.45,
  "dimensions": {
    "length": 1900,
    "width": 1134
  },
  "cellQuantity": 144,
  "tempCoefficientMaxPower": -0.35,
  "tempCoefficientOpenCircuit": -0.28,
  "tempCoefficientShortCircuit": 0.05,
  "cellType": "monoSi",
  "defaultTexture": "module-monocrystalline",
  "metadata": {
    "nickname": "Example 450W",
    "tags": ["preferred", "residential"],
    "isFavorite": true
  }
}

Required Module Fields

Some electrical fields may not be available in every partner system. When building an integration, confirm whether the source system stores these values directly, derives them from a product catalog, or needs a fallback product-data lookup before sending the module to Scanifly.

Add an Existing Module to the Library

POST /api/v1/component/library

Use this endpoint when a module component already exists and you need to create a library entry for it separately.

{
  "componentType": "module",
  "componentId": "MODULE_COMPONENT_ID",
  "metadata": {
    "nickname": "Example 450W",
    "tags": ["preferred", "residential"],
    "isFavorite": true
  }
}

Metadata is optional and can include:

Filtering and Sorting

GET /api/v1/component/module

filterBy[source][0]=userCreated
filterBy[cellType]=monoSi
filterBy[defaultTexture]=module-monocrystalline
sortBy[model]=asc
sortBy[updatedAt]=desc

GET /api/v1/component/library/module

filterBy[componentType]=module
filterBy[componentId]=MODULE_COMPONENT_ID
filterBy[searchText]=example

Supported Enum Values

cellType

• monoSi
• multiSi
• polySi
• cis
• cigs
• cdte
• amorphous

defaultTexture

• module-monocrystalline
• module-polycrystalline
• module-lg-neon
• module-monocrystalline-black
• module-sunpower-x
• module-sunpower-x-black
• module-polycrystalline-2
• module-monocrystalline-3
• module-monocrystalline-black-4
• module-monocrystalline-black-5