Skip to content

Renesas Web Data API (1.0.0)

The Renesas Web Data API enables external systems to retrieve product metadata in real time, without relying on manual CSV downloads or periodic feed refreshes. This shift improves data consistency, streamlines integrations, and aligns with modern API-first architectures.

Download OpenAPI description
index.json
index.yaml
Languages
Servers
Mock server
https://developer.renesas.com/docs/web-data-api/_mock/apis/web-data
Production Server
https://api.renesas.com/web-data/v1
Staging Server
https://api.renesas-dev.com/web-data/v1

Product

Endpoints for retrieving products.

Operations

Product Part

Endpoints for retrieving product parts.

Operations

Document

Endpoint for retrieving documents.

Operations

Board & Kit

Endpoints for retrieving boards and kits.

Operations

Software Tool

Endpoints for retrieving software tools.

Operations

Get All Software Tools

Request

Security
ApiKeyAuth
Query
limitinteger[ 1 .. 100 ]

The number of results to return (default 10).

Default 10
offsetinteger>= 0

The page number for pagination (default 0). This is multiplied by limit to get the actual offset.

Default 0
orderstring

Sorting property (default sort is by www update date). Multiple sorts can be supplied by comma concatenation.

Default "wwwUpdateDate"
Enum"wwwUpdateDate""softwareToolName""softwareType"
Example: order=wwwUpdateDate,softwareToolName
orderDirectionstring

Sorting direction (default is "desc"). Multiple directions can be defined for multiple sorts.

Default "desc"
Example: orderDirection=desc,asc
softwareToolNamestring

Filter by software tool name using the "contains" behavior.

softwareTypestring

Filter by software tool type. This is a string exact match.

Default "all"
includeDiscontinuedboolean

Include discontinued software. Default listing only shows active software.

Default false
curl -i -X GET \
  'https://developer.renesas.com/docs/web-data-api/_mock/apis/web-data/software-tools?limit=10&offset=0&order=wwwUpdateDate%2CsoftwareToolName&orderDirection=desc%2Casc&softwareToolName=string&softwareType=all&includeDiscontinued=false' \
  -H 'x-api-key: YOUR_API_KEY_HERE'

Responses

Successful response

Bodyapplication/json
dataArray of objects(software_tool)
paginationobject
Response
application/json
{
  "data": [
    { … },
    { … }
  ],
  "pagination": {
    "offset": 0,
    "limit": 10,
    "total": 87,
    "has_more": true
  }
}

Get Software Tool by ID

Request

Security
ApiKeyAuth
Path
tool_idstringrequired

The unique identifier of the software tool.

curl -i -X GET \
  'https://developer.renesas.com/docs/web-data-api/_mock/apis/web-data/software-tools/{software_tool_id}' \
  -H 'x-api-key: YOUR_API_KEY_HERE'

Responses

Successful response

Bodyapplication/json
softwareToolNamestring

Unique identifier for the software tool (uses full title).

Example: "RZ/G Verified Linux Package [4.4-CIP]"
wwwUpdateDatestring

Date the software tool page was last updated on the website.

urlstring(uri)

Public URL of the software tool page on the Renesas website.

Example: "https://www.renesas.com/software-tool/rzg-verified-linux-package-44-cip"
uuidstring

UUID of the software tool.

Example: "8cdd14dc-21a8-4e9e-9d4d-4a83042b4e48"
shortDescriptionstring

Brief description of the software tool.

Example: "This Linux package contains ported and tested basic software necessary for the industrial segment, and its operation and performance have been verified based on a datasheet. It enables you to start using a stable Linux environment and basic software immediately, so you can concentrate on developing your application."
descriptionstring

Detailed description of the software tool.

Example: "This product provides a whole set of software, which consists of Linux packages and software add-ons. Functions of this product have been verified under our development process management. Regular maintenance is also provided. You can greatly reduce the burden of software development in embedded system development by using this package. Please read the release note included in this product and 'RZ/G Verified Linux Package Start-up Guide' first when you use the package. VLP[4.4-CIP] maintenance will be finished 2027/1H when the maintenance of the corresponding CIP Linux Kernel version is completed."
softwareTypestring

Type classification of the software tool.

Example: "Software Package"
parentSoftwareCategoryArray of strings

Parent software category name.

Example: [{"title":"Tools to Optimize AI Software for AD/ADAS on R-Car SoC"}]
featuresstring

Key features and capabilities of the software tool.

Example: "Linux kernel (4.4-CIP or 4.4-CIP-RT), 10+ years support with CIP project cooperation, Device Driver, Media Player IF with GStreamer, Video Codec H.264 decoder/encoder (OMX), Video processing with scaling/clipping/compositing, Graphics function with OpenGL ES (SGX)"
additionalDetailsstring or null

Additional technical details and specifications.

documentationDetailsstring or null

Details about documentation and help resources.

downloadDetailsstring or null

Information about downloads and installation.

releaseInformationstring or null

Release notes and version information.

Example: "Next release: 4.4-CIP version VLP 2.1.25 (end of Dec 2026). Latest: 4.4-CIP version VLP 2.1.24 (Dec 26, 2025). Recent updates include VLP 2.1.23-update2 with both 4.4-CIP and 4.4-CIP-RT support."
targetDeviceDescriptionstring or null

