Associations Endpoints
Description of endpoints used in querying for associations
User Associations
Get user association by ID
GET
/api/v0/user-associations/{{ associationID }}
Retrieve a single user association by ID.
Path Parameters
Name | Type | Description |
---|---|---|
associationID* | string | The identifier of the association to retrieve |
Count user associations
POST
/api/v0/user-associations/count
Count the number of user associations matching the provided query parameters.
Request Body
Name | Type | Description |
---|---|---|
TransactorPublicKeyBase58Check | string | The public key of the user who created the association |
TargetUserPublicKeyBase58Check | string | The public key of the user to whom the association references |
AppPublicKeyBase58Check | string | The public key of the application on which the association was created |
AssociationType | string | The association type (exact match) |
AssociationTypePrefix | string | The prefix of the association type (wildcard match) |
AssociationValue | string | The association value (exact match) |
AssociationValuePrefix | string | The prefix of the association value (wildcard match) |
Count user associations by multiple values
POST
/api/v0/user-associations/counts
Count the number of user associations matching the provided query. Here, you can provide an array of association values and the count of associations matching any in that list will be returned.
Request Body
Name | Type | Description |
---|---|---|
TransactorPublicKeyBase58Check | string | The public key of the user who created the association |
TargetUserPublicKeyBase58Check | string | The public key of the user to whom the association references |
AssociationType* | string | The association type (exact match) |
AssociationValues* | []string | An array of association values |
AppPublicKeyBase58Check | string | The public key of the application on which the association was created |
Query for user associations
POST
/api/v0/user-associations/query
Retrieve user associations matching the provided query parameters.
Request Body
Name | Type | Description |
---|---|---|
TransactorPublicKeyBase58Check | string | The public key of the user who created the association |
TargetUserPublicKeyBase58Check | string | The public key of the user to whom the association references |
AssociationType | string | The association type (exact match) |
AssociationTypePrefix | string | The prefix of the association type (wildcard match) |
AssociationValue | string | The association value (exact match) |
AssociationValuePrefix | string | The prefix of the association value (wildcard match) |
Limit | integer | The maximum number of associations to retrieve (default is 100) |
LastSeenAssociationID | string | The identifier of the last retrieved association; this parameter functions like an offset allowing users to paginate through results |
SortDescending | boolean | If true, results are returned in reverse order |
IncludeTransactorProfile | boolean | If true, include the transactors' user profiles in the response |
IncludeTargetUserProfile | boolean | If true, include the target users' profiles in the response |
IncludeAppProfile | boolean | If true, include the applications' user profiles in the response |
AssociationValues | []string | An array of association values; associations matching any of the values in this list will be returned |
AppPublicKeyBase58Check | string | The public key of the application on which the association was created |
Post Associations
Get post association by ID
GET
/api/v0/post-associations/{{ associationID }}
Retrieve a single post association by ID.
Path Parameters
Name | Type | Description |
---|---|---|
associationID* | string | The identifier of the association to retrieve |
Count post associations
POST
/api/v0/post-associations/count
Count the number of post associations matching the provided query parameters.
Request Body
Name | Type | Description |
---|---|---|
TransactorPublicKeyBase58Check | string | The public key of the user who created the association |
PostHashHex | string | The identifier of the post to which the association references |
AppPublicKeyBase58Check | string | The public key of the application on which the association was created |
AssociationType | string | The association type (exact match) |
AssociationTypePrefix | string | The prefix of the association type (wildcard match) |
AssociationValue | string | The association value (exact match) |
AssociationValuePrefix | string | The prefix of the association value (wildcard match) |
Count post associations by multiple values
POST
/api/v0/post-associations/counts
Count the number of post associations matching the provided query. Here, you can provide an array of association values and the count of associations matching any in that list will be returned.
Request Body
Name | Type | Description |
---|---|---|
TransactorPublicKeyBase58Check | string | The public key of the user who created the association |
PostHashHex | string | The identifier of the post to which this association references |
AppPublicKeyBase58Check | string | The public key of the application on which this association was created |
AssociationType* | string | The association type (exact match) |
AssociationValues* | []string | An array of association values |
Query for post associations
POST
/api/v0/post-associations/query
Retrieve post associations matching the provided query parameters.
Request Body
Name | Type | Description |
---|---|---|
TransactorPublicKeyBase58Check | string | The public key of the user who created the association |
PostHashHex | string | The identifier of the post to which this association references |
AppPublicKeyBase58Check | string | The public key of the application on which this association was created |
AssociationType | string | The association type (exact match) |
AssociationTypePrefix | string | The prefix of the association type (wildcard match) |
AssociationValue | string | The association value (exact match) |
AssociationValuePrefix | string | The prefix of the association value (wildcard match) |
AssociationValues | []string | An array of association values; associations matching any of the values in this list will be returned |
Limit | integer | The maximum number of associations to retrieve (default is 100) |
LastSeenAssociationID | string | The identifier of the last retrieved association; this parameter functions like an offset allowing users to paginate through results |
SortDescending | boolean | If true, results are returned in reverse order |
IncludeTransactorProfile | boolean | If true, include the transactors' use profiles in the response |
IncludePostEntry | boolean | If true, include the target posts' entries in the response |
IncludePostAuthorProfile | boolean | If true, include the target posts' authors' user profiles in the response |
IncludeAppProfile | boolean | If true, include the applications' user profiles in the response |
Last updated