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

Get All Boards & Kits

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""title""boardKitType"
Example: order=wwwUpdateDate,title
orderDirectionstring

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

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

Filter by board/kit identifier.

boardKitTypestring

Filter by board/kit type.

Enum"development""evaluation""demonstration""reference""starter"
categorystring

Filter by product category.

curl -i -X GET \
  'https://developer.renesas.com/docs/web-data-api/_mock/apis/web-data/boards-kits?limit=10&offset=0&order=wwwUpdateDate%2Ctitle&orderDirection=desc%2Casc&boardKitId=string&boardKitType=development&category=string' \
  -H 'x-api-key: YOUR_API_KEY_HERE'

Responses

Successful response

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

Get Board or Kit by ID

Request

Security
ApiKeyAuth
Path
board_kit_idstringrequired

The unique identifier of the board or kit.

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

Responses

Successful response

Bodyapplication/json
boardKitIdstring

Unique identifier for the board or kit.

Example: "rx71m-starter-kit-plus"
wwwUpdateDatestring

Date the Board page was last updated on the website.

uuidstring

UUID of the board or kit.

Example: "5cdd14dc-21a8-4e9e-9d4d-4a83042b4e47"
titlestring

Title of the board or kit.

Example: "Renesas Starter Kit+ for RX71M"
urlstring(uri)

Public URL of the board or kit page on the Renesas website.

Example: "https://www.renesas.com/design-resources/boards-kits/rx71m-starter-kit-plus"
boardKitTypestring

Type classification of the board or kit.

Enum"development""evaluation""demonstration""reference""starter"
Example: "evaluation"
categoryArray of objects

Category.

Example: [[{"level":1,"title":"Microcontrollers & Microprocessors"},{"level":2,"title":"RX 32-Bit Performance/Efficiency MCUs"}]]
descriptionstring

Detailed description of the board or kit.

Example: "The Renesas Starter Kit+ for RX71M is the perfect starter kit for developers who are new to the RX71M. The kit includes an LCD display module, on-chip debugging emulator, and integrated development environment so you can start evaluating the RX71M immediately after opening the box. Please use this product to experience the performance and functions of the RX71M."
featuresstring

Key features and capabilities of the board or kit.

Example: "On-board debugger, Arduino compatible headers, multiple interface options"
applicationsstring

Target applications and use cases.

Example: "Industrial automation, motor control, IoT applications"
additionalDetailsstring or null

Additional technical details and specifications.

imagesArray of strings(uri)

Array of image URLs for the board or kit.

Example: ["https://www.renesas.com/sites/default/files/rx71m-evb-top.jpg","https://www.renesas.com/sites/default/files/rx71m-evb-bottom.jpg"]
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"}]
relatedBoardsKitsArray of objects

List of related product identifiers.

Example: [{"boardKitId":"RX71M-Starter-Kit-Plus","title":"Renesas Starter Kit+ for RX71M","href":"/boards-kits/RX71M-Starter-Kit-Plus"},{"boardKitId":"YRPBRX71M","title":"RX71M Revelation Kit - Easy Evaluation and Development with RX71M","href":"/boards-kits/YRPBRX71M"}]
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

List of related document identifiers.

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

Compatible software tools and development environments.

Example: [{"softwareToolName":"e2 studio","href":"/software-tools/e2%20studio"},{"softwareToolName":"Renesas Flash Programmer (Programming GUI)","href":"/software-tools/Renesas%20Flash%20Programmer%20(Programming%20GUI)"}]
partnerArray of objects or null

Partner information if applicable.

Example: [{"name":"TESSERA Technology Inc.","url":"https://www.tessera.co.jp/eng/"}]
Response
application/json
{
  "boardKitId": "rx71m-starter-kit-plus",
  "wwwUpdateDate": "2024-01-15T10:30:00Z",
  "url": "https://www.renesas.com/design-resources/boards-kits/rx71m-starter-kit-plus",
  "uuid": "5cdd14dc-21a8-4e9e-9d4d-4a83042b4e47",
  "title": "Renesas Starter Kit+ for RX71M",
  "boardKitType": "evaluation",
  "category": [
    { … },
    { … }
  ],
  "description": "32-bit microcontroller capable of up to 240 MHz operation. Employs the RXv2 core, a more powerful evolved form of the RX core that was used in previous RX devices, while maintaining compatibility. Realizes 1160 CoreMark, the top performance among microcontrollers with built-in flash.",
  "features": "On-board debugger, Arduino compatible headers, multiple interface options",
  "applications": "Industrial automation, motor control, IoT applications",
  "additionalDetails": "The RX71M evaluation board provides a complete development environment for evaluating and developing applications using the RX71M microcontroller.",
  "images": [
    "https://www.renesas.com/sites/default/files/rx71m-evb-top.jpg",
    "https://www.renesas.com/sites/default/files/rx71m-evb-bottom.jpg"
  ],
  "orderableProducts": [
    { … },
    { … }
  ],
  "relatedBoardsKits": [
    { … },
    { … }
  ],
  "featuredDocuments": [
    { … }
  ],
  "relatedDocuments": [
    { … }
  ],
  "softwareTools": [
    { … },
    { … }
  ],
  "partner": [
    { … }
  ]
}

Software Tool

Endpoints for retrieving software tools.

Operations

Package

Endpoints for retrieving packages.

Operations