Description of target devices and compatibility.

Example: "Target Reference Boards: iWave RZ/G1H-PF Development Kit, iWave RZ/G1M-PF Development Kit, iWave RZ/G1N-PF Development Kit, iWave RZ/G1E-PF Development Kit, iWave RZ/G1C-PF Development Kit. All targets support Standard Version."
discontinuedboolean

Whether the software tool has been discontinued.

Example: false
externalUrlstring or null(uri)

External download or information URL.

imagesArray of strings(uri)

Array of image URLs for the software tool.

Example: ["https://www.renesas.com/sites/default/files/e2studio-screenshot.png"]
evaluationBoardsArray of objects

List of compatible boards and kits.

Example: [{"boardKitId":"rx71m-starter-kit-plus","title":"Renesas Starter Kit+ for RX71M","href":"/boards-kits/rx71m-starter-kit-plus"}]
orderableProductsArray of objects

List of orderable product parts associated with this board/kit.

Example: [{"orderableId":"R5F571MFCDFB#V0","href":"/product-parts/R5F571MGCDFB%2310"},{"orderableId":"R5F571MFCDFC#V0","href":"/product-parts/R5F571MGCDFB%2330"}]
featuredDocumentsArray of objects

Featured documents associated with the board/kit.

Example: [{"agileId":"X0052700","dcpDocumentId":"R01DS0249EJ0120","title":"RX71M Datasheet Group Rev.1.20","type":"Datasheet","language":"en","href":"/documents/R01DS0249EJ0120"}]
relatedDocumentsArray of objects

Technical documentation associated with the software tool.

Example: [[{"agileId":"X0052700","dcpDocumentId":"R01DS0249EJ0120","title":"RX71M Datasheet Group Rev.1.20","type":"Datasheet","language":"en","href":"/documents/R01DS0249EJ0120"}]]
relatedDocumentsSecondaryArray of objects

Secondary related documents.

Example: [{"agileId":"X0052700","dcpDocumentId":"R01DS0249EJ0120","title":"RX71M Datasheet Group Rev.1.20","type":"Datasheet","language":"en","href":"/documents/R01DS0249EJ0120"}]
relatedSoftwareToolsArray of objects

Related software tools (primary).

Example: [{"softwareToolName":"RZ/G Linux BSP","href":"/software-tools/RZ/G Linux BSP"}]
relatedSoftwareToolsSecondaryArray of objects

Related software tools (secondary).

alternativeobject or null

Alternative software tool.

partnerArray of objects or null

Partner information if applicable.

Example: [{"name":"TESSERA Technology Inc.","url":"https://www.tessera.co.jp/eng/"}]
relatedVideosArray of objects

Related video content.

Response
application/json
{
  "softwareToolName": "e² studio",
  "wwwUpdateDate": "2024-01-15T10:30:00Z",
  "url": "https://www.renesas.com/software-tool/e2-studio",
  "uuid": "8cdd14dc-21a8-4e9e-9d4d-4a83042b4e48",
  "shortDescription": "Eclipse-based integrated development environment (IDE) for Renesas MCU and MPU families",
  "description": "e² studio is an Eclipse-based integrated development environment (IDE) that provides a complete development solution for Renesas MCU and MPU families. It offers comprehensive support for code development, debugging, and project management across all Renesas MCU and MPU product lines.",
  "softwareType": "IDE and Coding Tool",
  "parentSoftwareCategory": [
    "Tools to Optimize AI Software for AD/ADAS on R-Car SoC"
  ],
  "features": "Eclipse-based IDE, integrated debugger, code generation, project templates, multi-core debugging, real-time trace",
  "additionalDetails": "The IDE includes advanced features such as intelligent code completion, refactoring tools, and integrated version control.",
  "documentationDetails": "Comprehensive documentation including user manuals, quick start guides, and video tutorials.",
  "downloadDetails": "Available for Windows, Linux, and macOS. Includes installer packages and update sites.",
  "releaseInformation": "Latest version 2024.01 released on January 15, 2024 with enhanced debugging capabilities and improved support for RZ series MPUs.",
  "targetDeviceDescription": "Supports all Renesas MCU and MPU families including RA, RX, RH850, RZ/A, RZ/G, and RZ/V series with comprehensive development toolchain integration.",
  "discontinued": false,
  "externalUrl": null,
  "images": [
    "https://www.renesas.com/sites/default/files/e2studio-screenshot.png",
    "https://www.renesas.com/sites/default/files/e2studio-debug-view.png"
  ],
  "evaluationBoards": [
    { … },
    { … }
  ],
  "orderableProducts": [
    { … }
  ],
  "featuredDocuments": [
    { … },
    { … }
  ],
  "relatedDocuments": [
    { … }
  ],
  "relatedDocumentsSecondary": [
    { … }
  ],
  "relatedSoftwareTools": [
    { … },
    { … }
  ],
  "relatedSoftwareToolsSecondary": [
    { … }
  ],
  "partner": [
    { … }
  ],
  "relatedVideos": [
    { … }
  ]
}

Package

Endpoints for retrieving packages.

Operations