Skip to content

This is the staging environment's documentation. It is a draft and may change at any time.

List the transactions of an award of the grants kind

GET
/assistance/grants/{id}/transactions
curl --request GET \
--url 'https://api-staging.fedwright.com/v1/assistance/grants/example/transactions?limit=50' \
--header 'Authorization: Bearer <token>'

The award’s transactions, oldest first, as USAspending states them, with deleted ones included and marked. The signed obligation is each transaction’s own change; the award’s total is the source’s running figure, not their sum.

Data source: USAspending.

id
required
string
limit
integer
default: 50 >= 1 <= 200

Maximum number of items to return.

cursor
string
<= 2048 characters

Opaque cursor from a previous response’s nextCursor.

OK

Media typeapplication/json
object
nextCursor
required

Cursor for the next page, or null on the last page.

null | string
items
required
Array<object>

One transaction of a financial assistance award, as USAspending states it. The signed obligatedAmount is this transaction’s own change. The award’s totals are the source’s running figures, not the sum of its transactions, and a corrected or deleted transaction is still listed, marked.

object
actionDate

The date of the transaction.

string format: date-time
actionTypeCode

The action type code, as the source delivers it. Null when the source gives none.

null | string
agency
One of:
null
awardKey

The identifier of the award the transaction belongs to.

string
correctionIndicator

The source’s correction marker: C when the transaction replaces an earlier one, D when it deletes one, and L, which the source does not define, kept as delivered. Null for an ordinary transaction.

null | string
deletedAt

When a verified delete from the source marked the transaction as deleted. The transaction stays listed. Null otherwise.

null | string format: date-time
description

The transaction’s description. Null when the source gives none.

null | string
detail

The source-specific fields, with normalized types and the publisher’s names. Null when there are none.

null | object
expandedLinks

Every link of the record, with how each was matched and how confident the match is. Present only when the request sets expand=links.

Array<object>

A full graph edge returned with expand=links.

object
confidence
required

How sure the match is, from 0 to 1. A link on identical keys scores 1.

number | string
/^-?(?:0|[1-9]\d*)(?:\.\d+)?(?:[eE][+-]?\d+)?$/
dataset
required

The related record’s dataset, as the API names it.

string
id
required

The related record’s identifier.

string
method
required

How the records were matched: exact-key for identical keys, normalized-key for keys that match once case, spacing, and punctuation are ignored, or fuzzy for keys one character apart.

string
relation
required

How the records relate, such as award-of-opportunity.

string
faceValueOfLoan
One of:
null
fieldSources

For a record merged from several publishers, the source each merged top-level field was taken from. Null for a record from one publisher.

null | object
firstSeenAt

When Fedwright first saw the record.

string format: date-time
id

The record’s identifier, its normalized natural key where the source has one.

string
lastSeenAt

When Fedwright last saw the record in a source.

string format: date-time
links

The record’s links to other records, in this dataset or another.

Array<object>

A related record in another dataset, or the same one, and how it relates.

object
dataset
required

The related record’s dataset, as the API names it.

string
id
required

The related record’s identifier.

string
relation
required

How the records relate, such as award-of-opportunity.

string
loanSubsidyCost
One of:
null
modNumber

The modification number as the source delivers it, or 0 when it is empty.

string
nonFederalFundingAmount
One of:
null
obligatedAmount
One of:
null
schemaVersion

The version of the record’s shape.

integer | string
/^-?(?:0|[1-9]\d*)$/
source

The publisher of the transaction, usaspending.

string
sources

One entry for each upstream record that contributed to the record.

Array<object>

An upstream record that contributed to a record.

object
firstSeenAt
required

When this publisher first delivered the record.

string format: date-time
formatVersionId
required

The version of the publisher’s format Fedwright read the record with.

null | string
lastSeenAt
required

When this publisher last delivered the record.

string format: date-time
retrievalType
required

A source identifier, such as grantsgov.extract, for the kind of data the record came from.

string
source
required

The publisher, such as grantsgov; derived for a record Fedwright derived.

string
upstreamId
required

The publisher’s own identifier for the record, verbatim.

string
upstreamUrl
required

A link to the record at the publisher, or null when there is none.

null | string format: uri
updatedAt

When the record last changed.

string format: date-time
upstreamModifiedAt

When the source last modified the transaction. Null when the source gives none.

null | string format: date-time

Examples

Exampledefault

A page of assistance transactions

