Quickstart: list your deals - myAbode Deals Docs

This guide takes you from no key to a list of your brokerage’s deals.

1. Create a key

A brokerage admin creates keys in myAbode Deals:

Open your account menu (your name, bottom left) and choose Get API Keys.
Under your brokerage, choose Create service key, name it after what will use it (for example “Reporting dashboard”) and pick its scopes. For this guide, Read deals is enough.
Copy the key. It starts with mya_ and is shown once. Store it in a secrets manager, not in source code.

See Authentication and API keys for the kinds of key and what each scope allows.

2. List deals

export MYABODE_API_KEY=mya_your_key_here

curl "https://api.myabode.ca/v1/deals?limit=2" \
  -H "Authorization: Bearer $MYABODE_API_KEY"

3. Read the response

Lists come back in one envelope:

{
  "object": "list",
  "data": [
    {
      "object": "deal",
      "id": "q9lmv8ce5rlucyc0lljw0a4l",
      "status": "IN_PROGRESS",
      "deal_type": "urn:myabode:deal-type:res-listing-sale",
      "address": {
        "line1": "286 Harbour Street",
        "line2": null,
        "city": "Mississauga",
        "province": "ON",
        "postal_code": "L9N 4C0"
      },
      "mls_number": "W1234567",
      "sale_price": "1000000.00"
    }
  ],
  "has_more": true,
  "next_cursor": "eyJrIjpbIjIwMjYtMTItMDEi..."
}

The example is shortened. See List deals for every field. Amounts are strings with two decimals, so no precision is lost.

4. Filter and page

# Deals in processing, changed since November 1
curl "https://api.myabode.ca/v1/deals?status=IN_PROGRESS&updated_since=2026-11-01T00:00:00Z" \
  -H "Authorization: Bearer $MYABODE_API_KEY"

# The next page
curl "https://api.myabode.ca/v1/deals?cursor=eyJrIjpbIjIwMjYtMTItMDEi..." \
  -H "Authorization: Bearer $MYABODE_API_KEY"

Next