# Get rate limit status for the authenticated user

From **GitHub v3 REST API**.

`GET /rate_limit`

**Note:** Accessing this endpoint does not count against your REST API rate limit.

**Note:** The `rate` object is deprecated. If you're writing new API client code or updating existing code, you should use the `core` object instead of the `rate` object. The `core` object contains the same information that is present in the `rate` object.

## Responses

### `200`

Response

#### Headers

##### `X-RateLimit-Limit`

- Type: `integer`

- Example: `5000`

##### `X-RateLimit-Remaining`

- Type: `integer`

- Example: `4999`

##### `X-RateLimit-Reset`

- Type: `integer`
- Format: `timestamp`

- Example: `1590701888`

### `application/json`

- Type: `object`

Rate Limit Overview

```json
{
  "rate": {
    "limit": 5000,
    "remaining": 4999,
    "reset": 1372700873,
    "used": 1
  },
  "resources": {
    "code_scanning_upload": {
      "limit": 500,
      "remaining": 499,
      "reset": 1551806725,
      "used": 1
    },
    "core": {
      "limit": 5000,
      "remaining": 4999,
      "reset": 1372700873,
      "used": 1
    },
    "graphql": {
      "limit": 5000,
      "remaining": 4993,
      "reset": 1372700389,
      "used": 7
    },
    "integration_manifest": {
      "limit": 5000,
      "remaining": 4999,
      "reset": 1551806725,
      "used": 1
    },
    "search": {
      "limit": 30,
      "remaining": 18,
      "reset": 1372697452,
      "used": 12
    }
  }
}
```

```json
{"description":"Rate Limit Overview","properties":{"rate":{"$ref":"#/components/schemas/rate-limit"},"resources":{"properties":{"actions_runner_registration":{"$ref":"#/components/schemas/rate-limit"},"code_scanning_upload":{"$ref":"#/components/schemas/rate-limit"},"core":{"$ref":"#/components/schemas/rate-limit"},"graphql":{"$ref":"#/components/schemas/rate-limit"},"integration_manifest":{"$ref":"#/components/schemas/rate-limit"},"scim":{"$ref":"#/components/schemas/rate-limit"},"search":{"$ref":"#/components/schemas/rate-limit"},"source_import":{"$ref":"#/components/schemas/rate-limit"}},"required":["core","search"],"type":"object"}},"required":["rate","resources"],"title":"Rate Limit Overview","type":"object"}
```

### `304`

Not modified

### `404`

Resource not found

### `application/json`

- Type: `object`

Basic Error

```json
{"description":"Basic Error","properties":{"documentation_url":{"type":"string"},"message":{"type":"string"},"status":{"type":"string"},"url":{"type":"string"}},"title":"Basic Error","type":"object"}
```

## Request examples

### cURL

```shell
curl --request GET \
  --url {protocol}://{hostname}/api/v3/rate_limit
```