{
"items": [
{
"actionDate": "2026-01-15T00:00:00Z",
"actionTypeCode": "04",
"agency": {
"agencyCode": "7529",
"agencyName": "Administration for Children and Families",
"agencyNodeId": "HHS.ACF",
"departmentCode": "75",
"departmentName": "Department of Health and Human Services",
"officeCode": "75ACF1",
"officeName": "Office of Grants Management"
},
"awardKey": "ASST_NON_75ACF124G000123_7529",
"correctionIndicator": null,
"deletedAt": null,
"description": "Continuation funding for the budget period.",
"detail": null,
"faceValueOfLoan": {
"amount": "250000.00",
"currency": "USD"
},
"fieldSources": null,
"firstSeenAt": "2026-03-02T04:00:12Z",
"id": "ASST_NON_75ACF124G000123_7529:1",
"lastSeenAt": "2026-03-09T04:00:31Z",
"links": [],
"loanSubsidyCost": {
"amount": "12500.00",
"currency": "USD"
},
"modNumber": "0",
"nonFederalFundingAmount": {
"amount": "0.00",
"currency": "USD"
},
"obligatedAmount": {
"amount": "125000.00",
"currency": "USD"
},
"schemaVersion": 1,
"source": "usaspending",
"sources": [
{
"firstSeenAt": "2026-03-02T04:00:12Z",
"formatVersionId": "v1",
"lastSeenAt": "2026-03-09T04:00:31Z",
"retrievalType": "usaspending.assistance",
"source": "usaspending",
"upstreamId": "ASST_NON_75ACF124G000123_7529",
"upstreamUrl": "https://www.usaspending.gov/award/ASST_NON_75ACF124G000123_7529"
}
],
"updatedAt": "2026-03-09T04:00:31Z",
"upstreamModifiedAt": "2026-01-15T12:00:00Z"
}
],
"nextCursor": null
}

The request is malformed, or its schema refuses it: an unknown property, a value of the wrong type or outside its bounds, a limit above 200, or a sort outside the operation’s allow-list (Problem type bad-request). errors names each field by its path, such as nested.note, or $ for the body itself. The request is refused before anything is read or written. A cursor that was altered, has expired, or was issued for other filters, another sort, organization, or user returns Problem type invalid-cursor.

Media typeapplication/problem+json

RFC 9457 Problem Details.

object
detail

An explanation specific to this occurrence of the problem. It is absent for server errors.

string
errors

Validation errors, by field path.

object
key
additional properties
Array<string>
instance

A URI reference that identifies this occurrence of the problem, when the API provides one.

string
limit

On rate-limited, the quota that is used up, such as org-day. On premium-quota-exceeded, org-premium-day. A 429 with an empty body does not name it.

string
resetsAt

On rate-limited from the API and on premium-quota-exceeded, when that quota starts again.

string format: date-time
status
required

The HTTP status code of the response, from 400 to 599.

integer
>= 400 <= 599
title
required

A short, human-readable summary of the problem. Use type to identify the kind of problem, not this text.

string
traceId
required

W3C trace ID of the failed request.

string
type
required

https://fedwright.com/problems/{code}, the same in every environment.

string format: uri

Example generated

{
"detail": "example",
"errors": {
"additionalProperty": [
"example"
]
},
"instance": "example",
"limit": "example",
"resetsAt": "2026-04-15T12:00:00Z",
"status": 1,
"title": "example",
"traceId": "example",
"type": "https://example.com"
}

The access token is missing, expired, or invalid.

Media typeapplication/problem+json

RFC 9457 Problem Details.

object
detail

An explanation specific to this occurrence of the problem. It is absent for server errors.

string
errors

Validation errors, by field path.

object
key
additional properties
Array<string>
instance

A URI reference that identifies this occurrence of the problem, when the API provides one.

string
limit

On rate-limited, the quota that is used up, such as org-day. On premium-quota-exceeded, org-premium-day. A 429 with an empty body does not name it.

string
resetsAt

On rate-limited from the API and on premium-quota-exceeded, when that quota starts again.

string format: date-time
status
required

The HTTP status code of the response, from 400 to 599.

integer
>= 400 <= 599
title
required

A short, human-readable summary of the problem. Use type to identify the kind of problem, not this text.

string
traceId
required

W3C trace ID of the failed request.

string
type
required

https://fedwright.com/problems/{code}, the same in every environment.

string format: uri

Example generated

{
"detail": "example",
"errors": {
"additionalProperty": [
"example"
]
},
"instance": "example",
"limit": "example",
"resetsAt": "2026-04-15T12:00:00Z",
"status": 1,
"title": "example",
"traceId": "example",
"type": "https://example.com"
}

