# Locale en_IE

## `faker.providers.address`

class faker.providers.address.en_IE.Provider(generator: Any)

  Bases: `Provider`

  address() → str
    Example:

      ‘791 Crist Parks, Sashabury, IL 86039-9874’

    Examples:

        >>> Faker.seed(0)
        >>> for _ in range(5):
        ...     fake.address()
        ...
        '48 McRory Street N59 1FRF Lucy Ville'
        '15 Woods Street H65 20Y1 Christy Ville'
        '97 Hutchison Street V13 NF2Y Cormac Ville'
        '84 Treacy Street X83YD4W Katy Ville'
        "20 O'Shiel Street C22 D726 Saoirse Ville"

  administrative_unit() → str
    Examples:

        >>> Faker.seed(0)
        >>> for _ in range(5):
        ...     fake.administrative_unit()
        ...
        'Leitrim'
        'Fermanagh'
        'Mayo'
        'Offaly'
        'Carlow'

  building_number() → str
    Example:

      ‘791’

    Examples:

        >>> Faker.seed(0)
        >>> for _ in range(5):
        ...     fake.building_number()
        ...
        '60'
        '87'
        '47'
        '93'
        '42'

  city() → str
    Example:

      ‘Sashabury’

    Examples:

        >>> Faker.seed(0)
        >>> for _ in range(5):
        ...     fake.city()
        ...
        'Tia Ville'
        'Piaras Ville'
        'Tobias Ville'
        'Kelsey Ville'
        'Saul Ville'

  city_suffix() → str
    Example:

      ‘town’

    Examples:

        >>> Faker.seed(0)
        >>> for _ in range(5):
        ...     fake.city_suffix()
        ...
        'Ville'
        'Ville'
        'Ville'
        'Ville'
        'Ville'

  country() → str
    Examples:

        >>> Faker.seed(0)
        >>> for _ in range(5):
        ...     fake.country()
        ...
        'Tanzania'
        'Hungary'
        'Senegal'
        'Tuvalu'
        'Italy'

  country_code(representation: str = 'alpha-2') → str
    Examples:

        >>> Faker.seed(0)
        >>> for _ in range(5):
        ...     fake.country_code()
        ...
        'MV'
        'PS'
        'NL'
        'BB'
        'IL'

        >>> Faker.seed(0)
        >>> for _ in range(5):
        ...     fake.country_code(representation='alpha-2')
        ...
        'MV'
        'PS'
        'NL'
        'BB'
        'IL'

        >>> Faker.seed(0)
        >>> for _ in range(5):
        ...     fake.country_code(representation='alpha-3')
        ...
        'MDV'
        'PSE'
        'NLD'
        'BRB'
        'ISR'

  county() → str
    Examples:

        >>> Faker.seed(0)
        >>> for _ in range(5):
        ...     fake.county()
        ...
        'Leitrim'
        'Fermanagh'
        'Mayo'
        'Offaly'
        'Carlow'

  current_country() → str
    Examples:

        >>> Faker.seed(0)
        >>> for _ in range(5):
        ...     fake.current_country()
        ...
        'Republic of Ireland'
        'Republic of Ireland'
        'Republic of Ireland'
        'Republic of Ireland'
        'Republic of Ireland'

  current_country_code() → str
    Examples:

        >>> Faker.seed(0)
        >>> for _ in range(5):
        ...     fake.current_country_code()
        ...
        'IE'
        'IE'
        'IE'
        'IE'
        'IE'

  postcode() → str
    Example:

      86039-9874

    Examples:

        >>> Faker.seed(0)
        >>> for _ in range(5):
        ...     fake.postcode()
        ...
        'X66 P10W'
        'Y473K1F'
        'F21274F'
        'F1102EV'
        'K59 20Y1'

  street_address() → str
    Example:

      ‘791 Crist Parks’

    Examples:

        >>> Faker.seed(0)
        >>> for _ in range(5):
        ...     fake.street_address()
        ...
        '04 McRory Street'
        '93 Landa Street'
        '89 MacConnaghy Street'
        '78 McComiskey Street'
        '87 Shevlin Street'

  street_name() → str
    Example:

      ‘Crist Parks’

    Examples:

        >>> Faker.seed(0)
        >>> for _ in range(5):
        ...     fake.street_name()
        ...
        'Monagle Street'
        'Sayers Street'
        'Lynch Street'
        'Hastie Street'
        'Dwyer Street'

  street_suffix() → str
    Example:

      ‘Avenue’

    Examples:

        >>> Faker.seed(0)
        >>> for _ in range(5):
        ...     fake.street_suffix()
        ...
        'Street'
        'Street'
        'Street'
        'Street'
        'Street'

