Documentation

curl "https://yepthere.au/v1/addresses?q=9+George+Street+Sydney&limit=5" \
  -H "x-api-key: $SESSIONAL_ADDRESSES_KEY"

// Attribution: display the G-NAF attribution line with published results.
import { Addresses } from './sdk/js/index.js';
const client = new Addresses({ apiKey: process.env.SESSIONAL_ADDRESSES_KEY, baseUrl: "https://yepthere.au" });
const response = await client.search('9 George Street Sydney', { limit: 5 });
console.log(response.results, response.rateLimit.remaining);

# Attribution: display the G-NAF attribution line with published results.
import os
from sessional_addresses import Addresses
client = Addresses(api_key=os.environ["SESSIONAL_ADDRESSES_KEY"], base_url="https://yepthere.au")
response = client.search("9 George Street Sydney", limit=5)
print(response.results, response.rate_limit.remaining)

curl "https://yepthere.au/v1/addresses?postcode=2000&limit=500" \
  -H "x-api-key: $SESSIONAL_ADDRESSES_KEY"

// Attribution: display the G-NAF attribution line with published results.
import { Addresses } from './sdk/js/index.js';
const client = new Addresses({ apiKey: process.env.SESSIONAL_ADDRESSES_KEY, baseUrl: "https://yepthere.au" });
const response = await client.byPostcode('2000', { limit: 500 });
console.log(response.results, response.rateLimit.remaining);

# Attribution: display the G-NAF attribution line with published results.
import os
from sessional_addresses import Addresses
client = Addresses(api_key=os.environ["SESSIONAL_ADDRESSES_KEY"], base_url="https://yepthere.au")
response = client.by_postcode("2000", limit=500)
print(response.results, response.rate_limit.remaining)

curl "https://yepthere.au/v1/addresses/GANSW718028803" \
  -H "x-api-key: $SESSIONAL_ADDRESSES_KEY"

// Attribution: display the G-NAF attribution line with published results.
import { Addresses } from './sdk/js/index.js';
const client = new Addresses({ apiKey: process.env.SESSIONAL_ADDRESSES_KEY, baseUrl: "https://yepthere.au" });
const response = await client.get('GANSW718028803');
console.log(response.results, response.rateLimit.remaining);

# Attribution: display the G-NAF attribution line with published results.
import os
from sessional_addresses import Addresses
client = Addresses(api_key=os.environ["SESSIONAL_ADDRESSES_KEY"], base_url="https://yepthere.au")
response = client.get("GANSW718028803")
print(response.results, response.rate_limit.remaining)

curl "https://yepthere.au/v1/nearest?lat=-33.8658&lng=151.2070" \
  -H "x-api-key: $SESSIONAL_ADDRESSES_KEY"

// Attribution: display the G-NAF attribution line with published results.
import { Addresses } from './sdk/js/index.js';
const client = new Addresses({ apiKey: process.env.SESSIONAL_ADDRESSES_KEY, baseUrl: "https://yepthere.au" });
const response = await client.nearest(-33.8658, 151.2070);
console.log(response.results, response.rateLimit.remaining);

# Attribution: display the G-NAF attribution line with published results.
import os
from sessional_addresses import Addresses
client = Addresses(api_key=os.environ["SESSIONAL_ADDRESSES_KEY"], base_url="https://yepthere.au")
response = client.nearest(-33.8658, 151.2070)
print(response.results, response.rate_limit.remaining)

curl "https://yepthere.au/v1/postcodes/3000" \
  -H "x-api-key: $SESSIONAL_ADDRESSES_KEY"

// Attribution: display the G-NAF attribution line with published results.
import { Addresses } from './sdk/js/index.js';
const client = new Addresses({ apiKey: process.env.SESSIONAL_ADDRESSES_KEY, baseUrl: "https://yepthere.au" });
const response = await client.postcode('3000');
console.log(response.results, response.rateLimit.remaining);

# Attribution: display the G-NAF attribution line with published results.
import os
from sessional_addresses import Addresses
client = Addresses(api_key=os.environ["SESSIONAL_ADDRESSES_KEY"], base_url="https://yepthere.au")
response = client.postcode("3000")
print(response.results, response.rate_limit.remaining)

curl "https://yepthere.au/v1/postcodes?q=melbourne" \
  -H "x-api-key: $SESSIONAL_ADDRESSES_KEY"