The Problem type says which check refused the caller, when that is about the caller’s own token, client, or role: insufficient-scope when the token’s scopes (or an MCP grant’s) lack the operation’s scope, with WWW-Authenticate: Bearer error="insufficient_scope", scope="..." (RFC 6750) naming the missing scopes; client-not-allowed when the operation doesn’t admit the caller’s kind of client, such as a machine client calling a user-only operation; and insufficient-role when a confirmed member’s roles don’t allow the action. Any other refusal is the generic forbidden, which says nothing more. Another organization’s resource is 404 (not-found) instead, so no reason confirms that it exists. An owner or administrator who sent no proof of a second factor gets mfa-required. An operation that needs an active subscription, when the organization has none, returns subscription-inactive, or organization-suspended when Fedwright suspended the organization. A suspended organization also refuses invitations, new joins through an invitation, and role changes with organization-suspended. Creating or joining an organization without a verified email returns email-unverified, and accepting an invitation sent to another address returns invitation-email-mismatch. A request from Fedwright’s web or mobile app whose session acts for no organization yet returns organization-required, except on getMe, createOrganization, and acceptInvitation. Shared data needs the acting organization’s own subscription; another organization’s doesn’t count.

Media typeapplication/problem+json

RFC 9457 Problem Details.

object
detail

An explanation specific to this occurrence of the problem. It is absent for server errors.

string
errors

Validation errors, by field path.

object
key
additional properties
Array<string>
instance

A URI reference that identifies this occurrence of the problem, when the API provides one.

string
limit

On rate-limited, the quota that is used up, such as org-day. On premium-quota-exceeded, org-premium-day. A 429 with an empty body does not name it.

string
resetsAt

On rate-limited from the API and on premium-quota-exceeded, when that quota starts again.

string format: date-time
status
required

The HTTP status code of the response, from 400 to 599.

integer
>= 400 <= 599
title
required

A short, human-readable summary of the problem. Use type to identify the kind of problem, not this text.

string
traceId
required

W3C trace ID of the failed request.

string
type
required

https://fedwright.com/problems/{code}, the same in every environment.

string format: uri

Example generated

{
"detail": "example",
"errors": {
"additionalProperty": [
"example"
]
},
"instance": "example",
"limit": "example",
"resetsAt": "2026-04-15T12:00:00Z",
"status": 1,
"title": "example",
"traceId": "example",
"type": "https://example.com"
}

The resource does not exist, or belongs to another organization.

Media typeapplication/problem+json

RFC 9457 Problem Details.

object
detail

An explanation specific to this occurrence of the problem. It is absent for server errors.

string
errors

Validation errors, by field path.

object
key
additional properties
Array<string>
instance

A URI reference that identifies this occurrence of the problem, when the API provides one.

string
limit

On rate-limited, the quota that is used up, such as org-day. On premium-quota-exceeded, org-premium-day. A 429 with an empty body does not name it.

string
resetsAt

On rate-limited from the API and on premium-quota-exceeded, when that quota starts again.

string format: date-time
status
required

The HTTP status code of the response, from 400 to 599.

integer
>= 400 <= 599
title
required

A short, human-readable summary of the problem. Use type to identify the kind of problem, not this text.

string
traceId
required

W3C trace ID of the failed request.

string
type
required

https://fedwright.com/problems/{code}, the same in every environment.

string format: uri

Example generated

{
"detail": "example",
"errors": {
"additionalProperty": [
"example"
]
},
"instance": "example",
"limit": "example",
"resetsAt": "2026-04-15T12:00:00Z",
"status": 1,
"title": "example",
"traceId": "example",
"type": "https://example.com"
}

A rate limit is used up. Direct API access counts against the organization’s burst, daily, and monthly quotas, which all its machine clients share; there is no client quota. A 429 comes in two shapes with two header families, so read the response by what it carries.

A machine client’s calls can get a 429 with an empty body. It has three headers: X-RateLimit-Limit, the exhausted rule’s limit and window, such as 3000, 3000;w=2592000; X-RateLimit-Remaining, what is left in that window (0 on a 429); and X-RateLimit-Reset, the seconds until that window resets. It has no Retry-After, no RateLimit headers, no Problem, and does not name the quota. Read the quota from the window w:

w (seconds) Quota
60 Burst.
86400 Daily.
2592000 Monthly (the calendar month is reported as 30 days; X-RateLimit-Reset is exact).

Wait X-RateLimit-Reset seconds before you retry. Refused requests still count: a client that keeps calling after a 429 keeps adding to the counter, so it does not regain budget inside the window. A tier change takes effect within 10 minutes (checkout, the billing portal, and grants alike), once the client gets a new access token.