## `faker.providers.bank`

class faker.providers.bank.en_IE.Provider(generator: Any)

  Bases: `Provider`

  Implement bank provider for `en_IE` locale.

  aba() → str

    Generate an ABA routing transit number.

    Examples:

        >>> Faker.seed(0)
        >>> for _ in range(5):
        ...     fake.aba()
        ...
        '076048766'
        '057593829'
        '052194896'
        '034115783'
        '025659384'

  bank() → str

    Generate a bank name.

  bank_country() → str

    Generate the bank provider’s ISO 3166-1 alpha-2 country code.

    Examples:

        >>> Faker.seed(0)
        >>> for _ in range(5):
        ...     fake.bank_country()
        ...
        'IE'
        'IE'
        'IE'
        'IE'
        'IE'

  bban() → str

    Generate a Basic Bank Account Number (BBAN).

    Examples:

        >>> Faker.seed(0)
        >>> for _ in range(5):
        ...     fake.bban()
        ...
        '66048764759382421948924'
        '11578156593877840801609'
        '75351393328711587148418'
        '58398947196593423209471'
        '12201868483396947751591'

  iban() → str

    Generate an International Bank Account Number (IBAN).

    Examples:

        >>> Faker.seed(0)
        >>> for _ in range(5):
        ...     fake.iban()
        ...
        'IE0666048764759382421948924'
        'IE5911578156593877840801609'
        'IE5875351393328711587148418'
        'IE5558398947196593423209471'
        'IE9812201868483396947751591'

  swift(length: int | None = None, primary: bool = False, use_dataset: bool = False) → str

    Generate a SWIFT code.

    SWIFT codes, reading from left to right, are composed of a 4 alphabet character bank code, a 2 alphabet character country code, a 2 alphanumeric location code, and an optional 3 alphanumeric branch code. This means SWIFT codes can only have 8 or 11 characters, so the value of `length` can only be `None` or the integers `8` or `11`. If the value is `None`, then a value of `8` or `11` will randomly be assigned.

    Because all 8-digit SWIFT codes already refer to the primary branch or office, the `primary` argument only has an effect if the value of `length` is `11`. If `primary` is `True` and `length` is `11`, the 11-digit SWIFT codes generated will always end in `'XXX'` to denote that they belong to primary branches/offices.

    For extra authenticity, localized providers may opt to include SWIFT bank codes, location codes, and branch codes used in their respective locales. If `use_dataset` is `True`, this method will generate SWIFT codes based on those locale-specific codes if included. If those codes were not included, then it will behave as if `use_dataset` were `False`, and in that mode, all those codes will just be randomly generated as per the specification.

    Examples:

        >>> Faker.seed(0)
        >>> for _ in range(5):
        ...     fake.swift()
        ...
        'YNBIIE65ZT4'
        'SGQEIESIGQ8'
        'JDXCIEV4'
        'LNKTIEN9'
        'OQIBIE9AFZA'

        >>> Faker.seed(0)
        >>> for _ in range(5):
        ...     fake.swift(length=8)
        ...
        'MYNBIEQ6'
        'PMZJIE4W'
        'SGQEIESI'
        'YDTZIEQ8'
        'WZTEIETG'

        >>> Faker.seed(0)
        >>> for _ in range(5):
        ...     fake.swift(length=8, use_dataset=True)
        ...
        'MYNBIEQ6'
        'PMZJIE4W'
        'SGQEIESI'
        'YDTZIEQ8'
        'WZTEIETG'

        >>> Faker.seed(0)
        >>> for _ in range(5):
        ...     fake.swift(length=11)
        ...
        'MYNBIEQ65ZT'
        'PLSGIE6ISIG'
        'TZIRIEJTGEV'
        'PRDLIE1UN94'
        'OQIBIE9AFZA'

        >>> Faker.seed(0)
        >>> for _ in range(5):
        ...     fake.swift(length=11, primary=True)
        ...
        'MYNBIEQ6XXX'
        'PMZJIE4WXXX'
        'SGQEIESIXXX'
        'YDTZIEQ8XXX'
        'WZTEIETGXXX'

        >>> Faker.seed(0)
        >>> for _ in range(5):
        ...     fake.swift(length=11, use_dataset=True)
        ...
        'MYNBIEQ65ZT'
        'PLSGIE6ISIG'
        'TZIRIEJTGEV'
        'PRDLIE1UN94'
        'OQIBIE9AFZA'

        >>> Faker.seed(0)
        >>> for _ in range(5):
        ...     fake.swift(length=11, primary=True, use_dataset=True)
        ...
        'MYNBIEQ6XXX'
        'PMZJIE4WXXX'
        'SGQEIESIXXX'
        'YDTZIEQ8XXX'
        'WZTEIETGXXX'

  swift11(primary: bool = False, use_dataset: bool = False) → str

    Generate an 11-digit SWIFT code.

    This method uses `swift()` under the hood with the `length` argument set to `11`. If `primary` is set to `True`, the SWIFT code will always end with `'XXX'`. All 11-digit SWIFT codes use this convention to refer to the primary branch/office.

    Examples:

        >>> Faker.seed(0)
        >>> for _ in range(5):
        ...     fake.swift11()
        ...
        'MYNBIEQ65ZT'
        'PLSGIE6ISIG'
        'TZIRIEJTGEV'
        'PRDLIE1UN94'
        'OQIBIE9AFZA'

        >>> Faker.seed(0)
        >>> for _ in range(5):
        ...     fake.swift11(use_dataset=True)
        ...
        'MYNBIEQ65ZT'
        'PLSGIE6ISIG'
        'TZIRIEJTGEV'
        'PRDLIE1UN94'
        'OQIBIE9AFZA'

  swift8(use_dataset: bool = False) → str

    Generate an 8-digit SWIFT code.

    This method uses `swift()` under the hood with the `length` argument set to `8` and with the `primary` argument omitted. All 8-digit SWIFT codes already refer to the primary branch/office.

    Examples:

        >>> Faker.seed(0)
        >>> for _ in range(5):
        ...     fake.swift8()
        ...
        'MYNBIEQ6'
        'PMZJIE4W'
        'SGQEIESI'
        'YDTZIEQ8'
        'WZTEIETG'

        >>> Faker.seed(0)
        >>> for _ in range(5):
        ...     fake.swift8(use_dataset=True)
        ...
        'MYNBIEQ6'
        'PMZJIE4W'
        'SGQEIESI'
        'YDTZIEQ8'
        'WZTEIETG'