// Attribution: display the G-NAF attribution line with published results.
import { Addresses } from './sdk/js/index.js';
const client = new Addresses({ apiKey: process.env.SESSIONAL_ADDRESSES_KEY, baseUrl: "https://yepthere.au" });
const response = await client.searchPostcodes('melbourne');
console.log(response.results, response.rateLimit.remaining);

# Attribution: display the G-NAF attribution line with published results.
import os
from sessional_addresses import Addresses
client = Addresses(api_key=os.environ["SESSIONAL_ADDRESSES_KEY"], base_url="https://yepthere.au")
response = client.search_postcodes("melbourne")
print(response.results, response.rate_limit.remaining)

curl "https://yepthere.au/v1/boundaries/lga/17200" \
  -H "x-api-key: $SESSIONAL_ADDRESSES_KEY"

// Attribution: display the G-NAF attribution line with published results.
import { Addresses } from './sdk/js/index.js';
const client = new Addresses({ apiKey: process.env.SESSIONAL_ADDRESSES_KEY, baseUrl: "https://yepthere.au" });
const response = await client.boundaries('poa', '2000');
console.log(response.results, response.rateLimit.remaining);

# Attribution: display the G-NAF attribution line with published results.
import os
from sessional_addresses import Addresses
client = Addresses(api_key=os.environ["SESSIONAL_ADDRESSES_KEY"], base_url="https://yepthere.au")
response = client.boundaries("poa", "2000")
print(response.results, response.rate_limit.remaining)

curl -X POST "https://yepthere.au/v1/parse" \
  -H "x-api-key: $SESSIONAL_ADDRESSES_KEY" \
  -H "content-type: application/json" \
  -d '{"q":"unit 3/42 wallaby way syd 2000","limit":3}'

// Attribution: display the G-NAF attribution line with published results.
import { Addresses } from './sdk/js/index.js';
const client = new Addresses({ apiKey: process.env.SESSIONAL_ADDRESSES_KEY, baseUrl: "https://yepthere.au" });
const response = await client.parse('unit 3/42 wallaby way syd 2000', { limit: 3 });
console.log(response.results, response.rateLimit.remaining);

# Attribution: display the G-NAF attribution line with published results.
import os
from sessional_addresses import Addresses
client = Addresses(api_key=os.environ["SESSIONAL_ADDRESSES_KEY"], base_url="https://yepthere.au")
response = client.parse("unit 3/42 wallaby way syd 2000", limit=3)
print(response.results, response.rate_limit.remaining)

curl -X POST "https://yepthere.au/v1/addresses/bulk" \
  -H "x-api-key: $SESSIONAL_ADDRESSES_KEY" \
  -H "content-type: application/json" \
  -d '{"queries":[{"q":"1 george st sydney"},{"q":"42 wallaby way"}]}'

// Attribution: display the G-NAF attribution line with published results.
import { Addresses } from './sdk/js/index.js';
const client = new Addresses({ apiKey: process.env.SESSIONAL_ADDRESSES_KEY, baseUrl: "https://yepthere.au" });
const response = await client.bulk([{ q: '1 george st sydney' }, { q: '42 wallaby way' }]);
console.log(response.results, response.rateLimit.remaining);

# Attribution: display the G-NAF attribution line with published results.
import os
from sessional_addresses import Addresses
client = Addresses(api_key=os.environ["SESSIONAL_ADDRESSES_KEY"], base_url="https://yepthere.au")
response = client.bulk([{"q": "1 george st sydney"}, {"q": "42 wallaby way"}])
print(response.results, response.rate_limit.remaining)

curl -X POST "https://yepthere.au/v1/jobs" \
  -H "x-api-key: $SESSIONAL_ADDRESSES_KEY" \
  -H "content-type: text/csv" -H "x-job-column: address" \
  --data-binary @addresses.csv

// Jobs accept raw CSV and return job objects. The SDK jobs.submit and jobs.get methods use the same contract.
import { readFile } from 'node:fs/promises';
const response = await fetch("https://yepthere.au/v1/jobs", {
  method: 'POST',
  headers: { 'x-api-key': process.env.SESSIONAL_ADDRESSES_KEY, 'content-type': 'text/csv', 'x-job-column': 'address' },
  body: await readFile('addresses.csv')
});
const data = await response.json();
if (response.ok === false) throw new Error(data.message || 'Request failed');
console.log(data);

