> ## Documentation Index
> Fetch the complete documentation index at: https://docs.symmetry.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Endpoints

> Call MWF rate endpoints with sample requests. Covers /mwf/v1/location, /mwf/v1/id, /mwf/v1/rates/effective, params, useAddressSuggestion, and response objects.

Minimum wage endpoints that return rates include:

* `/mwf/v1/location` returns minimum wage rates by location and effective date.
* `/mwf/v1/id` returns minimum wage rates by the minimum wage unique ID.
* `/mwf/v1/rates/effective` returns upcoming minimum wage rates by effective date range.

## Calling the `/mwf/v1/location` endpoint (GET)

The `/mwf/v1/location` endpoint (`https://api.symmetry.com/mwf/v1/location`) returns minimum wage rates by location (address or `longitude`/`latitude` pair) and effective date. The result contains all minimum wage rates for a location and effective date.

### Query parameters

| Parameter              | Format                  | Enforcement                                                                     |
| ---------------------- | ----------------------- | ------------------------------------------------------------------------------- |
| `streetAddress1`       | String                  | Required if `latitude` and `longitude` are `null`.                              |
| `streetAddress2`       | String                  | Optional.                                                                       |
| `city`                 | String                  | Required if `latitude` and `longitude` are `null`.                              |
| `state`                | String                  | Required if `latitude` and `longitude` are `null`.                              |
| `zipCode`              | `XXXXX` or `XXXXX-XXXX` | Required if `latitude` and `longitude` are `null`.                              |
| `effectiveDate`        | `YYYY-MM-DD`            | Required.                                                                       |
| `latitude`             | String                  | Required if address parameters are `null`.                                      |
| `longitude`            | String                  | Required if address parameters are `null`.                                      |
| `useAddressSuggestion` | Boolean                 | Optional. [the `useAddressSuggestion` parameter](/mwf/api/address-suggestions). |

<Info>
  Valid lat/long coordinates will take precedence over a street address.
</Info>

### Sample GET request

```bash theme={null}
curl --location --request GET 'https://api.symmetry.com/mwf/v1/location?streetAddress1=123%20main%20st&city=Edison&state=NJ&zipCode=08837&effectiveDate=2021-01-01' \
--header 'Authorization: Bearer YOUR_ACCESS_TOKEN'
```

In this example, parameters are set to the following:

* `streetAddress1`: `123 Main St`
* `city`: `Edison`
* `state`: `NJ`
* `zipCode`: `08837`
* `effectiveDate`: `2021-01-01`

### Sample response

```json theme={null}
{
    "rates": [
        {
            "mwUid": "00-0-000000000-EXM-012-013",
            "state": "Federal",
            "stateCode": 0,
            "authorityCode": 0,
            "authority": "",
            "authorityType": "Federal",
            "authorityTypeCode": 0,
            "rate": "27.63",
            "effectiveDate": "2017-01-01",
            "majorType": "EXM",
            "industryType": "Computer Professionals",
            "industryTypeCode": 12,
            "minorType": "Minimum Hourly Rate Of Pay Exemption From Overtime Amount",
            "minorTypeCode": 13,
            "details": "Exempt computer employee",
            "updated": "2020-07-07 17:16:03"
        }
        . . .
    ],
    "normalizedAddress": {
        "streetAddress1": "123 Main St",
        "city": "Edison",
        "state": "NJ",
        "zipCode": "08837-2920"
    },
    "normalizedCoordinates": {
        "longitude": -74.358125,
        "latitude": 40.522835
    }
}
```

## Calling the `/mwf/v1/id` endpoint (GET)

The `/mwf/v1/id` endpoint (`https://api.symmetry.com/mwf/v1/id`) returns minimum wage rates by the minimum wage unique ID (`mwUid`). The `mwUid` string is returned for each rate in the `/mwf/v1/location` endpoint and follows the format below.

`stateCode-authorityType-authorityCode-majorType-industryTypeCode-minorTypeCode`

For more information on each of the elements that make up the minimum wage unique ID, see [Minimum wage unique IDs](/mwf/core-concepts/mwuid-elements).

### Query parameters