## `faker.providers.geo`

class faker.providers.geo.en_IE.Provider(generator: Any)

  Bases: `Provider`

  coordinate(center: float | None = None, radius: float | int = 0.001) → Decimal

    Optionally center the coord and pick a point within radius.

    Examples:

        >>> Faker.seed(0)
        >>> for _ in range(5):
        ...     fake.coordinate()
        ...
        Decimal('26.826999')
        Decimal('45.792650')
        Decimal('-158.265114')
        Decimal('-40.995129')
        Decimal('94.488524')

  latitude() → Decimal
    Examples:

        >>> Faker.seed(0)
        >>> for _ in range(5):
        ...     fake.latitude()
        ...
        Decimal('13.4134995')
        Decimal('22.896325')
        Decimal('-79.132557')
        Decimal('-20.4975645')
        Decimal('47.244262')

  latlng() → Tuple[Decimal, Decimal]
    Examples:

        >>> Faker.seed(0)
        >>> for _ in range(5):
        ...     fake.latlng()
        ...
        (Decimal('13.4134995'), Decimal('45.792650'))
        (Decimal('-79.132557'), Decimal('-40.995129'))
        (Decimal('47.244262'), Decimal('80.880444'))
        (Decimal('18.6986795'), Decimal('-17.160223'))
        (Decimal('37.935520'), Decimal('12.226293'))

  local_latlng(country_code: str = 'US', coords_only: bool = False) → Tuple[str, ...] | None

    Returns a location known to exist on land in a country specified by country_code. Defaults to ‘en_US’. See the land_coords list for available locations/countries.

    Examples:

        >>> Faker.seed(0)
        >>> for _ in range(5):
        ...     fake.local_latlng()
        ...
        None
        None
        None
        None
        None

  location_on_land(coords_only: bool = False) → Tuple[str, ...]

    Returns a random tuple specifying a coordinate set guaranteed to exist on land. Format is (latitude, longitude, place name, two-letter country code, timezone) Pass coords_only to return coordinates without metadata.

    Examples:

        >>> Faker.seed(0)
        >>> for _ in range(5):
        ...     fake.location_on_land()
        ...
        ('52.138977', '-8.653916', 'Mallow, Co. Cork,', 'IE', 'Europe/Dublin')
        ('51.880878', '-8.658640', 'Ovens, Co. Cork,', 'IE', 'Europe/Dublin')
        ('52.668076', '-8.536722', 'Annacotty, County Limerick,', 'IE', 'Europe/Dublin')
        ('53.381290', '-6.591850', 'Maynooth, Co. Kildare,', 'IE', 'Europe/Dublin')
        ('53.270962', '-9.062691', 'Galway', 'IE', 'Europe/Dublin')

  longitude() → Decimal
    Examples:

        >>> Faker.seed(0)
        >>> for _ in range(5):
        ...     fake.longitude()
        ...
        Decimal('26.826999')
        Decimal('45.792650')
        Decimal('-158.265114')
        Decimal('-40.995129')
        Decimal('94.488524')

