You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
Repository navigation
Commit d50f040
Browse filesBrowse the repository at this point in the historyBrowse files
Copy file name to clipboardExpand all lines: docs/llms-full.txt
+4-4Lines changed: 4 additions & 4 deletions
Original file line number
Diff line number
Diff line change
@@ -664,7 +664,7 @@ if (found instanceof ApiError || found instanceof TransportError) {
664
664
665
665
`ng-postcode-js/api` covers `lookup`, `autocomplete`, `reverse` and `nearby`. Each returns a plain `Request`, and `decode` turns a status and body into a typed result, so it works with any HTTP client. A request that cannot succeed, such as a level outside 1 to 5, an empty autocomplete or a coordinate that is not finite, throws `RangeError` before anything is sent.
666
666
667
-
The client refuses redirects, so the key is never sent to another host. Response fields keep the API's own names, such as `administrative_address`.
667
+
The client refuses redirects and a plain http base URL (except on this machine), so the key is never sent to another host or unencrypted. Response fields keep the API's own names, such as `administrative_address`.
668
668
669
669
Get a key from the [NIPOST developer dashboard](https://dashboard.postcode.gov.ng). Level 1 lookups confirm a code is assigned; levels 2 and up return address details and consume credits.
670
670
@@ -742,7 +742,7 @@ if (found instanceof Result.Ok<Lookup> ok) {
742
742
743
743
`Api` covers `lookup`, `autocomplete`, `reverse` and `nearby`. Each returns a plain `Request`, and `Api.decode` turns a status and body into a typed result, so it works with any HTTP client. A request that cannot succeed, such as a level outside 1 to 5, a blank autocomplete or a coordinate that is not finite, throws `IllegalArgumentException` before anything is sent.
744
744
745
-
The client never follows redirects, so the key is never sent to another host, and it gives up after 10 seconds. Fields the API may omit are `null`.
745
+
The client never follows redirects and refuses a plain http base URL (except on this machine), so the key is never sent to another host or unencrypted, and it gives up after 10 seconds. Fields the API may omit are `null`.
746
746
747
747
Get a key from the [NIPOST developer dashboard](https://dashboard.postcode.gov.ng). Level 1 lookups confirm a code is assigned; levels 2 and up return address details and consume credits.
748
748
@@ -835,7 +835,7 @@ Most clients take this entry in their MCP settings:
835
835
| `NG_POSTCODE_API_KEY` | none | NIPOST API key. Read from the environment only; never passed through tools. |
836
836
| `NG_POSTCODE_MAX_LEVEL` | `1` | Highest lookup level tools may request. Levels 2+ consume credits, so raise it deliberately. |
837
837
| `NG_POSTCODE_MAX_PAID_CALLS` | `25` | How many paid lookups one run of the server may make with its own key. |
838
-
| `NG_POSTCODE_BASE_URL` | `https://api.postcode.gov.ng` | Alternative API host, such as a staging stack. |
838
+
| `NG_POSTCODE_BASE_URL` | `https://api.postcode.gov.ng` | Alternative API host, such as a staging stack. Must be https, except on this machine. |
839
839
| `NG_GEOCODER_URL` | none | A Nominatim server `resolve_address` uses to place described addresses. Without it, only typed postcodes and location pins resolve. |
840
840
| `NG_GEOCODER_CONTACT` | none | A URL or email sent in the User-Agent. Required for the public Nominatim. |
Copy file name to clipboardExpand all lines: java/README.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -64,7 +64,7 @@ if (found instanceof Result.Ok<Lookup> ok) {
64
64
65
65
`Api` covers `lookup`, `autocomplete`, `reverse` and `nearby`. Each returns a plain `Request`, and `Api.decode` turns a status and body into a typed result, so it works with any HTTP client. A request that cannot succeed, such as a level outside 1 to 5, a blank autocomplete or a coordinate that is not finite, throws `IllegalArgumentException` before anything is sent.
66
66
67
-
The client never follows redirects, so the key is never sent to another host, and it gives up after 10 seconds. Fields the API may omit are `null`.
67
+
The client never follows redirects and refuses a plain http base URL (except on this machine), so the key is never sent to another host or unencrypted, and it gives up after 10 seconds. Fields the API may omit are `null`.
68
68
69
69
Get a key from the [NIPOST developer dashboard](https://dashboard.postcode.gov.ng). Level 1 lookups confirm a code is assigned; levels 2 and up return address details and consume credits.
Copy file name to clipboardExpand all lines: js/packages/ng-postcode-js/README.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -58,7 +58,7 @@ if (found instanceof ApiError || found instanceof TransportError) {
58
58
59
59
`ng-postcode-js/api` covers `lookup`, `autocomplete`, `reverse` and `nearby`. Each returns a plain `Request`, and `decode` turns a status and body into a typed result, so it works with any HTTP client. A request that cannot succeed, such as a level outside 1 to 5, an empty autocomplete or a coordinate that is not finite, throws `RangeError` before anything is sent.
60
60
61
-
The client refuses redirects, so the key is never sent to another host. Response fields keep the API's own names, such as `administrative_address`.
61
+
The client refuses redirects and a plain http base URL (except on this machine), so the key is never sent to another host or unencrypted. Response fields keep the API's own names, such as `administrative_address`.
62
62
63
63
Get a key from the [NIPOST developer dashboard](https://dashboard.postcode.gov.ng). Level 1 lookups confirm a code is assigned; levels 2 and up return address details and consume credits.
Copy file name to clipboardExpand all lines: mcp/README.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -79,7 +79,7 @@ Most clients take this entry in their MCP settings:
79
79
|`NG_POSTCODE_API_KEY`| none | NIPOST API key. Read from the environment only; never passed through tools. |
80
80
|`NG_POSTCODE_MAX_LEVEL`|`1`| Highest lookup level tools may request. Levels 2+ consume credits, so raise it deliberately. |
81
81
|`NG_POSTCODE_MAX_PAID_CALLS`|`25`| How many paid lookups one run of the server may make with its own key. |
82
-
|`NG_POSTCODE_BASE_URL`|`https://api.postcode.gov.ng`| Alternative API host, such as a staging stack. |
82
+
|`NG_POSTCODE_BASE_URL`|`https://api.postcode.gov.ng`| Alternative API host, such as a staging stack. Must be https, except on this machine. |
83
83
|`NG_GEOCODER_URL`| none | A Nominatim server `resolve_address` uses to place described addresses. Without it, only typed postcodes and location pins resolve. |
84
84
|`NG_GEOCODER_CONTACT`| none | A URL or email sent in the User-Agent. Required for the public Nominatim. |
85
85
|`NG_POSTCODE_TRANSPORT`|`stdio`|`http` serves streamable HTTP at `/mcp` instead. |
0 commit comments