Get Allocation by ID

Retrieve an allocation by allocation ID.

Use the Prime SDK or CLI to test this endpoint by following the quickstart guide and running with the following examples

Java

AllocationsService allocationsService = PrimeServiceFactory.createAllocationsService(client);

GetAllocationRequest request = new GetAllocationRequest.Builder("PORTFOLIO_ID_HERE", "ALLOCATION_ID_HERE").build();

GetAllocationResponse response = allocationsService.getAllocation(request);

For more information, please visit the Prime Java SDK.

AllocationsService allocationsService = PrimeServiceFactory.createAllocationsService(client);

GetAllocationRequest request = new GetAllocationRequest.Builder("PORTFOLIO_ID_HERE", "ALLOCATION_ID_HERE").build();

GetAllocationResponse response = allocationsService.getAllocation(request);

For more information, please visit the Prime Java SDK.

var allocationsService = new AllocationsService(client);

var request = new GetAllocationRequest("PORTFOLIO_ID_HERE", "ALLOCATION_ID_HERE");
var response = allocationsService.GetAllocation(request);

For more information, please visit the Prime .NET SDK.

allocationsService := allocations.NewAllocationsService(client)

request := &allocations.GetPortfolioAllocationRequest{
    PortfolioId:  "PORTFOLIO_ID_HERE",
    AllocationId: "ALLOCATION_ID_HERE",
}

response, err := allocationsService.GetPortfolioAllocation(context.Background(), request)

For more information, please visit the Prime Go SDK.

prime_client = PrimeClient(credentials)

request = GetAllocationByIdRequest(
        portfolio_id="PORTFOLIO_ID_HERE",
        allocation_id="ALLOCATION_ID_HERE",
)

response = prime_client.get_allocation_by_id(request)

For more information, please visit the Prime Python SDK.

primectl get-allocation --help

For more information, please visit the Prime CLI.

const allocationService = new AllocationService(client);

allocationService.getAllocation({
    allocationId: "ALLOCATION_ID_HERE",
    portfolioId: "PORTFOLIO_ID_HERE"
}).then(async (response) => {
    console.log('Allocation: ', response);
})

For more information, please visit the Prime TS SDK.

Path Parameters

portfolio_id · string · required

The portfolio ID of the allocation

allocation_id · string · required

The ID of the allocation

Response

200 - application/json

A successful response.

The response is of type object.