# `extractTime`

## Description

Returns a specific unit of time extracted from a timestamp, such as the hour, minute, or second.

Note

- Date units such as `'month'` or `'week'` start from **1**, not 0.
- Units smaller than `minute` return floating-point numbers; all others return integers.

## Syntax

Like many functions in DataPrime, `extractTime` supports [two notations](https://coralogix.com/docs/dataprime/language-reference/functions-reference/index.md), **function** and **method** notation. These interchangeable forms allow flexibility in how you structure expressions.

```dataprime
extractTime(timestamp: timestamp, unit: dateunit | timeunit, tz?: string): number
```

```dataprime
(timestamp: timestamp).extractTime(unit: dateunit | timeunit, tz?: string): number
```

## Arguments

| Name      | Type      | Required  | Description                                                  |
| --------- | --------- | --------- | ------------------------------------------------------------ |
| timestamp | timestamp | **true**  | The timestamp to extract from                                |
| unit      | dateunit  | timeunit  | **true**                                                     |
| tz        | string    | **false** | A valid time zone string (see Time Zone section for details) |

## Example 1

**Use case: Find the hour in a specific time zone**

Extract the hour of the day from a timestamp, adjusted to Tokyo time.

### Example data

```json
{
  "timestamp": 1728636298
}
```

### Example query

```dataprime
choose extractTime($m.timestamp, 'h', 'Asia/Tokyo') as h
```

```dataprime
choose $m.timestamp.extractTime('h', 'Asia/Tokyo') as h
```

### Example output

```json
{
  "h": 20
}
```

## Example 2

**Use case 2: Extract the number of seconds**

Extract just the seconds portion of a timestamp.

### Example data

```json
{
  "timestamp": 1728636298
}
```

### Example query

```dataprime
choose extractTime(timestamp, 'second') as s
```

```dataprime
choose timestamp.extractTime('second') as s
```

### Example output

```json
{
  "s": 13.0
}
```
