Piloterr Rsonline API

The Rsonline API from Piloterr — 2 operation(s) for rsonline.

GitHub OpenAPI

Operations 4

POST /v2/rsonline/search RS Online Search #
GET /v2/rsonline/product RS Online Product #
POST /v2/rsonline/product RS Online Product #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/piloterr-com:piloterr-com-rsonline-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

piloterr-com-rsonline-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Piloterr API Reference Rsonline API
  description: Complete API reference documentation.
  version: 1.0.0
servers:
- url: https://api.piloterr.com
  description: API Server
tags:
- name: Rsonline
paths:
  /v2/rsonline/search:
    get:
      summary: RS Online Search
      description: 'Search RS Online UK by keyword or category. Pound prices keep the amount printed on the page.


        **Credit cost:** 2 credits per call'
      operationId: get-rsonline-search
      security:
      - ApiKeyAuth: []
      parameters:
      - name: query
        in: query
        required: true
        description: 'A keyword, or a uk.rs-online.com search or category link. Empty, another host, or a product link returns 400. A keyword builds /web/c/?searchTerm=... and page 1 omits pn. Each card has price as a number and price_display as the pound string.


          Keyword


          ```

          connector

          ```


          Category link


          ```

          https://uk.rs-online.com/web/c/connectors/

          ```'
        schema:
          type: string
          description: 'A keyword, or a uk.rs-online.com search or category link. Empty, another host, or a product link returns 400. A keyword builds /web/c/?searchTerm=... and page 1 omits pn. Each card has price as a number and price_display as the pound string.


            Keyword


            ```

            connector

            ```


            Category link


            ```

            https://uk.rs-online.com/web/c/connectors/

            ```'
      - name: page
        in: query
        required: false
        description: Page number starting at 1. Omit it for page 1. Page 2 sets pn=2, changes pagination.page, and returns the next cards. pagination.next is that next URL, or null on the last page. A value below 1 returns 400.
        schema:
          type: number
          minimum: 1
          description: Page number starting at 1. Omit it for page 1. Page 2 sets pn=2, changes pagination.page, and returns the next cards. pagination.next is that next URL, or null on the last page. A value below 1 returns 400.
      - name: return_page_source
        in: query
        required: false
        description: Default false. true replaces results and pagination with result, the rendered HTML.
        schema:
          type: boolean
          description: Default false. true replaces results and pagination with result, the rendered HTML.
      - $ref: '#/components/parameters/fields'
      - $ref: '#/components/parameters/is_async'
      - $ref: '#/components/parameters/soft_fail'
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  results:
                    type: array
                    items:
                      type: object
                      properties:
                        mpn:
                          type: string
                        url:
                          type: string
                        brand:
                          type: string
                        price:
                          type: number
                        title:
                          type: string
                        category:
                          type: string
                        currency:
                          type: string
                        in_stock:
                          type: boolean
                        image_url:
                          type: string
                        pack_size:
                          type: integer
                        product_id:
                          type: string
                        stock_status:
                          type: string
                        price_display:
                          type: string
                        rs_stock_number:
                          type: string
                        minimum_order_qty:
                          type: integer
                  pagination:
                    type: object
                    properties:
                      next:
                        type: string
                      page:
                        type: integer
                      per_page:
                        type: integer
                      total_pages:
                        type: integer
                      total_results:
                        type: integer
              examples:
                WAGO 221 splice connector on RS Online UK:
                  value:
                    results:
                    - mpn: 221-2401
                      url: https://uk.rs-online.com/web/p/splice-connectors/0303327
                      brand: WAGO
                      price: 4.95
                      title: WAGO, 221 Wire Splice Splice Connector, Clear, Insulated 12 AWG
                      category: Splice Connectors
                      currency: GBP
                      in_stock: true
                      image_url: https://media.rs-online.com/t_large/Y0303327-01.jpg
                      pack_size: 10
                      product_id: '0303327'
                      stock_status: IN_STOCK
                      price_display: £4.95
                      rs_stock_number: 030-3327
                      minimum_order_qty: 1
                    pagination:
                      next: https://uk.rs-online.com/web/c/?searchTerm=connector&pn=2
                      page: 1
                      per_page: 20
                      total_pages: 3220
                      total_results: 64395
        '400':
          description: Bad Request — missing or invalid parameters.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              example:
                error: Bad Request
        '401':
          description: Unauthorized — the API key is missing, invalid, inactive, or expired, or a rate limit was exceeded (`Rate limit exceeded…` message).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                invalidKey:
                  value:
                    error: Invalid API Key
                planRateLimit:
                  value:
                    error: 'Rate limit exceeded: You''ve exceeded the per second rate limit on your subscription'
                keyQuota:
                  value:
                    error: 'Rate limit exceeded for the API key: quota monthly'
        '402':
          description: Payment Required — your subscription or credit balance is insufficient.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              example:
                error: Payment required
        '500':
          description: Internal Server Error — something went wrong on our side.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              example:
                error: Internal Error
      tags:
      - Rsonline
    post:
      summary: RS Online Search
      description: 'Search RS Online UK by keyword or category. Pound prices keep the amount printed on the page.


        **Credit cost:** 2 credits per call'
      operationId: post-rsonline-search
      security:
      - ApiKeyAuth: []
      parameters:
      - $ref: '#/components/parameters/fields'
      - $ref: '#/components/parameters/is_async'
      - $ref: '#/components/parameters/soft_fail'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                query:
                  type: string
                  description: 'A keyword, or a uk.rs-online.com search or category link. Empty, another host, or a product link returns 400. A keyword builds /web/c/?searchTerm=... and page 1 omits pn. Each card has price as a number and price_display as the pound string.


                    Keyword


                    ```

                    connector

                    ```


                    Category link


                    ```

                    https://uk.rs-online.com/web/c/connectors/

                    ```'
                page:
                  type: number
                  minimum: 1
                  description: Page number starting at 1. Omit it for page 1. Page 2 sets pn=2, changes pagination.page, and returns the next cards. pagination.next is that next URL, or null on the last page. A value below 1 returns 400.
                return_page_source:
                  type: boolean
                  description: Default false. true replaces results and pagination with result, the rendered HTML.
              required:
              - query
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  results:
                    type: array
                    items:
                      type: object
                      properties:
                        mpn:
                          type: string
                        url:
                          type: string
                        brand:
                          type: string
                        price:
                          type: number
                        title:
                          type: string
                        category:
                          type: string
                        currency:
                          type: string
                        in_stock:
                          type: boolean
                        image_url:
                          type: string
                        pack_size:
                          type: integer
                        product_id:
                          type: string
                        stock_status:
                          type: string
                        price_display:
                          type: string
                        rs_stock_number:
                          type: string
                        minimum_order_qty:
                          type: integer
                  pagination:
                    type: object
                    properties:
                      next:
                        type: string
                      page:
                        type: integer
                      per_page:
                        type: integer
                      total_pages:
                        type: integer
                      total_results:
                        type: integer
              examples:
                WAGO 221 splice connector on RS Online UK:
                  value:
                    results:
                    - mpn: 221-2401
                      url: https://uk.rs-online.com/web/p/splice-connectors/0303327
                      brand: WAGO
                      price: 4.95
                      title: WAGO, 221 Wire Splice Splice Connector, Clear, Insulated 12 AWG
                      category: Splice Connectors
                      currency: GBP
                      in_stock: true
                      image_url: https://media.rs-online.com/t_large/Y0303327-01.jpg
                      pack_size: 10
                      product_id: '0303327'
                      stock_status: IN_STOCK
                      price_display: £4.95
                      rs_stock_number: 030-3327
                      minimum_order_qty: 1
                    pagination:
                      next: https://uk.rs-online.com/web/c/?searchTerm=connector&pn=2
                      page: 1
                      per_page: 20
                      total_pages: 3220
                      total_results: 64395
        '400':
          description: Bad Request — missing or invalid parameters.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              example:
                error: Bad Request
        '401':
          description: Unauthorized — the API key is missing, invalid, inactive, or expired, or a rate limit was exceeded (`Rate limit exceeded…` message).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                invalidKey:
                  value:
                    error: Invalid API Key
                planRateLimit:
                  value:
                    error: 'Rate limit exceeded: You''ve exceeded the per second rate limit on your subscription'
                keyQuota:
                  value:
                    error: 'Rate limit exceeded for the API key: quota monthly'
        '402':
          description: Payment Required — your subscription or credit balance is insufficient.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              example:
                error: Payment required
        '500':
          description: Internal Server Error — something went wrong on our side.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              example:
                error: Internal Error
      tags:
      - Rsonline
  /v2/rsonline/product:
    get:
      summary: RS Online Product
      description: 'Read one RS Online UK product URL, including the RS stock number, manufacturer part, and pound price.


        **Credit cost:** 2 credits per call'
      operationId: get-rsonline-product
      security:
      - ApiKeyAuth: []
      parameters:
      - name: query
        in: query
        required: true
        description: 'A uk.rs-online.com product link. The response is one flat product. price is the numeric pound amount and price_display is the printed string. A search link, a bare stock number, or another host returns 400.


          Product link


          ```

          https://uk.rs-online.com/web/p/splice-connectors/0303327

          ```'
        schema:
          type: string
          description: 'A uk.rs-online.com product link. The response is one flat product. price is the numeric pound amount and price_display is the printed string. A search link, a bare stock number, or another host returns 400.


            Product link


            ```

            https://uk.rs-online.com/web/p/splice-connectors/0303327

            ```'
      - name: return_page_source
        in: query
        required: false
        description: Default false. true replaces the product object with result, the rendered HTML.
        schema:
          type: boolean
          description: Default false. true replaces the product object with result, the rendered HTML.
      - $ref: '#/components/parameters/fields'
      - $ref: '#/components/parameters/is_async'
      - $ref: '#/components/parameters/soft_fail'
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  mpn:
                    type: string
                  url:
                    type: string
                  brand:
                    type: string
                  price:
                    type: number
                  title:
                    type: string
                  images:
                    type: array
                    items:
                      type: string
                  category:
                    type: string
                  currency:
                    type: string
                  in_stock:
                    type: boolean
                  brand_url:
                    type: string
                  image_url:
                    type: string
                  pack_size:
                    type: integer
                  categories:
                    type: array
                    items:
                      type: string
                  product_id:
                    type: string
                  description:
                    type: string
                  rohs_status:
                    type: string
                  price_breaks:
                    type: array
                    items:
                      type: object
                      properties:
                        price:
                          type: number
                        quantity:
                          type: integer
                        price_display:
                          type: string
                        indicative_price:
                          type: number
                        indicative_price_display:
                          type: string
                  stock_status:
                    type: string
                  datasheet_url:
                    type: string
                  price_display:
                    type: string
                  specifications:
                    type: array
                    items:
                      type: object
                      properties:
                        name:
                          type: string
                        value:
                          type: string
                  rs_stock_number:
                    type: string
                  unit_of_measure:
                    type: string
                  minimum_order_qty:
                    type: integer
              examples:
                WAGO 221 splice connector on RS Online UK:
                  value:
                    mpn: 221-2401
                    url: https://uk.rs-online.com/web/p/splice-connectors/0303327
                    brand: WAGO
                    price: 4.95
                    title: WAGO, 221 Wire Splice Splice Connector, Clear, Insulated 12 AWG
                    images:
                    - https://media.rs-online.com/t_large/Y0303327-01.jpg
                    - https://media.rs-online.com/t_thumb/Y0303327-01.jpg
                    category: Splice Connectors
                    currency: GBP
                    in_stock: true
                    brand_url: https://uk.rs-online.com/web/b/wago
                    image_url: https://media.rs-online.com/t_large/Y0303327-01.jpg
                    pack_size: 10
                    categories:
                    - Electronic Components, Power & Connectors
                    - Connectors
                    - Wire Terminals & Splices
                    - Splice Connectors
                    product_id: '0303327'
                    description: The Wago inline splicing connector with levers (2-conductor, maximum 4 mm²) features tool-free connection for solid, stranded, and fine-stranded conductors (0.2 to 4 mm²). Its slim design saves space, and it is ideal for North American installations with 12 AWG capability. The lever technology enables easy connection and disconnection.
                    rohs_status: EXEMPT
                    price_breaks:
                    - price: 4.95
                      quantity: 1
                      price_display: £4.95
                      indicative_price: 0.495
                      indicative_price_display: £0.495
                    - price: 4.56
                      quantity: 5
                      price_display: £4.56
                      indicative_price: 0.456
                      indicative_price_display: £0.456
                    - price: 4.01
                      quantity: 10
                      price_display: £4.01
                      indicative_price: 0.401
                      indicative_price_display: £0.401
                    stock_status: In Stock
                    datasheet_url: https://docs.rs-online.com/54b0/A700000012773609.pdf
                    price_display: £4.95
                    specifications:
                    - name: Brand
                      value: WAGO
                    - name: Splice Type
                      value: Wire Splice
                    - name: Product Type
                      value: Splice Connector
                    - name: Series
                      value: '221'
                    rs_stock_number: 030-3327
                    unit_of_measure: 1 Pack of 10
                    minimum_order_qty: 1
        '400':
          description: Bad Request — missing or invalid parameters.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              example:
                error: Bad Request
        '401':
          description: Unauthorized — the API key is missing, invalid, inactive, or expired, or a rate limit was exceeded (`Rate limit exceeded…` message).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                invalidKey:
                  value:
                    error: Invalid API Key
                planRateLimit:
                  value:
                    error: 'Rate limit exceeded: You''ve exceeded the per second rate limit on your subscription'
                keyQuota:
                  value:
                    error: 'Rate limit exceeded for the API key: quota monthly'
        '402':
          description: Payment Required — your subscription or credit balance is insufficient.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              example:
                error: Payment required
        '500':
          description: Internal Server Error — something went wrong on our side.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              example:
                error: Internal Error
      tags:
      - Rsonline
    post:
      summary: RS Online Product
      description: 'Read one RS Online UK product URL, including the RS stock number, manufacturer part, and pound price.


        **Credit cost:** 2 credits per call'
      operationId: post-rsonline-product
      security:
      - ApiKeyAuth: []
      parameters:
      - $ref: '#/components/parameters/fields'
      - $ref: '#/components/parameters/is_async'
      - $ref: '#/components/parameters/soft_fail'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                query:
                  type: string
                  description: 'A uk.rs-online.com product link. The response is one flat product. price is the numeric pound amount and price_display is the printed string. A search link, a bare stock number, or another host returns 400.


                    Product link


                    ```

                    https://uk.rs-online.com/web/p/splice-connectors/0303327

                    ```'
                return_page_source:
                  type: boolean
                  description: Default false. true replaces the product object with result, the rendered HTML.
              required:
              - query
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  mpn:
                    type: string
                  url:
                    type: string
                  brand:
                    type: string
                  price:
                    type: number
                  title:
                    type: string
                  images:
                    type: array
                    items:
                      type: string
                  category:
                    type: string
                  currency:
                    type: string
                  in_stock:
                    type: boolean
                  brand_url:
                    type: string
                  image_url:
                    type: string
                  pack_size:
                    type: integer
                  categories:
                    type: array
                    items:
                      type: string
                  product_id:
                    type: string
                  description:
                    type: string
                  rohs_status:
                    type: string
                  price_breaks:
                    type: array
                    items:
                      type: object
                      properties:
                        price:
                          type: number
                        quantity:
                          type: integer
                        price_display:
                          type: string
                        indicative_price:
                          type: number
                        indicative_price_display:
                          type: string
                  stock_status:
                    type: string
                  datasheet_url:
                    type: string
                  price_display:
                    type: string
                  specifications:
                    type: array
                    items:
                      type: object
                      properties:
                        name:
                          type: string
                        value:
                          type: string
                  rs_stock_number:
                    type: string
                  unit_of_measure:
                    type: string
                  minimum_order_qty:
                    type: integer
              examples:
                WAGO 221 splice connector on RS Online UK:
                  value:
                    mpn: 221-2401
                    url: https://uk.rs-online.com/web/p/splice-connectors/0303327
                    brand: WAGO
                    price: 4.95
                    title: WAGO, 221 Wire Splice Splice Connector, Clear, Insulated 12 AWG
                    images:
                    - https://media.rs-online.com/t_large/Y0303327-01.jpg
                    - https://media.rs-online.com/t_thumb/Y0303327-01.jpg
                    category: Splice Connectors
                    currency: GBP
                    in_stock: true
                    brand_url: https://uk.rs-online.com/web/b/wago
                    image_url: https://media.rs-online.com/t_large/Y0303327-01.jpg
                    pack_size: 10
                    categories:
                    - Electronic Components, Power & Connectors
                    - Connectors
                    - Wire Terminals & Splices
                    - Splice Connectors
                    product_id: '0303327'
                    description: The Wago inline splicing connector with levers (2-conductor, maximum 4 mm²) features tool-free connection for solid, stranded, and fine-stranded conductors (0.2 to 4 mm²). Its slim design saves space, and it is ideal for North American installations with 12 AWG capability. The lever technology enables easy connection and disconnection.
                    rohs_status: EXEMPT
                    price_breaks:
                    - price: 4.95
                      quantity: 1
                      price_display: £4.95
                      indicative_price: 0.495
                      indicative_price_display: £0.495
                    - price: 4.56
                      quantity: 5
                      price_display: £4.56
                      indicative_price: 0.456
                      indicative_price_display: £0.456
                    - price: 4.01
                      quantity: 10
                      price_display: £4.01
                      indicative_price: 0.401
                      indicative_price_display: £0.401
                    stock_status: In Stock
                    datasheet_url: https://docs.rs-online.com/54b0/A700000012773609.pdf
                    price_display: £4.95
                    specifications:
                    - name: Brand
                      value: WAGO
                    - name: Splice Type
                      value: Wire Splice
                    - name: Product Type
                      value: Splice Connector
                    - name: Series
                      value: '221'
                    rs_stock_number: 030-3327
                    unit_of_measure: 1 Pack of 10
                    minimum_order_qty: 1
        '400':
          description: Bad Request — missing or invalid parameters.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              example:
                error: Bad Request
        '401':
          description: Unauthorized — the API key is missing, invalid, inactive, or expired, or a rate limit was exceeded (`Rate limit exceeded…` message).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                invalidKey:
                  value:
                    error: Invalid API Key
                planRateLimit:
                  value:
                    error: 'Rate limit exceeded: You''ve exceeded the per second rate limit on your subscription'
                keyQuota:
                  value:
                    error: 'Rate limit exceeded for the API key: quota monthly'
        '402':
          description: Payment Required — your subscription or credit balance is insufficient.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              example:
                error: Payment required
        '500':
          description: Internal Server Error — something went wrong on our side.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              example:
                error: Internal Error
      tags:
      - Rsonline
components:
  parameters:
    fields:
      name: fields
      in: query
      required: false
      description: Comma-separated list of response fields to return, with dot notation for nested fields (e.g. `name,location.city`).
      schema:
        type: string
    is_async:
      name: is_async
      in: query
      required: false
      description: 'Run the request as a background job: the API answers `202` with a `job_id` to poll on `GET /v1/jobs/{id}`.'
      schema:
        type: boolean
        default: false
    soft_fail:
      name: soft_fail
      in: query
      required: false
      description: Return HTTP 200 even when the request fails; the error is in the `error` field of the body.
      schema:
        type: boolean
        default: false
  schemas:
    ErrorResponse:
      type: object
      required:
      - error
      properties:
        error:
          type: string
          description: Human-readable error message.
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key
      description: Your API key. Include it in the x-api-key header for every request.