# Jobs accept raw CSV and return job objects. The SDK jobs.submit and jobs.get methods use the same contract.
import json
import os
from pathlib import Path
from urllib.request import Request, urlopen
request = Request("https://yepthere.au/v1/jobs", method="POST",
    headers={"User-Agent": "yepthere-python/0.1.0 (+https://yepthere.au)", "x-api-key": os.environ["SESSIONAL_ADDRESSES_KEY"], "Content-Type": "text/csv", "x-job-column": "address"},
    data=Path("addresses.csv").read_bytes())
with urlopen(request, timeout=30) as response:
    print(json.load(response))

curl "https://yepthere.au/v1/jobs/job_example" \
  -H "x-api-key: $SESSIONAL_ADDRESSES_KEY"

// Jobs accept raw CSV and return job objects. The SDK jobs.submit and jobs.get methods use the same contract.
const response = await fetch("https://yepthere.au/v1/jobs/job_example", {
  method: 'GET',
  headers: { 'x-api-key': process.env.SESSIONAL_ADDRESSES_KEY }
});
const data = await response.json();
if (response.ok === false) throw new Error(data.message || 'Request failed');
console.log(data);

# Jobs accept raw CSV and return job objects. The SDK jobs.submit and jobs.get methods use the same contract.
import json
import os
from urllib.request import Request, urlopen
request = Request("https://yepthere.au/v1/jobs/job_example", method="GET",
    headers={"User-Agent": "yepthere-python/0.1.0 (+https://yepthere.au)", "x-api-key": os.environ["SESSIONAL_ADDRESSES_KEY"]})
with urlopen(request, timeout=30) as response:
    print(json.load(response))

curl --location "https://yepthere.au/v1/jobs/job_example/download" \
  -H "Authorization: Bearer $SESSIONAL_ADDRESSES_KEY"

import { Addresses } from './sdk/js/index.js';
const client = new Addresses({ apiKey: process.env.SESSIONAL_ADDRESSES_KEY, baseUrl: "https://yepthere.au" });
const stream = await client.jobs.download('job_example');
console.log(await new Response(stream).text());

import os
from pathlib import Path
from sessional_addresses import Addresses
client = Addresses(api_key=os.environ["SESSIONAL_ADDRESSES_KEY"], base_url="https://yepthere.au")
Path("results.csv").write_bytes(client.jobs.download("job_example"))

curl "https://yepthere.au/v1/jobs" \
  -H "x-api-key: $SESSIONAL_ADDRESSES_KEY"

// Jobs accept raw CSV and return job objects. The SDK jobs.submit and jobs.get methods use the same contract.
const response = await fetch("https://yepthere.au/v1/jobs", {
  method: 'GET',
  headers: { 'x-api-key': process.env.SESSIONAL_ADDRESSES_KEY }
});
const data = await response.json();
if (response.ok === false) throw new Error(data.message || 'Request failed');
console.log(data);

# Jobs accept raw CSV and return job objects. The SDK jobs.submit and jobs.get methods use the same contract.
import json
import os
from urllib.request import Request, urlopen
request = Request("https://yepthere.au/v1/jobs", method="GET",
    headers={"User-Agent": "yepthere-python/0.1.0 (+https://yepthere.au)", "x-api-key": os.environ["SESSIONAL_ADDRESSES_KEY"]})
with urlopen(request, timeout=30) as response:
    print(json.load(response))

curl "https://yepthere.au/health"

// Use HTTP here: the vendored clients have no method for this endpoint.
const response = await fetch("https://yepthere.au/health", {
  method: 'GET',
  headers: { }
});
const data = await response.json();
if (response.ok === false) throw new Error(data.message || 'Request failed');
console.log(data);

# Use HTTP here: the vendored clients have no method for this endpoint.
import json
from urllib.request import Request, urlopen
request = Request("https://yepthere.au/health", method="GET",
    headers={"User-Agent": "yepthere-python/0.1.0 (+https://yepthere.au)"})
with urlopen(request, timeout=30) as response:
    print(json.load(response))

curl "https://yepthere.au/ready"

// Use HTTP here: the vendored clients have no method for this endpoint.
const response = await fetch("https://yepthere.au/ready", {
  method: 'GET',
  headers: { }
});
const data = await response.json();
if (response.ok === false) throw new Error(data.message || 'Request failed');
console.log(data);

# Use HTTP here: the vendored clients have no method for this endpoint.
import json
from urllib.request import Request, urlopen
request = Request("https://yepthere.au/ready", method="GET",
    headers={"User-Agent": "yepthere-python/0.1.0 (+https://yepthere.au)"})
with urlopen(request, timeout=30) as response:
    print(json.load(response))