Skip to content

feat(API Key): Add monthly limits #282

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
cblanc merged 1 commit into from
Feb 4, 2026
Merged

feat(API Key): Add monthly limits #282

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
49 changes: 49 additions & 0 deletions dist/openapi.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4807,6 +4807,8 @@
"title": "Ireland ECAD Address",
"description": "The ECAD contains additional data for each ECAF address.",
"required": [
"dataset",
"ecad_id",
"organisation_id",
"address_point_id",
"building_id",
Expand Down Expand Up @@ -4926,6 +4928,7 @@
},
"post_county_id": {
"type": "string",
"nullable": true,
"description": "Post County ID",
"example": "10098783",
"maxLength": 10,
Expand Down Expand Up @@ -5068,6 +5071,7 @@
"title": "Ireland ECAF Address",
"description": "ECAF is the Eircode Address File which contains one record for each Postal Address. English language and Irish language versions are available. It is distributed as a flat file, details of data provision and updates are provided in section 2.",
"required": [
"dataset",
"ecaf_id"
],
"allOf": [
Expand Down Expand Up @@ -10756,6 +10760,32 @@
}
}
},
"ApiKeyMonthlyLimit": {
"title": "API Key Monthly Limit",
"type": "object",
"required": [
"limit",
"consumed"
],
"properties": {
"limit": {
"x-nullable": true,
"nullable": true,
"minimum": 0,
"example": 10000,
"type": "integer",
"description": "`number` or `null`. The monthly lookup limit currently set on your key.\n`null` means the limit is currently disabled.",
"format": "int32"
},
"consumed": {
"minimum": 0,
"example": 2500,
"type": "integer",
"description": "Number of lookups performed this month which count towards your monthly limit.",
"format": "int32"
}
}
},
"ApiKeyIndividualLimit": {
"title": "API Key Individual Limit",
"type": "object",
Expand Down Expand Up @@ -11055,6 +11085,7 @@
"required": [
"lookups_remaining",
"daily_limit",
"monthly_limit",
"individual_limit",
"allowed_urls",
"redact_days",
Expand All @@ -11074,6 +11105,9 @@
"daily_limit": {
"$ref": "#/components/schemas/ApiKeyDailyLimit"
},
"monthly_limit": {
"$ref": "#/components/schemas/ApiKeyMonthlyLimit"
},
"individual_limit": {
"$ref": "#/components/schemas/ApiKeyIndividualLimit"
},
Expand Down Expand Up @@ -11158,6 +11192,21 @@
}
}
},
"monthly_limit": {
"title": "Monthly Rate Limit",
"type": "object",
"properties": {
"limit": {
"x-nullable": true,
"nullable": true,
"minimum": 0,
"example": 10000,
"type": "integer",
"description": "`number` or `null`. The monthly lookup limit currently set on your key.\n`null` means the limit is currently disabled.",
"format": "int32"
}
}
},
"individual_limit": {
"title": "API Key Individual Limit",
"type": "object",
Expand Down
44 changes: 44 additions & 0 deletions dist/openapi.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4164,6 +4164,8 @@ components:
title: Ireland ECAD Address
description: The ECAD contains additional data for each ECAF address.
required:
- dataset
- ecad_id
- organisation_id
- address_point_id
- building_id
Expand Down Expand Up @@ -4269,6 +4271,7 @@ components:
minLength: 1
post_county_id:
type: string
nullable: true
description: Post County ID
example: '10098783'
maxLength: 10
Expand Down Expand Up @@ -4461,6 +4464,7 @@ components:
title: Ireland ECAF Address
description: ECAF is the Eircode Address File which contains one record for each Postal Address. English language and Irish language versions are available. It is distributed as a flat file, details of data provision and updates are provided in section 2.
required:
- dataset
- ecaf_id
allOf:
- $ref: '#/components/schemas/EircBase'
Expand Down Expand Up @@ -10208,6 +10212,29 @@ components:
type: integer
description: Number of lookups performed today which count towards your daily limit.
format: int32
ApiKeyMonthlyLimit:
title: API Key Monthly Limit
type: object
required:
- limit
- consumed
properties:
limit:
x-nullable: true
nullable: true
minimum: 0
example: 10000
type: integer
description: |-
`number` or `null`. The monthly lookup limit currently set on your key.
`null` means the limit is currently disabled.
format: int32
consumed:
minimum: 0
example: 2500
type: integer
description: Number of lookups performed this month which count towards your monthly limit.
format: int32
ApiKeyIndividualLimit:
title: API Key Individual Limit
type: object
Expand Down Expand Up @@ -10458,6 +10485,7 @@ components:
required:
- lookups_remaining
- daily_limit
- monthly_limit
- individual_limit
- allowed_urls
- redact_days
Expand All @@ -10474,6 +10502,8 @@ components:
format: int32
daily_limit:
$ref: '#/components/schemas/ApiKeyDailyLimit'
monthly_limit:
$ref: '#/components/schemas/ApiKeyMonthlyLimit'
individual_limit:
$ref: '#/components/schemas/ApiKeyIndividualLimit'
allowed_urls:
Expand Down Expand Up @@ -10537,6 +10567,20 @@ components:
`number` or `null`. The daily lookup limit currently set on your key.
`null` means the limit is currently disabled.
format: int32
monthly_limit:
title: Monthly Rate Limit
type: object
properties:
limit:
x-nullable: true
nullable: true
minimum: 0
example: 10000
type: integer
description: |-
`number` or `null`. The monthly lookup limit currently set on your key.
`null` means the limit is currently disabled.
format: int32
individual_limit:
title: API Key Individual Limit
type: object
Expand Down
32 changes: 31 additions & 1 deletion openapi.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2141,7 +2141,7 @@ export interface components {
* @description Post County ID
* @example 10098783
*/
post_county_id?: string;
post_county_id?: string | null;
/**
* @description NUA means "non-unique address".
*
Expand Down Expand Up @@ -2297,6 +2297,8 @@ export interface components {
/** @description An Post publicity post zone information. */
publicity_post_zone?: string;
} & {
dataset: unknown;
ecad_id: unknown;
organisation_id: unknown;
address_point_id: unknown;
building_id: unknown;
Expand Down Expand Up @@ -2342,6 +2344,7 @@ export interface components {
/** @description The unique identifier in the ECAF is the `ecaf_id`. This unique identifier allows each address in the ECAF to be uniquely identified. It can also be used as index once the data has been imported into a relational database. This is a numeric field that can store values from 0 to 2,147,483,647. It is represented as a number up to 10 digits long. All other fields in ECAF are alphanumeric. */
ecaf_id?: string;
} & {
dataset: unknown;
ecaf_id: unknown;
};
/**
Expand Down Expand Up @@ -6414,6 +6417,22 @@ export interface components {
*/
consumed: number;
};
/** API Key Monthly Limit */
ApiKeyMonthlyLimit: {
/**
* Format: int32
* @description `number` or `null`. The monthly lookup limit currently set on your key.
* `null` means the limit is currently disabled.
* @example 10000
*/
limit: number | null;
/**
* Format: int32
* @description Number of lookups performed this month which count towards your monthly limit.
* @example 2500
*/
consumed: number;
};
/** API Key Individual Limit */
ApiKeyIndividualLimit: {
/**
Expand Down Expand Up @@ -6642,6 +6661,7 @@ export interface components {
*/
lookups_remaining: number;
daily_limit: components["schemas"]["ApiKeyDailyLimit"];
monthly_limit: components["schemas"]["ApiKeyMonthlyLimit"];
individual_limit: components["schemas"]["ApiKeyIndividualLimit"];
/** @description A list of allowed URLs. An empty list means that allowed URLs are disabled. */
allowed_urls: string[];
Expand Down Expand Up @@ -6684,6 +6704,16 @@ export interface components {
*/
limit?: number | null;
};
/** Monthly Rate Limit */
monthly_limit?: {
/**
* Format: int32
* @description `number` or `null`. The monthly lookup limit currently set on your key.
* `null` means the limit is currently disabled.
* @example 10000
*/
limit?: number | null;
};
/** API Key Individual Limit */
individual_limit?: {
/**
Expand Down