# Israel CPI Index-Linkage Calculator (CBS) (`defendable_firethorn/israel-cbs-price-indices`) Actor

Official Israeli CPI and price indices from the Central Bureau of Statistics, plus an index-linkage (madad) calculator for rent, contracts and alimony.

- **URL**: https://apify.com/defendable_firethorn/israel-cbs-price-indices.md
- **Developed by:** [Omri Berkovich](https://apify.com/defendable_firethorn) (community)
- **Stats:** 2 total users, 1 monthly users, 100.0% runs succeeded, 0 bookmarks
- **User rating**: No ratings yet

## Pricing

from $10.00 / 1,000 index-linked amount calculations

This Actor is paid per event. You are not charged for the Apify platform usage, but only a fixed price for specific events.

Learn more: https://docs.apify.com/actors/running/actors-in-store.md#pay-per-event

## What's an Apify Actor?

An Actor is a serverless cloud program that runs on the Apify platform. It has two run modes.
In Batch mode, an Actor accepts a well-defined JSON input, performs an action which can take anything from a few seconds to a few hours,
and optionally produces a well-defined JSON output, datasets with results, or files in key-value store.
In Standby mode, an Actor provides a web server which can be used as a website, API, or an MCP server.

Apify vocabulary and the platform model are defined once, in the agent quickstart at https://apify.com/agents.md.

## How to integrate an Actor?

If asked about integration, you help developers integrate Actors into their projects.
You adapt to their stack and deliver integrations that are safe, well-documented, and production-ready.

Do not guess an integration path. Every one of them is in the agent quickstart at https://apify.com/agents.md: the Apify MCP server, Agent Skills with the Apify CLI, the JavaScript and Python clients, the REST API, and the account-free path for an agent with no human to sign in. It also carries the rule on stating cost before the first paid run.

For examples already wired to this Actor's own input schema, see the [API](#api) section below.

Each client library has reference documentation the quickstart does not restate: [JavaScript/TypeScript](https://docs.apify.com/api/client/js/docs.md) (`npm install apify-client`) and [Python](https://docs.apify.com/api/client/python/docs.md) (`pip install apify-client`).

# README

## Israel CPI & Price Indices (official CBS API) + Index-Linkage Calculator

Get official Israeli price indices from the Central Bureau of Statistics (CBS) as clean JSON/CSV/Excel, and index-link ("madad"-link) any shekel amount between two dates using the CBS's own calculator.

**Use cases:** CPI-linked rent and lease updates, construction contracts linked to the residential construction input index, salary/alimony indexation, finance dashboards, LLM/agent tools that need the latest Israeli CPI.

### Modes

- `series` — monthly/quarterly values for one or more index codes (`indexCodes`), filtered by `startPeriod`/`endPeriod` (MM-YYYY) or `lastN`.
- `linkage` — for each `{indexCode, amount, fromDate, toDate}` (dates MM-DD-YYYY) returns the linked amount, % change, and the index periods used (CBS "known index" convention: the result uses the index published as of each date).
- `catalog` — list CBS index chapters and their main codes.

Verified codes: 120010 CPI general · 120460 Rent · 40010 Prices of dwellings · 200010 Residential construction inputs · 140705 Used cars.

### Example input

```json
{"mode": "linkage", "linkageRequests": [{"indexCode": 120010, "amount": 5000, "fromDate": "01-01-2024", "toDate": "09-01-2026"}]}
```

Example output (live, 25.10.2026): 5,000 → 5,370 ILS, +7.4%.

### Pricing (pay per event)

- `index-row` — per index value returned.
- `linkage-calculation` — per linkage result.
  Free-plan users are covered by Apify; no other limits.

### Source & license

Data: Israel Central Bureau of Statistics, api.cbs.gov.il, used under the CBS open licence (commercial use permitted with attribution). This actor is not affiliated with or endorsed by the CBS. Not financial or legal advice; official CBS publications prevail.

### Local run

```
python -m venv .venv && .venv/bin/pip install apify pytest
.venv/bin/python src/main.py input.linkage.json          # plain run, prints JSON
.venv/bin/pytest -q tests                                # live tests vs api.cbs.gov.il
```

# Actor input Schema

## `mode` (type: `string`):

series = monthly/quarterly index values; linkage = CBS official index-linkage of a sum between two dates; catalog = list chapters.

## `indexCodes` (type: `array`):

CBS index codes. Verified: 120010 CPI general, 120460 Rent, 40010 Prices of dwellings, 200010 Residential construction inputs, 140705 Used cars.

## `startPeriod` (type: `string`):

First month to return, in YYYY-MM format (series mode).

## `endPeriod` (type: `string`):

Last month to return, in YYYY-MM format (series mode). Defaults to the latest published month.

## `lastN` (type: `integer`):

Return only the most recent N months of each series (series mode). Ignored if startPeriod is set.

## `linkageRequests` (type: `array`):

Each item: indexCode, amount, fromDate and toDate as MM-DD-YYYY.

## `language` (type: `string`):

Language of index names in the output (he or en).

## Actor input object example

```json
{
  "mode": "series",
  "indexCodes": [
    120010,
    120460
  ],
  "startPeriod": "01-2025",
  "linkageRequests": [
    {
      "indexCode": 120010,
      "amount": 5000,
      "fromDate": "01-01-2024",
      "toDate": "09-01-2026"
    }
  ],
  "language": "en"
}
```

# Actor output Schema

## `results` (type: `string`):

CBS price-index rows and linkage calculation results (default dataset, overview view).

# API

You can run this Actor programmatically using our API. Below are code examples in JavaScript, Python, and CLI, as well as the OpenAPI specification and MCP server setup.

## JavaScript example

```javascript
import { ApifyClient } from 'apify-client';

// Initialize the ApifyClient with your Apify API token
// Replace the '<YOUR_API_TOKEN>' with your token
const client = new ApifyClient({
    token: '<YOUR_API_TOKEN>',
});

// Prepare Actor input
const input = {
    "indexCodes": [
        120010,
        120460
    ],
    "startPeriod": "01-2025",
    "linkageRequests": [
        {
            "indexCode": 120010,
            "amount": 5000,
            "fromDate": "01-01-2024",
            "toDate": "09-01-2026"
        }
    ]
};

// Run the Actor and wait for it to finish
const run = await client.actor("defendable_firethorn/israel-cbs-price-indices").call(input);

// Fetch and print Actor results from the run's dataset (if any)
console.log('Results from dataset');
console.log(`💾 Check your data here: https://console.apify.com/storage/datasets/${run.defaultDatasetId}`);
const { items } = await client.dataset(run.defaultDatasetId).listItems();
items.forEach((item) => {
    console.dir(item);
});

// 📚 Want to learn more 📖? Go to → https://docs.apify.com/api/client/js/docs

```

## Python example

```python
from apify_client import ApifyClient

# Initialize the ApifyClient with your Apify API token
# Replace '<YOUR_API_TOKEN>' with your token.
client = ApifyClient("<YOUR_API_TOKEN>")

# Prepare the Actor input
run_input = {
    "indexCodes": [
        120010,
        120460,
    ],
    "startPeriod": "01-2025",
    "linkageRequests": [{
            "indexCode": 120010,
            "amount": 5000,
            "fromDate": "01-01-2024",
            "toDate": "09-01-2026",
        }],
}

# Run the Actor and wait for it to finish
run = client.actor("defendable_firethorn/israel-cbs-price-indices").call(run_input=run_input)

# Fetch and print Actor results from the run's dataset (if there are any)
print(f"💾 Check your data here: https://console.apify.com/storage/datasets/{run.default_dataset_id}")
for item in client.dataset(run.default_dataset_id).iterate_items():
    print(item)

# 📚 Want to learn more 📖? Go to → https://docs.apify.com/api/client/python/docs/quick-start

```

## CLI example

```bash
echo '{
  "indexCodes": [
    120010,
    120460
  ],
  "startPeriod": "01-2025",
  "linkageRequests": [
    {
      "indexCode": 120010,
      "amount": 5000,
      "fromDate": "01-01-2024",
      "toDate": "09-01-2026"
    }
  ]
}' |
apify call defendable_firethorn/israel-cbs-price-indices --silent --output-dataset

```

## MCP server setup

```json
{
    "mcpServers": {
        "apify": {
            "type": "http",
            "url": "https://mcp.apify.com/?tools=fetch-actor-details,defendable_firethorn/israel-cbs-price-indices"
        }
    }
}
```

The hosted server signs you in with OAuth on first connect, so no API token belongs in this config. Clients without OAuth support can send an `Authorization: Bearer <APIFY_API_TOKEN>` header instead, using a token from API & Integrations in Apify Console (https://console.apify.com/settings/integrations).

## OpenAPI specification

Download the OpenAPI definition: https://api.apify.com/v2/actors/8vhhZmFdpGlh44lCj/builds/fEOCQgSqGsg4qhCkg/openapi.json