# getFrenchTerritoryProfile

**Identifier:** `insee_getFrenchTerritoryProfile`

**Provider:** [INSEE Statistics](https://kirha.com/providers/insee.md)

Get the socio-economic profile of a French commune, intercommunality (EPCI), department, region or France: population, employment and unemployment from the census, median standard of living, poverty rate and inequality, and housing (owners, second homes, vacancy).

## Run it with the CLI

```bash
kirha tools run insee_getFrenchTerritoryProfile \
  --input '{
    "place": "Bordeaux"
  }'
```

`--input` takes a JSON object that matches the input schema. Pass `--input -` to read it from stdin.

## Call it over HTTP

```bash
curl https://api.kirha.com/tools/v1/execute \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: **********' \
  --data '{
  "tool_name": "insee_getFrenchTerritoryProfile",
  "input": {
    "place": "Bordeaux"
  }
}'
```

Replace the stars with an API key from https://app.kirha.com/api-keys.

## Input schema

```json
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "properties": {
    "place": {
      "description": "Name or INSEE code, e.g., Bordeaux, 33063, Gironde, Bretagne, Métropole de Lyon",
      "minLength": 2,
      "type": "string"
    }
  },
  "required": [
    "place"
  ],
  "type": "object"
}
```

## Output schema

```json
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "additionalProperties": false,
  "properties": {
    "activePopulation15to64": {
      "type": "number"
    },
    "censusYear": {
      "type": "string"
    },
    "context": {
      "type": "string"
    },
    "dwellings": {
      "type": "number"
    },
    "employmentRatePct": {
      "type": "number"
    },
    "giniIndex": {
      "type": "number"
    },
    "graduatesShareOfAdultsPct": {
      "type": "number"
    },
    "incomeYear": {
      "type": "string"
    },
    "inseeGeo": {
      "type": "string"
    },
    "level": {
      "type": "string"
    },
    "medianStandardOfLivingEur": {
      "type": "number"
    },
    "ownersPct": {
      "type": "number"
    },
    "pensionsShareOfIncomePct": {
      "type": "number"
    },
    "place": {
      "type": "string"
    },
    "population": {
      "type": "number"
    },
    "populationYear": {
      "type": "string"
    },
    "povertyRatePct": {
      "type": "number"
    },
    "secondHomesPct": {
      "type": "number"
    },
    "socialBenefitsShareOfIncomePct": {
      "type": "number"
    },
    "socialHousingTenantsPct": {
      "type": "number"
    },
    "unemploymentRatePct": {
      "type": "number"
    },
    "unemploymentRatePct2017": {
      "type": "number"
    },
    "vacantPct": {
      "type": "number"
    }
  },
  "required": [
    "context",
    "place",
    "level",
    "inseeGeo"
  ],
  "type": "object"
}
```

-----

[All INSEE Statistics tools](https://kirha.com/providers/insee.md) · [< Back to tools list](https://kirha.com/tools.md)