| Parameter          | Format                                        | Enforcement |
| ------------------ | --------------------------------------------- | ----------- |
| `effectiveDate`    | `YYYY-MM-DD`                                  | Optional    |
| `mwUid`            | String                                        | Required    |
| `industryTypeCode` | 3-digit number                                | Optional    |
| `majorType`        | Three-character code (`REG`, `TIP`, or `EXM`) | Optional    |
| `minorTypeCode`    | 3-digit number                                | Optional    |
| `pageNumber`       | Number                                        | Optional    |
| `pageSize`         | Number                                        | Optional    |
| `updatedSince`     | `YYYY-MM-DD`                                  | Optional    |

Please note the following on parameters:

* A wildcard `*` can be used to return all possible values.
* If both `effectiveDate` and `updatedSince` are omitted, the entire rate history is returned.
* Setting both `effectiveDate` and `updatedSince` at the same time is not allowed.
* `effectiveDate` cannot be set in conjunction with rate type (`majorType`, `industryTypeCode`, `minorTypeCode`).
* Limit results by setting `pageNumber` and `pageSize`. When setting `pageSize` to `-1`, all results will be returned in a single API call.

### Sample GET request

```bash theme={null}
curl --location --request GET 'https://api.symmetry.com/mwf/v1/id?effectiveDate=2021-01-31&mwUid=06-3-277483-*-*-*&pageNumber=0&pageSize=1' \
--header 'Authorization: Bearer YOUR_ACCESS_TOKEN'
```

In this example, parameters are set to the following:

* `effectiveDate`: `2021-01-31`
* `mwUid`: `06-3-277483-*-*-*`
* `pageNumber`: `0`
* `pageSize`: `1`

### Sample response

```json theme={null}
{
    "ratesPage": {
        "content": [
            {
                "mwUid": "06-3-000277483-REG-000-002",
                "stateCode": 6,
                "state": "California",
                "authorityCode": 277483,
                "authority": "Campbell",
                "authorityType": "City",
                "authorityTypeCode": 3,
                "rate": "13.00",
                "effectiveDate": "2020-01-01",
                "majorType": "REG",
                "industryType": "",
                "industryTypeCode": 0,
                "minorType": "26 Employees Or More",
                "minorTypeCode": 2,
                "details": "26 employees or more",
                "note": "",
                "updated": "2020-07-07 17:16:03"
            }
        ],
        "pageable": {
            "sort": {
                "unsorted": true,
                "sorted": false,
                "empty": true
            },
            "offset": 0,
            "pageNumber": 0,
            "pageSize": 1,
            "unpaged": false,
            "paged": true
        },
        "last": false,
        "totalPages": 2,
        "totalElements": 2,
        "sort": {
            "unsorted": true,
            "sorted": false,
            "empty": true
        },
        "size": 1,
        "number": 0,
        "first": true,
        "numberOfElements": 1,
        "empty": false
    }
}
```

## Calling the `/mwf/v1/rates/effective` endpoint (GET)

The `/mwf/v1/rates/effective` endpoint (`https://api.symmetry.com/mwf/v1/rates/effective`) returns upcoming minimum wage rates by effective date range. The result contains upcoming minimum wage rates for either the date range and/or `mwUid` specified in the query parameter.

### Query parameters

| Parameter | Format       | Enforcement                                                                      |
| --------- | ------------ | -------------------------------------------------------------------------------- |
| `from`    | `YYYY-MM-DD` | Optional. Defaults to today's date.                                              |
| `to`      | `YYYY-MM-DD` | Optional. Defaults to `9999-12-31` when omitted, which returns all future rates. |
| `mwUid`   | String       | Optional. Defaults to `*-*-*-*-*-*`.                                             |

Please note the following on parameters:

* A wildcard `*` can be used to return all possible values.
* To use the wildcard, use `*` for each part of the `mwUid` that is part of the wildcard search.
  * For example, to search all future upcoming rates use the following: `/mwf/v1/rates/effective?mwUid=*-*-*-*-*-*`
  * To search all future upcoming minimum wage rates for the state of Arizona, use the following: `/mwf/v1/rates/effective?mwUid=04-*-*-*-*-*`
