---
title: "List the countries"
method: GET
path: "/countries"
tags: ["Countries"]
---

# List the countries

`GET /countries`

## Request

- Base URL: `https://www.upgrowth.dz/api/v1`
- URL: `https://www.upgrowth.dz/api/v1/countries`
- Auth: one of:
  - none
  - HTTP bearer

The countries the data covers, each with its ISO code, names, languages, currency, status (live or planned), datasets and free_access (whether it answers without a key). It takes no country.

## Query parameters

- `lang` 'fr' | 'ar' | 'en'

## Response `200`

The data, with its meta.

- object
  - `data` Country[], required
    - `code` string, required: ISO 3166-1 alpha-2 code, for example DZ.
    - `names` Localized, required: The same text in the three languages of the site.
      - `fr` string
      - `ar` string
      - `en` string
    - `languages` string[]: The languages the labels of the country are served in.
    - `currency` string: ISO 4217 code of the currency of the country.
    - `status` 'live' | 'planned', required: live: the data is served. planned: announced, not served yet.
    - `datasets` string[], required: The datasets the country has, among activities, anae, wilayas, jo-index, jo-sommaires, customs-tariff, creation, casnos, ifu, tax, social, institutions, rules-vat, rules-calendar, rules-support, jo-text, poste, dairas, tax-codes. Empty while the country is planned.
    - `free_access` boolean: true when a call with no key is answered for this country (today Algeria only), false when it needs an API key.
  - `meta` Meta, required
    - `country` string, nullable: ISO 3166-1 alpha-2 code of the country the answer is about, for example DZ. Present on every successful answer: null only for the list of countries.
    - `dataset` string, required: Identifier of the dataset the answer comes from.
    - `source` string, required: Name of the source, in the language of the request.
    - `source_url` string, required: The page that describes the source.
    - `licence` string, nullable, required: The licence of the dataset: CC BY 4.0 for the datasets UpGrowth publishes under it, otherwise null.
    - `licence_url` string, nullable, required: Link to the text of the licence, null when licence is null.
    - `attribution` string, required: The credit to give when the data is used, in the language of the request: UpGrowth, with a link to https://www.upgrowth.dz.
    - `updated` string, nullable, required: Day of the snapshot of the data, as YYYY-MM-DD. For the tax rates, social contributions and institutions: the day the official pages were read.
    - `notice` string: Datasets without an open licence only: why. A null licence never means public domain.
    - `help` object, required: A call to action to relay to the user, in the language of the request.
      - `text` string, required: One sentence to pass on to the user.
      - `url` string, uri, required: The contact page of UpGrowth to send the user to.
    - `total` integer: Number of results. Present on lists.
    - `limit` integer: Page size used. Paginated lists only.
    - `offset` integer: Results skipped. Paginated lists only.
    - `sommaire_years` integer[]: Journal Officiel search only: the years whose summaries are searched.
    - `free_years` integer[]: Calls with no key, Journal Officiel routes only: the years such a call may read.
    - `truncated` object: Calls with no key only: present when the answer holds fewer rows than matched, because such a call gets at most 10 rows and cannot page.
      - `returned` integer, required: Rows in this answer.
      - `total` integer, nullable: Rows that matched, null when unknown.
    - `free_note` string: Calls with no key only: says the list is not complete. Present with truncated.
    - `sources` SourceRef[]: Tunisian governorates and Moroccan regions only: every official page the list was read on.
      - `url` string, uri, required: The official page the record was read on.
      - `title` string, required: What the page is.
      - `retrieved` string, required: The day the page was read, as YYYY-MM-DD.
    - `disclaimer` Localized: The same text in the three languages of the site.
      - `fr` string
      - `ar` string
      - `en` string

## Other responses

- `400`: A parameter is missing or invalid. error.code names the problem and error.message says how to fix it.
- `401`: invalid_key: the Authorization header is malformed, or the key is unknown or revoked. A call without the header is never refused with this code, it uses the free tier.
- `403`: dataset_unavailable: the account of the key may not read the data of this country. access_denied: the account is not served. Neither says why. key_required: a call with no key asked for what needs one (a country other than Algeria, an older year of the Journal Officiel, a page of a search past the first). trial_ended: the trial of the account is over.
- `429`: rate_limited (more than about 30 requests in 10 seconds from one address), free_quota_exceeded (the free tier of the address is used up for today), quota_exceeded (the daily quota of the key is used up) or monthly_quota_exceeded (the monthly quota of the account is used up, on the plans that have one) or trial_quota (the 1,000 calls of a trial are used up, which does not reset). Retry-After says when to try again.
- `503`: unavailable: a call with a key could not be counted right now. Retry in a moment.

---

[API](https://skmtc.dev/upgrowth/apis/upgrowth-algerian-business-data-api.md) · [All operations](https://skmtc.dev/upgrowth/apis/upgrowth-algerian-business-data-api/llms.txt) · [OpenAPI document](https://skmtc.dev/upgrowth/apis/upgrowth-algerian-business-data-api/revisions/76dce93244ad?raw)