Light mode version of Land Your Home
V1Chains

Get Chains

GET
/v1/chains

Happy path: the chains the user is in, with their links and a summary of each transaction.

Pagination: limit (1-100, default 25) and cursor (an opaque nextCursor from a previous response; null when there are no more pages). Results are newest-updated first. Responses are { "data": [...], "nextCursor": "..." | null }.

Required variables:

  • baseUrl
  • apiKey (needs chains:read)
  • userToken

Authorization

bearerAuth userTokenAuth
AuthorizationBearer <token>

Partner API key (lyh_...): identifies the calling partner, its scopes and rate limit.

In: header

X-User-Token<token>

The user's OAuth 2.1 access token, issued by Land Your Home's OAuth server to this partner's OAuth client. Requests run as this user.

In: header

Query Parameters

limit?string
cursor?string

Response Body

application/json

application/json

application/json

curl -X GET "https://example.com/v1/chains"
{  "data": [    {      "id": "497307d5-5d0f-4be5-94e4-6a4014631ade",      "updatedAt": "2026-10-02T08:36:26.062403+00:00",      "links": [        {          "id": "39be39f6-b56a-49a8-aed0-dc764c82cdb5",          "transactionId": "ea6a1112-5f32-4f6a-ac20-fa0b2b55b67f",          "dependencyId": "d8a7f0c1-f280-44cc-953a-7057ad310e19"        },        {          "id": "4511315d-8408-4cdc-8a38-e1e9a61b8e29",          "transactionId": "b939a7de-a264-4855-b37d-d9721cea8797",          "dependencyId": "ab17111b-bc1d-4406-a394-95ab242d0fc5"        }      ],      "transactions": [        {          "id": "169450c9-05d2-400f-b7df-0ff03a94c309",          "updatedAt": "2026-10-02T08:36:26.062403+00:00",          "saleState": "off-market",          "status": null,          "yourRole": null,          "address": {            "line1": "34 CHESTNUT CLOSE",            "line2": "",            "city": "LIVERPOOL",            "region": "MERSEYSIDE",            "postcode": "L18 1JD",            "country": "GB"          }        },        {          "id": "63ce9781-1e03-46b2-aefb-c369d9911fe7",          "updatedAt": "2026-10-02T08:36:26.062403+00:00",          "saleState": "for-sale-sold-stc",          "status": null,          "yourRole": null,          "address": {            "line1": "17 SYCAMORE LANE",            "line2": "",            "city": "NOTTINGHAM",            "region": "NOTTINGHAMSHIRE",            "postcode": "NG7 2EG",            "country": "GB"          }        }      ]    }  ],  "nextCursor": "eyJ1IjoiMjAyNi0xMC0wMlQwODozNjoyNi4wNjI0MDMrMDA6MDAiLCJpIjoiNDk3MzA3ZDUtNWQwZi00YmU1LTk0ZTQtNmE0MDE0NjMxYWRlIn0"}

Get Chain

Happy path: one chain. yourRole/yourPermissions are only set on transactions the user is a party to.

Post Chain

Creates a chain with the user's transaction(s). selling makes the user the Seller of that property, buying makes them the Buyer (selling + buying links the purchase to the sale); or send thirdParty ({ role, representing, property }) on its own to join as, for example, an agent.