Interface BlogPostsParams

interface BlogPostsParams {
    id?: string;
    limit?: number;
    notes_info?: boolean;
    npf?: boolean;
    offset?: number;
    reblog_info?: boolean;
    tag?: string | string[];
    type?: PostType;
}

Properties

id? limit? notes_info? npf? offset? reblog_info? tag? type?

Properties

Optionalid

id?: string

A specific post ID. Returns the single post specified or (if not found) a 404 error.

Optionallimit

limit?: number

The number of posts to return: 1–20, inclusive.

Optionalnotes_info

notes_info?: boolean

Indicates whether to return notes information (specify true or false). Returns note count and note metadata.

Optionalnpf

npf?: boolean

Returns posts' content in NPF format instead of the legacy format.

See

NPF documentation.

Optionaloffset

offset?: number

Offset post number (0 to start from first post).

Optionalreblog_info

reblog_info?: boolean

Indicates whether to return reblog information (specify true or false). Returns the various reblogged_ fields.

Optionaltag

tag?: string | string[]

Limits the response to posts with the specified tags

When multiple tags are provided, posts will be returned that have all of the provided tags. A maximum of four tags can be provided.

Optionaltype

type?: PostType

The type of post to return.

Settings

Member Visibility

On This Page

Properties