Returns private data on the key including remaining lookups, available datasets and usage limits.
643 matches
26 actions
API Reference - Ideal Postcodes
26 actions
- AvailabilityGETv1.0.0
- CancelDELETEv1.0.0
- CleansePOSTv1.0.0
- CreatePOSTv1.0.0
- CreatePOSTv1.0.0
- DeleteDELETEv1.0.0
- DetailsGETv1.0.0
- Email ValidationGETv1.0.0
- Extract AddressesGETv1.0.0
- Find AddressGETv1.0.0
- Find PlaceGETv1.0.0
- ListGETv1.0.0
- ListGETv1.0.0
- Logs (CSV)GETv1.0.0
- Lookup PostcodeGETv1.0.0
- Phone Number ValidationGETv1.0.0
- Resolve Address (GBR)GETv1.0.0
- Resolve Address (USA)GETv1.0.0
- Resolve PlaceGETv1.0.0
- RetrieveGETv1.0.0
- RetrieveGETv1.0.0
- Retrieve by UDPRNGETv1.0.0
- Retrieve by UMPRNGETv1.0.0
- UpdatePOSTv1.0.0
- UpdatePUTv1.0.0
- Usage StatsGETv1.0.0
Other/API Reference - Ideal Postcodes
Details
v1.0.0Input
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
- 13
- 14
- 15
- 16
- 17
{
"type": "object",
"properties": {
"key": {
"type": "string",
"description": "Your API Key. Typically beings `ak_`.\n\nAvailable from your dashboard\n"
},
"user_token": {
"type": "string",
"description": "A secret key used for sensitive operations on your account and API Keys.\n\nYour user token can be retrieved and managed from your [accounts page](https://ideal-postcodes.co.uk/account).\n\nTypically beings `uk_...`\n"
}
},
"required": [
"key"
],
"additionalProperties": false
}Output
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
- 13
- 14
- 15
- 16
- 17
- 18
- 19
- 20
- 21
- 22
- 23
- 24
- 25
- 26
- 27
- 28
- 29
- 30
- 31
- 32
- 33
- 34
- 35
- 36
- 37
- 38
- 39
- 40
- 41
- 42
- 43
- 44
- 45
- 46
- 47
- 48
- 49
- 50
- 51
- 52
- 53
- 54
- 55
- 56
- 57
- 58
- 59
- 60
- 61
- 62
- 63
- 64
- 65
- 66
- 67
- 68
- 69
- 70
- 71
- 72
- 73
- 74
- 75
- 76
- 77
- 78
- 79
- 80
- 81
- 82
- 83
- 84
- 85
- 86
- 87
- 88
- 89
- 90
- 91
- 92
- 93
- 94
- 95
- 96
- 97
- 98
- 99
- 100
- 101
- 102
- 103
- 104
- 105
- 106
- 107
- 108
- 109
- 110
- 111
- 112
- 113
- 114
- 115
- 116
- 117
- 118
- 119
- 120
- 121
- 122
- 123
- 124
- 125
- 126
- 127
- 128
- 129
- 130
- 131
- 132
- 133
- 134
- 135
- 136
- 137
- 138
- 139
- 140
- 141
- 142
- 143
- 144
- 145
- 146
- 147
- 148
- 149
- 150
- 151
- 152
- 153
- 154
- 155
- 156
- 157
- 158
- 159
- 160
- 161
- 162
- 163
- 164
- 165
- 166
- 167
- 168
- 169
- 170
- 171
- 172
- 173
- 174
- 175
- 176
- 177
- 178
- 179
- 180
- 181
- 182
- 183
- 184
- 185
- 186
- 187
- 188
- 189
- 190
- 191
- 192
- 193
{
"type": "object",
"required": [
"code",
"message",
"result"
],
"properties": {
"code": {
"type": "integer",
"format": "int32",
"enum": [
2000
]
},
"message": {
"type": "string",
"enum": [
"Success"
]
},
"result": {
"type": "object",
"required": [
"allowed_urls",
"automated_topups",
"current_purchases",
"daily_limit",
"individual_limit",
"lookups_remaining",
"notificatinos"
],
"properties": {
"allowed_urls": {
"type": "array",
"description": "A list of allowed URLs. An empty list means that allowed URLs are disabled.",
"items": {
"type": "string"
}
},
"automated_topups": {
"type": "object",
"description": "Automated topup status",
"required": [
"enabled"
],
"properties": {
"enabled": {
"type": "boolean",
"description": "Indicates whether automated top-ups are enabled"
}
}
},
"current_purchases": {
"type": "array",
"description": "Current balance purchases attached to key.",
"items": {
"type": "object",
"required": [
"expires",
"purchased",
"consumed"
],
"properties": {
"consumed": {
"type": "integer",
"format": "int32",
"description": "Number of consumed lookups off this purchase."
},
"expires": {
"type": "string",
"description": "`string` or `null` The date when this purchase will expire in simplified \nextended ISO format (ISO 8601). This is typically 365 days from the time \nof first use. This field will be `null` if the purchase has not yet been \nused."
},
"purchased": {
"type": "integer",
"format": "int32",
"description": "Number of procured lookups from this purchase."
}
}
}
},
"daily_limit": {
"type": "object",
"required": [
"consumed",
"limit"
],
"properties": {
"consumed": {
"type": "integer",
"format": "int32",
"description": "Number of lookups performed today which count towards your daily limit."
},
"limit": {
"type": "integer",
"format": "int32",
"description": "`number` or `null`. The daily lookup limit currently set on your key. \n`null` means the limit is currently disabled."
}
}
},
"datasets": {
"type": "object",
"description": "Indicates which datasets are available and added by default to the address responses",
"required": [
"ecad",
"ecaf",
"mr",
"nyb",
"paf",
"pafa",
"pafw",
"usps"
],
"properties": {
"ecad": {
"type": "boolean",
"description": "IE Address File. Eircode Address Database"
},
"ecaf": {
"type": "boolean",
"description": "IE Base Address File. Eircode Address File"
},
"herewe": {
"type": "boolean",
"description": "Western Europe Address File"
},
"mr": {
"type": "boolean",
"description": "UK Multiple Residence Dataset"
},
"nyb": {
"type": "boolean",
"description": "UK Not Yet Built Dataset"
},
"paf": {
"type": "boolean",
"description": "UK Main Address File (Postcode Address File)"
},
"pafa": {
"type": "boolean",
"description": "UK Property Alias dataset"
},
"pafw": {
"type": "boolean",
"description": "UK Welsh Language Dataset"
},
"usps": {
"type": "boolean",
"description": "US Address Dataset"
}
}
},
"individual_limit": {
"type": "object",
"required": [
"limit"
],
"properties": {
"limit": {
"type": "integer",
"format": "int32",
"description": "`number` or `null` Limit set on the number of lookups that can be \nperformed from a single IP address. `null` means the limit is currently \ndisabled."
}
}
},
"lookups_remaining": {
"type": "integer",
"format": "int32"
},
"notifications": {
"type": "object",
"required": [
"emails",
"enabled"
],
"properties": {
"emails": {
"type": "array",
"description": "A list of email addresses designated by you to receive notifications about this key.",
"items": {
"type": "string"
}
},
"enabled": {
"type": "boolean",
"description": "Indicates whether email notifications are enabled."
}
}
}
}
}
}
}