* Setting either `from` or `to` as the single query parameter will return results accordingly:
  * For example, `/mwf/v1/rates/effective?from=2025-07-01` will return future dates as of July 1, 2025.
  * Setting `/mwf/v1/rates/effective?to=2025-12-31` will return future dates through December 31, 2025.
* Combining a date range with `mwUid` will return future minimum wage changes for the specified `mwUid` only.
  * For example, `/mwf/v1/rates/effective?from=2025-07-01&to=2025-12-31&mwUid=12-1-000000000-REG-000-000` will return future minimum wage rates for `mwUid` `12-1-000000000-REG-000-000` only.

### Sample GET request

```bash theme={null}
curl --location --request GET 'https://api.symmetry.com/mwf/v1/rates/effective?from=2025-09-01&to=2025-12-31' \
--header 'Authorization: Bearer YOUR_ACCESS_TOKEN'
```

In this example, parameters are set to the following:

* `from`: `2025-09-01`
* `to`: `2025-12-31`

### Sample response

```json theme={null}
[
  {
    "mwUid": "12-1-000000000-REG-000-000",
    "authority": "",
    "authorityCode": 0,
    "authorityType": "State",
    "authorityTypeCode": 1,
    "details": "",
    "effectiveDate": "2025-09-30",
    "industryType": "",
    "industryTypeCode": 0,
    "majorType": "REG",
    "minorType": "",
    "minorTypeCode": 0,
    "note": "",
    "rate": 14.0,
    "stateCode": "12",
    "updated": "2021-06-01T16:49:13.000"
  },
  {
    "mwUid": "12-1-000000000-TIP-000-000",
    "authority": "",
    "authorityCode": 0,
    "authorityType": "State",
    "authorityTypeCode": 1,
    "details": "",
    "effectiveDate": "2025-09-30",
    "industryType": "",
    "industryTypeCode": 0,
    "majorType": "TIP",
    "minorType": "",
    "minorTypeCode": 0,
    "note": "",
    "rate": 10.98,
    "stateCode": "12",
    "updated": "2021-06-01T16:49:28.000"
  }
]
```

## Response objects

Minimum Wage Finder returns minimum wage data for all authority types (for example, state, city, and federal) along with the effective date, major type, industry, minor type, and other details for each rate. The `/mwf/v1/id` endpoint supports pagination, so pagination metadata is returned in addition to rate data.

### Minimum wage rate object

| Element             | Type   | Description                                                                                                                                                                                        |
| ------------------- | ------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `mwUid`             | String | Unique wage code for the minimum wage. Format: `stateCode-authorityType-authorityCode-majorType-industryTypeCode-minorTypeCode`. See [Minimum wage unique IDs](/mwf/core-concepts/mwuid-elements). |
| `state`             | String | State name that corresponds to `stateCode`.                                                                                                                                                        |
| `stateCode`         | Number | Two-digit value that represents the state.                                                                                                                                                         |
| `authorityCode`     | Number | GNIS code for `authorityType`. Full list on the USGS query site for the US and US Territories.                                                                                                     |
| `authority`         | String | Name of the relevant city or local taxation authority. State and Federal return `null`.                                                                                                            |
| `authorityType`     | String | Taxing authority that defines `authorityTypeCode`. Values: `Federal`, `State`, `County`, `City`, `City Metro`, `Municipal`.                                                                        |
| `authorityTypeCode` | Number | One-digit value for the taxing authority: `0` = Federal, `1` = State, `2` = County, `3` = City, `4` = City Metro, `5` = Municipal.                                                                 |
| `rate`              | String | Minimum wage rate.                                                                                                                                                                                 |
| `effectiveDate`     | String | Minimum wage effective date.                                                                                                                                                                       |
| `majorType`         | String | Three-character wage type code: `REG` (regular), `TIP` (tipped), `EXM` (exempt).                                                                                                                   |
| `industryType`      | String | Industry where the wages are earned (for example, non-profit, agriculture, apparel, healthcare).                                                                                                   |
| `industryTypeCode`  | Number | Three-digit value that corresponds to `industryType`.                                                                                                                                              |
| `minorType`         | String | Short description of the employer context that defines `minorTypeCode` (for example, "Employer Offers Health Insurance" corresponds to `minorTypeCode` `36`).                                      |
| `minorTypeCode`     | Number | Three-digit value that corresponds to `minorType`.                                                                                                                                                 |
| `details`           | String | Long description of `minorType`.                                                                                                                                                                   |
| `updated`           | String | Timestamp when the minimum wage record was last updated. This applies to any change to the record, not just rate changes.                                                                          |

