Skip to content
A PCA Predict API wrapper for Elixir.
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
config
lib
test
.gitignore
LICENSE
README.md
mix.exs
mix.lock

README.md

PCA Predict

A PCA Predict API wrapper for Elixir

Installation

If available in Hex, the package can be installed as:

  1. Add pca_predict to your list of dependencies in mix.exs:
```
def deps do
  [{:pca_predict, "~> 0.2.0"}]
end
```
  1. Ensure pca_predict is started before your application:
```
def application do
  [applications: [:pca_predict]]
end
```

Configuration

Obtain a PCA Predict API Key and assign it to a System ENV key of PCA_PREDICT_API_KEY.

Alternatively, add the following to your config.exs file:

config :pca_predict,
  api_key: System.get_env("PCA_PREDICT_API_KEY")

Usage

Lookup postcode (address)

Retrieve a list of address options by calling PCAPredict.AddressValidation.lookup\1

You can’t perform that action at this time.