> ## Documentation Index
> Fetch the complete documentation index at: https://docs.spaceport.xyz/llms.txt
> Use this file to discover all available pages before exploring further.

# Class: AgreementsQueryModule

[query/modules/agreements](../modules/query_modules_agreements).AgreementsQueryModule

Module for querying agreement data from The Graph

## Table of contents

#### Methods

* [getAgreements](#getagreements)
* [getAgreementById](#getagreementbyid)
* [getAgreementsByLicensee](#getagreementsbylicensee)
* [getAgreementsByLicensor](#getagreementsbylicensor)
* [getAgreementsByListing](#getagreementsbylisting)
* [getBindingAgreements](#getbindingagreements)

### constructor

• **new AgreementsQueryModule**(`queryClient`): [`AgreementsQueryModule`](./query/modules/agreements-query-module)

#### Parameters

| Name          | Type                           |
| :------------ | :----------------------------- |
| `queryClient` | [`QueryClient`](./query/query) |

#### Returns

[`AgreementsQueryModule`](./query/modules/agreements-query-module)

## Methods

### getAgreements

▸ **getAgreements**(`params?`, `filters?`): `Promise`\<[`AgreementsResponse`](../types/agreements-response)>

Get a list of agreements based on filtering and pagination parameters

#### Parameters

| Name      | Type                                             | Description           |
| :-------- | :----------------------------------------------- | :-------------------- |
| `params`  | [`PaginationParams`](../types/pagination-params) | Pagination parameters |
| `filters` | [`AgreementFilters`](../types/agreement-filters) | Filtering options     |

#### Returns

`Promise`\<[`AgreementsResponse`](../types/agreements-response)>

List of agreements with pagination info

### getAgreementById

▸ **getAgreementById**(`id`): `Promise`\<`null` | [`AgreementObject`](../types/agreement-object)>

Get a single agreement by its ID

#### Parameters

| Name | Type     | Description      |
| :--- | :------- | :--------------- |
| `id` | `string` | The agreement ID |

#### Returns

`Promise`\<`null` | [`AgreementObject`](../types/agreement-object)>

The agreement or null if not found

### getAgreementsByLicensee

▸ **getAgreementsByLicensee**(`licenseeAddress`, `params?`): `Promise`\<[`AgreementsResponse`](../types/agreements-response)>

Get all agreements for a specific licensee

#### Parameters

| Name              | Type                                             | Description           |
| :---------------- | :----------------------------------------------- | :-------------------- |
| `licenseeAddress` | \`0x\$\{string}\`                                | Licensee's address    |
| `params`          | [`PaginationParams`](../types/pagination-params) | Pagination parameters |

#### Returns

`Promise`\<[`AgreementsResponse`](../types/agreements-response)>

List of agreements with pagination info

### getAgreementsByLicensor

▸ **getAgreementsByLicensor**(`licensorAddress`, `params?`): `Promise`\<[`AgreementsResponse`](../types/agreements-response)>

Get all agreements for a specific licensor

#### Parameters

| Name              | Type                                             | Description           |
| :---------------- | :----------------------------------------------- | :-------------------- |
| `licensorAddress` | \`0x\$\{string}\`                                | Licensor's address    |
| `params`          | [`PaginationParams`](../types/pagination-params) | Pagination parameters |

#### Returns

`Promise`\<[`AgreementsResponse`](../types/agreements-response)>

List of agreements with pagination info

### getAgreementsByListing

▸ **getAgreementsByListing**(`listingId`, `params?`): `Promise`\<[`AgreementsResponse`](../types/agreements-response)>

Get all agreements for a specific listing

#### Parameters

| Name        | Type                                             | Description           |
| :---------- | :----------------------------------------------- | :-------------------- |
| `listingId` | `string`                                         | Listing ID            |
| `params`    | [`PaginationParams`](../types/pagination-params) | Pagination parameters |

#### Returns

`Promise`\<[`AgreementsResponse`](../types/agreements-response)>

List of agreements with pagination info

### getBindingAgreements

▸ **getBindingAgreements**(`params?`): `Promise`\<[`AgreementsResponse`](../types/agreements-response)>

Get all binding agreements (stage 4)

#### Parameters

| Name     | Type                                             | Description           |
| :------- | :----------------------------------------------- | :-------------------- |
| `params` | [`PaginationParams`](../types/pagination-params) | Pagination parameters |

#### Returns

`Promise`\<[`AgreementsResponse`](../types/agreements-response)>

List of binding agreements with pagination info