Every other 429 has a Problem and Retry-After. The Problem type is rate-limited for a used-up quota, or, for an ask, ai-budget-exceeded or premium-quota-exceeded (below). On rate-limited, Retry-After is the seconds until the used-up limit’s window resets, the latest if several are. The Problem also carries limit, the quota that is used up (the one that resets last, if several are), resetsAt, when it starts again, and traceId. RateLimit-Policy and RateLimit describe only the caller’s own limits, here and on every other response a limit applies to. A request refused with rate-limited uses no quota. One refused after that check, for its scope, role, subscription, or kind of client, still counts, so once a quota is used up such a request gets 429 instead of its 403. A request that fails authentication is not counted. An ask that the organization’s AI spending budget can’t cover returns ai-budget-exceeded instead, with Retry-After at the end of the budget’s window: that budget counts what asks cost, not how many there are. An ask that the organization’s premium units for the day can’t cover returns premium-quota-exceeded, with limit (org-premium-day), resetsAt (the next midnight UTC), and Retry-After. That is the plan’s allowance: a plan with no premium units never covers an ask, and a higher plan may. A refused ask uses no units.

Media typeapplication/problem+json

RFC 9457 Problem Details.

object
detail

An explanation specific to this occurrence of the problem. It is absent for server errors.

string
errors

Validation errors, by field path.

object
key
additional properties
Array<string>
instance

A URI reference that identifies this occurrence of the problem, when the API provides one.

string
limit

On rate-limited, the quota that is used up, such as org-day. On premium-quota-exceeded, org-premium-day. A 429 with an empty body does not name it.

string
resetsAt

On rate-limited from the API and on premium-quota-exceeded, when that quota starts again.

string format: date-time
status
required

The HTTP status code of the response, from 400 to 599.

integer
>= 400 <= 599
title
required

A short, human-readable summary of the problem. Use type to identify the kind of problem, not this text.

string
traceId
required

W3C trace ID of the failed request.

string
type
required

https://fedwright.com/problems/{code}, the same in every environment.

string format: uri

Examples

An ask the premium units can't cover

{
"limit": "org-premium-day",
"resetsAt": "2026-11-08T00:00:00Z",
"status": 429,
"title": "Too Many Requests",
"traceId": "4bf92f3577b34da6a3ce929d0e0e4736",
"type": "https://fedwright.com/problems/premium-quota-exceeded"
}
RateLimit
string

For each limit in RateLimit-Policy, the requests r its window still allows and the seconds t until the window resets, such as "org-burst";r=7;t=40, "org-day";r=62;t=41000.

RateLimit-Policy
string

The caller’s rate limits, in the IETF HTTPAPI RateLimit header fields: each limit’s name, its quota q, and its window w in seconds, such as "org-burst";q=20;w=60, "org-day";q=100;w=86400.

Retry-After
integer

Seconds to wait before retrying.

X-RateLimit-Limit
string

On a 429 with an empty body (and on the successful responses that carry these headers), the exhausted rule’s limit and window w in seconds, such as 3000, 3000;w=2592000. The window names the quota: 60 is burst, 86400 is daily, and 2592000 is monthly.

X-RateLimit-Remaining
integer

What is left in that rule’s window (0 on a 429).

X-RateLimit-Reset
integer

Seconds until that rule’s window resets.

Any other error. A request body over 64 KiB returns 413 (payload-too-large), and a request that takes longer than 10 seconds (90 for askOpportunities) returns 503 (request-timeout). An invitation when the API can’t send mail returns 503 (mail-unavailable), and creates nothing. An unexpected failure returns 500 (internal-error) with only type, title, status, and traceId.

Media typeapplication/problem+json

RFC 9457 Problem Details.

object
detail

An explanation specific to this occurrence of the problem. It is absent for server errors.

string
errors

Validation errors, by field path.

object
key
additional properties
Array<string>
instance

A URI reference that identifies this occurrence of the problem, when the API provides one.

string
limit

On rate-limited, the quota that is used up, such as org-day. On premium-quota-exceeded, org-premium-day. A 429 with an empty body does not name it.

string
resetsAt

On rate-limited from the API and on premium-quota-exceeded, when that quota starts again.

string format: date-time
status
required

The HTTP status code of the response, from 400 to 599.

integer
>= 400 <= 599
title
required

A short, human-readable summary of the problem. Use type to identify the kind of problem, not this text.

string
traceId
required

W3C trace ID of the failed request.

string
type
required

https://fedwright.com/problems/{code}, the same in every environment.

string format: uri

Example generated

{
"detail": "example",
"errors": {
"additionalProperty": [
"example"
]
},
"instance": "example",
"limit": "example",
"resetsAt": "2026-04-15T12:00:00Z",
"status": 1,
"title": "example",
"traceId": "example",
"type": "https://example.com"
}