SWFIAPI DocumentationManaged AUM
top

Managed AUM

Get historical managed assets for entities.

Retrieve all managed aum records

Retrieve a list of managed aum periods based on your query parameters.

Get/aum-managed

Query Parameters

before_created_at
TYPEstring
Restrict the response to managed AUM records created before the set time.
after_created_at
TYPEstring
Restrict the response to managed AUM records created after the set time.
before_updated_at
TYPEstring
Restrict the response to managed AUM records updated before the set time.
after_updated_at
TYPEstring
Restrict the response to managed AUM records updated after the set time.
before_period
TYPEstring
Restrict the response to managed AUM records before the set time
after_period
TYPEstring
Restrict the response to managed AUM records after the set time
assets_gte
TYPEinteger
Restrict the response to managed AUM periods where the assets field is greater than or equal to the value provided.
assets_lte
TYPEinteger
Restrict the response to managed AUM periods where the assets field is less than or equal to the value provided.
entity_id
TYPEstring
Restrict the response to AUM periods that match a valid entity_id.
limit
TYPEinteger
The number of records to return. Default value is 10. Maximum value is 100.
offset
TYPEinteger
Used for pagination, this is the number of records from a collection to skip. Default value is 0.
sort_field
TYPEstring
Returns files sorted by the specified field. Possible values: "period", "created_at", and "updated_at". Default sort is "created_at".
sort_dir
TYPEstring
Determines the order direction for sorted results. Possible values: "ASC" or "DESC". Default is "DESC".
List Managed AUM
curl -v -X GET https://api.swfi.com/v1/aum-managed?before_created_at=2022-10-17&after_created_at=2022-10-12&before_updated_at=2022-10-17&after_updated_at=2022-10-12&before_period=2022-10-17&after_period=2022-10-12&assets_gte=50000000&assets_lte=70000000&entity_id=598cdaa60124e9fd2d05bdc4&limit=10&offset=0&sort_field=period&sort_dir=ASC \ 
-H "Accept: application/json" \ 
-H "Authorization: $API_KEY"

Success Response

HTTP Status 200
data
TYPEobject[]
An array of managed AUM records.
total_items
TYPEinteger
The total number of items matching the query regardless of pagination.
Example response
{
  "data": [
    {
      "_id": "6349221bdc82486491e2dcaf",
      "entity_id": "598cdaa50124e9fd2d05aa5d",
      "currency": "USD",
      "period": "2021-09-01T00:00:00.000Z",
      "assets": 9463662000000,
      "assets_native": 9463662000000,
      "assets_defined_contribution": "",
      "assets_defined_contribution_native": "",
      "created_at": "2022-10-14T08:47:23.057Z",
      "updated_at": ""
    },
    {
      "_id": "634921f3ec44894c7619464e",
      "entity_id": "598cdaa50124e9fd2d05aa5d",
      "currency": "USD",
      "period": "2022-09-01T00:00:00.000Z",
      "assets": 7961373000000,
      "assets_native": 7961373000000,
      "assets_defined_contribution": "",
      "assets_defined_contribution_native": "",
      "created_at": "2022-10-14T08:46:43.216Z",
      "updated_at": ""
    }
  ],
  "total_items": 10
}

Error Response

message
TYPEstring
A short, human-readable summary of the problem type.
status
TYPEinteger
The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurance of the problem.
Example response
{
  "errors": [
      {
          "query_parameter": "sort_field",
          "message": "Value not in available options."
      }
  ],
  "status": 400
}

Retrieve one managed AUM record

Retrieve one managed AUM with links to associated resources.

Get/aum-managed/:_id

Path Parameters

_id
REQUIRED
TYPEstring
Get information about a specific managed aum period.
Get Managed AUM info
curl -v -X GET https://api.swfi.com/v1/aum-managed/:_id \ 
-H "Accept: application/json" \ 
-H "Authorization: $API_KEY"

Success Response

HTTP Status 200
data._id
TYPEstring
Unique identifier for the managed aum period.
data.entity_id
TYPEstring
Unique identifier for the entity in which the managed AUM period relates.
data.currency
TYPEstring
The currency abbreviation for the assets_native field. See Currencies for a full list.
data.period
TYPEstring
The period in time in which the AUM values applies.
data.assets
TYPEnumber
The USD asset amount for the entity in the given period. Field can be an empty string.
data.assets_native
TYPEnumber
The net asset amount based on the native currency for the entity in the given period. Field can be an empty string.
data.assets_defined_contribution
TYPEnumber
The USD defined contribution asset amount for the entity in the given period. Field can be an empty string.
data.assets_defined_contribution_native
TYPEnumber
The defined contribution asset amount based on the native currency for the entity in the given period. Field can be an empty string.
data.created_at
TYPEstring
The UTC time the managed AUM was created.
data.updated_at
TYPEstring
The UTC time the managed AUM was updated.
Example response
{
  "data": {
    "_id": "6349221bdc82486491e2dcaf",
    "entity_id": "598cdaa50124e9fd2d05aa5d",
    "currency": "USD",
    "period": "2021-09-01T00:00:00.000Z",
    "assets": 9463662000000,
    "assets_native": 9463662000000,
    "assets_defined_contribution": "",
    "assets_defined_contribution_native": "",
    "created_at": "2022-10-14T08:47:23.057Z",
    "updated_at": ""
  }
}

Error Response

message
TYPEstring
A short, human-readable summary of the problem type.
status
TYPEinteger
The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurance of the problem.
Example response
{
  "errors": [
      {
          "path": "/v1/aum/:_id",
          "message": "Not Found"
      }
  ],
  "status": 404
}
AUM
core collectionCompass
core collection
Documentation as of 10/19/2022