### `normalizedAddress` object

| Element          | Type   | Description                                                                                                 |
| ---------------- | ------ | ----------------------------------------------------------------------------------------------------------- |
| `streetAddress1` | String | Normalized street address that conforms to USPS address standardization and is used for rate determination. |
| `city`           | String | City name of the normalized address (USPS standardization) used for rate determination.                     |
| `state`          | String | State abbreviation of the normalized address (USPS standardization) used for rate determination.            |
| `zipCode`        | String | ZIP code of the normalized address (USPS standardization) used for rate determination.                      |

### `normalizedCoordinates` object

| Element     | Type   | Description                                                                                                                               |
| ----------- | ------ | ----------------------------------------------------------------------------------------------------------------------------------------- |
| `longitude` | Number | Longitude of the normalized address used for rate determination. Returns `null` if `longitude` and `latitude` were passed in the request. |
| `latitude`  | Number | Latitude of the normalized address used for rate determination. Returns `null` if `longitude` and `latitude` were passed in the request.  |

### `rates` array

Contains an array of minimum wage rate objects. See [Minimum wage rate object](#minimum-wage-rate-object).

### `ratesPage` object

Returned from the `/mwf/v1/id` endpoint. Contains paginated minimum wage rate objects.

| Element            | Type    | Description                                                                                  |
| ------------------ | ------- | -------------------------------------------------------------------------------------------- |
| `content`          | Array   | One or more minimum wage rate objects.                                                       |
| `pageable`         | Object  | Metadata about the pagination collection, including the sort object.                         |
| `last`             | Boolean | `true` if this is the last page in the pagination collection.                                |
| `totalPages`       | Number  | Number of pages in the pagination collection.                                                |
| `totalElements`    | Number  | Number of minimum wage objects in the entire pagination collection.                          |
| `sort`             | Object  | Default sort order for MWF. This cannot be changed.                                          |
| `size`             | Number  | Maximum number of minimum wage objects returned per page. Set by `pageSize`.                 |
| `number`           | Number  | Page number in the collection. Set by `pageNumber`. The first page is always `pageNumber=0`. |
| `first`            | Boolean | `true` if this is the first page in the collection (`pageNumber = 0`).                       |
| `numberOfElements` | Number  | Number of minimum wage objects returned in this payload.                                     |
| `empty`            | Boolean | `true` when the `content` array is empty for that `pageNumber`.                              |

### `pageable` object

Returned from the `/mwf/v1/id` endpoint.

| Element         | Type    | Description                                                                                                                                                                           |
| --------------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `sort`          | Object  | Default sort for MWF: `/mwf/v1/id` is sorted by `state_code`, `authority_code`, `effective_date`; `/mwf/v1/location` is sorted by authority level (federal → state → county → local). |
| `sort.unsorted` | Boolean | Whether the collection is unsorted.                                                                                                                                                   |
| `sort.sorted`   | Boolean | Whether the collection is sorted.                                                                                                                                                     |
| `sort.empty`    | Boolean | Whether the sort definition is empty.                                                                                                                                                 |
| `offset`        | Number  | Record number of the first item in the current paginated result.                                                                                                                      |
| `pageNumber`    | Number  | Page number in the collection. Set by `pageNumber`.                                                                                                                                   |
| `pageSize`      | Number  | Maximum number of minimum wage objects returned per page. Set by `pageSize`.                                                                                                          |
| `unpaged`       | Boolean | Always `false`.                                                                                                                                                                       |
| `paged`         | Boolean | Always `true`.                                                                                                                                                                        |
