# generaltranslation: General Translation Core SDK: getRegionProperties
URL: https://generaltranslation.com/en-GB/docs/core/class/methods/locales/get-region-properties.mdx
---
title: getRegionProperties
description: API reference for the GT getRegionProperties method
---

## Overview

The `getRegionProperties` method retrieves detailed information about a region code, including its localised name and associated emoji flag.
It provides a convenient way to get region-specific display information for building internationalised user interfaces.

```typescript
const gt = new GT({
  sourceLocale: 'en-US',
  targetLocale: 'fr-FR'
});

// Get region properties
const usProps = gt.getRegionProperties('US');
console.log(usProps);
// { code: 'US', name: 'United States', emoji: '🇺🇸' }

const frProps = gt.getRegionProperties('FR');
console.log(frProps);
// { code: 'FR', name: 'France', emoji: '🇫🇷' }

// Auto-detect from current locale
const currentRegion = gt.getRegionProperties(); // Uses targetLocale's region
console.log(currentRegion);
// { code: 'FR', name: 'France', emoji: '🇫🇷' }
```

***


## Reference

### Parameters

<TypeTable
  type={{
  "region?": {
    type: 'string',
    optional: true,
    default: 'this.getLocaleProperties().regionCode'
  },
  "customMapping?": {
    type: 'CustomRegionMapping',
    optional: true,
    default: 'this.customRegionMapping'
  }
}}
/>

### Parameter descriptions

| Parameter       | Description                                                                                                          |
| --------------- | -------------------------------------------------------------------------------------------------------------------- |
| `region`        | ISO 3166-1 alpha-2 or UN M.49 region code. If not provided, the region from the instance&#39;s target locale is used |
| `customMapping` | Optional custom region mapping to override the default region names and emojis                                       |

### Returns

`{ code: string; name: string; emoji: string }` - Object containing:

* `code`: The input region code
* `name`: Localised region name in the target locale&#39;s language
* `emoji`: Associated emoji flag or symbol

***

## Examples

### Basic region information

```typescript
const gt = new GT({
  sourceLocale: 'en-US',
  targetLocale: 'en-US'
});

// Common region codes
console.log(gt.getRegionProperties('US')); // { code: 'US', name: 'United States', emoji: '🇺🇸' }
console.log(gt.getRegionProperties('GB')); // { code: 'GB', name: 'United Kingdom', emoji: '🇬🇧' }
console.log(gt.getRegionProperties('DE')); // { code: 'DE', name: 'Germany', emoji: '🇩🇪' }
console.log(gt.getRegionProperties('JP')); // { code: 'JP', name: 'Japan', emoji: '🇯🇵' }
```

***


## Notes

* Uses `Intl.DisplayNames` API for localised region names
* Supports both ISO 3166-1 alpha-2 and UN M.49 region codes
* Custom mappings override default names and emojis
* Automatically detects region from the target locale if no parameter is provided
* Falls back to the region code as the name if display name resolution fails

## Next steps

* Get full locale properties with [`getLocaleProperties`](/docs/core/class/methods/locales/get-locale-properties)
* Get locale emoji with [`getLocaleEmoji`](/docs/core/class/methods/locales/get-locale-emoji)