## `faker.providers.person`

class faker.providers.person.en_IE.Provider(generator: Any)

  Bases: `Provider`

  first_name() → str
    Examples:

        >>> Faker.seed(0)
        >>> for _ in range(5):
        ...     fake.first_name()
        ...
        'Cailin'
        'Tia'
        'Ciara'
        'Cailum'
        'Piaras'

  first_name_female() → str
    Examples:

        >>> Faker.seed(0)
        >>> for _ in range(5):
        ...     fake.first_name_female()
        ...
        'Susan'
        'Harriet'
        'Ruth'
        'Tracey'
        'Janet'

  first_name_male() → str
    Examples:

        >>> Faker.seed(0)
        >>> for _ in range(5):
        ...     fake.first_name_male()
        ...
        'Keelan'
        'Lloyd'
        'Arron'
        'Fergal'
        'Pearse'

  first_name_nonbinary() → str
    Examples:

        >>> Faker.seed(0)
        >>> for _ in range(5):
        ...     fake.first_name_nonbinary()
        ...
        'Cailin'
        'Tia'
        'Ciara'
        'Cailum'
        'Piaras'

  language_name() → str

    Generate a random i18n language name (e.g. English).

    Examples:

        >>> Faker.seed(0)
        >>> for _ in range(5):
        ...     fake.language_name()
        ...
        'Luba-Katanga'
        'Malay'
        'Aymara'
        'Interlingue'
        'Quechua'

  last_name() → str
    Examples:

        >>> Faker.seed(0)
        >>> for _ in range(5):
        ...     fake.last_name()
        ...
        'McIneely'
        'Monagle'
        'Cantwell'
        'Kelvey'
        'Sayers'

  last_name_female() → str
    Examples:

        >>> Faker.seed(0)
        >>> for _ in range(5):
        ...     fake.last_name_female()
        ...
        'McIneely'
        'Monagle'
        'Cantwell'
        'Kelvey'
        'Sayers'

  last_name_male() → str
    Examples:

        >>> Faker.seed(0)
        >>> for _ in range(5):
        ...     fake.last_name_male()
        ...
        'McIneely'
        'Monagle'
        'Cantwell'
        'Kelvey'
        'Sayers'

  last_name_nonbinary() → str
    Examples:

        >>> Faker.seed(0)
        >>> for _ in range(5):
        ...     fake.last_name_nonbinary()
        ...
        'McIneely'
        'Monagle'
        'Cantwell'
        'Kelvey'
        'Sayers'

  name() → str
    Example:

      ‘John Doe’

    Examples:

        >>> Faker.seed(0)
        >>> for _ in range(5):
        ...     fake.name()
        ...
        'Dr. Ruth Monagle'
        'Fergal Sayers'
        'Iona Lynch'
        'Frances Hastie'
        'Cara Landa'

  name_female() → str
    Examples:

        >>> Faker.seed(0)
        >>> for _ in range(5):
        ...     fake.name_female()
        ...
        'Dr. Ruth Monagle'
        'Fergal Sayers'
        'Iona Lynch'
        'Frances Hastie'
        'Cara Landa'

  name_male() → str
    Examples:

        >>> Faker.seed(0)
        >>> for _ in range(5):
        ...     fake.name_male()
        ...
        'Dr. Ruth Monagle'
        'Fergal Sayers'
        'Iona Lynch'
        'Frances Hastie'
        'Cara Landa'

  name_nonbinary() → str
    Examples:

        >>> Faker.seed(0)
        >>> for _ in range(5):
        ...     fake.name_nonbinary()
        ...
        'Dr. Ruth Monagle'
        'Fergal Sayers'
        'Iona Lynch'
        'Frances Hastie'
        'Cara Landa'

  prefix() → str
    Examples:

        >>> Faker.seed(0)
        >>> for _ in range(5):
        ...     fake.prefix()
        ...
        'Dr.'
        'Dr.'
        'Dr.'
        'Dr.'
        'Ms.'

  prefix_female() → str
    Examples:

        >>> Faker.seed(0)
        >>> for _ in range(5):
        ...     fake.prefix_female()
        ...
        'Dr.'
        'Dr.'
        'Mrs.'
        'Miss'
        'Dr.'

  prefix_male() → str
    Examples:

        >>> Faker.seed(0)
        >>> for _ in range(5):
        ...     fake.prefix_male()
        ...
        'Dr.'
        'Dr.'
        'Mr.'
        'Dr.'
        'Dr.'

  prefix_nonbinary() → str
    Examples:

        >>> Faker.seed(0)
        >>> for _ in range(5):
        ...     fake.prefix_nonbinary()
        ...
        'Dr.'
        'Dr.'
        'Dr.'
        'Dr.'
        'Ms.'

  suffix() → str
    Examples:

        >>> Faker.seed(0)
        >>> for _ in range(5):
        ...     fake.suffix()
        ...
        ''
        ''
        ''
        ''
        ''

  suffix_female() → str
    Examples:

        >>> Faker.seed(0)
        >>> for _ in range(5):
        ...     fake.suffix_female()
        ...
        ''
        ''
        ''
        ''
        ''

  suffix_male() → str
    Examples:

        >>> Faker.seed(0)
        >>> for _ in range(5):
        ...     fake.suffix_male()
        ...
        ''
        ''
        ''
        ''
        ''

  suffix_nonbinary() → str
    Examples:

        >>> Faker.seed(0)
        >>> for _ in range(5):
        ...     fake.suffix_nonbinary()
        ...
        ''
        ''
        ''
        ''
        ''

## `faker.providers.ssn`

class faker.providers.ssn.en_IE.Provider(generator: Any)

  Bases: `Provider`

  A Faker provider for the Irish VAT IDs

  ssn() → str
    Examples:

        >>> Faker.seed(0)
        >>> for _ in range(5):
        ...     fake.ssn()
        ...
        '604-87-6475'
        '824-21-9489'
        '411-57-8156'
        '938-77-8408'
        '160-97-5351'

  vat_id() → str

    http://ec.europa.eu/taxation_customs/vies/faq.html#item_11 :return: a random Irish VAT ID

    Examples:

        >>> Faker.seed(0)
        >>> for _ in range(5):
        ...     fake.vat_id()
        ...
        'IE6048764E'
        'IE9382421N'
        'IE8924115E'
        'IE1565938EC'
        'IE4080160NF'